> This is part 1 of 9 of the full documentation (pages 1–100 of 293).
> The content is paginated: fetch every part to see all of it.
> Next part: https://docs.fulfillmenttools.com/documentation/llms-full.txt/1
> Page index: https://docs.fulfillmenttools.com/documentation/llms.txt

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.fulfillmenttools.com/documentation/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

---

# fulfillmenttools documentation

Welcome to the fulfillmenttools knowledge base. No matter where you are in your fulfillmenttools journey, you can find answers to all your questions about our product and how we can help you.

Looking to find out more about the fulfillmenttools and how we can help your business succeed? Click the button below.

<a href="https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/fulfillmenttools-and-its-surrounding-system" class="button primary">Find out more</a>

## Documentation by phase

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4>Free trial support</h4></td><td>Need help while using our free trial? We'll guide you through some interactive tutorials.</td><td data-object-fit="contain"><a href="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F8z3HRkuMWVtl9UamsxGN%2FFree%20trial%20icon.png?alt=media&amp;token=73b40935-319b-4598-a80f-af2f91a22e92">Free trial icon.png</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information">Free trial information</a></td></tr><tr><td><h4>Customer and partner support</h4></td><td>Implementation support for existing customers and partners.</td><td data-object-fit="contain"><a href="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F4Bohi6WLEDfESTBhFmya%2FCustomer%20and%20partner%20support%20icon.png?alt=media&amp;token=a866f971-ab1f-4186-a6b2-95f1e23e3adc">Customer and partner support icon.png</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/getting-started/general-concepts">General concepts</a></td></tr></tbody></table>

## Documentation by tooling

<table data-column-title-hidden data-view="cards" data-full-width="false"><thead><tr><th align="center"></th><th align="center"></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>APIs</strong></td><td align="center">Technical details and guidelines for developers and integration partners.</td><td data-object-fit="contain"><a href="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FpAbDdvjWJH4FlPcu39Cj%2FAPIs%20icon%20.png?alt=media&amp;token=70562910-e449-4395-81e7-0c16b084c094">APIs icon .png</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/apis/api-reference">API reference</a></td></tr><tr><td align="center"><strong>Backoffice</strong></td><td align="center">Tutorials and instructions for using the fulfillmenttools Backoffice.</td><td data-object-fit="contain"><a href="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FG29Mx1dtjdOdiaefL15j%2FBackoffice%20icon.png?alt=media&amp;token=d2428418-8ad6-4032-90b7-141fe16b625e">Backoffice icon.png</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/backoffice/accessing-backoffice">Backoffice</a></td></tr><tr><td align="center"><strong>Apps</strong></td><td align="center">Tutorials and instructions for using the fulfillmenttools apps.</td><td data-object-fit="contain"><a href="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FOBGf54kQyQpd0t3Qn9jO%2FApps%20tooling%20icon%20.png?alt=media&amp;token=01923577-6c38-48f1-b95e-92e5d11341a4">Apps tooling icon .png</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/apps/connect-apps">Apps</a></td></tr></tbody></table>

## Most popular articles

{% columns %}
{% column %}
{% content-ref url="/pages/5ba9e3aa88c93512b26569c9864ef12cb5ff8f4e" %}
[Order Management](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management)
{% endcontent-ref %}
{% endcolumn %}

{% column %}
{% content-ref url="/pages/d59c9572791dd8efa705681fda95e12653b10042" %}
[Available events](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events)
{% endcontent-ref %}
{% endcolumn %}

{% column %}
{% content-ref url="/pages/jRdRGacD9JybYs3s9J8h" %}
[onX MCP Server](https://docs.fulfillmenttools.com/documentation/integrations/mcp-servers/mcp-server-onx)
{% endcontent-ref %}
{% endcolumn %}
{% endcolumns %}

{% columns %}
{% column %}
{% content-ref url="/pages/c10811bc87591ba54e3d5d460d46235ad4f76efa" %}
[API versioning and lifecycle](https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle)
{% endcontent-ref %}
{% endcolumn %}

{% column %}
{% content-ref url="/pages/ba8dd2e1c772481f11e841e181e6b6adbbe9bf51" %}
[Custom attributes](https://docs.fulfillmenttools.com/documentation/getting-started/custom-attributes)
{% endcontent-ref %}
{% endcolumn %}

{% column %}
{% content-ref url="/pages/207df781f0064747a443f13a67bd197726a85737" %}
[General concepts](https://docs.fulfillmenttools.com/documentation/getting-started/general-concepts)
{% endcontent-ref %}
{% endcolumn %}
{% endcolumns %}

## Helpful information

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4>System status</h4></td><td>Overview of the status of our services.</td><td data-object-fit="contain"><a href="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FS0g5ajtH5UE0QHh3uDLu%2FSystem_Status_Icon.png?alt=media&amp;token=08b1e34e-f837-4ece-9154-2c8e055d18cf">System_Status_Icon.png</a></td><td><a href="https://status.fulfillmenttools.com/">https://status.fulfillmenttools.com/</a></td></tr><tr><td><h4>Incidents and bugs</h4></td><td>How to contact our support team.</td><td data-object-fit="contain"><a href="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FiPLVcBgEwk9Sl5jZPLHV%2FIncident%20and%20bugs%20icon.png?alt=media&amp;token=6f029fe7-9fb0-497c-9b9a-b2fcec221dea">Incident and bugs icon.png</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/incident-management">Incident management</a></td></tr><tr><td><h4>Changelog</h4></td><td>Find out about our latest updates and releases.</td><td data-object-fit="contain"><a href="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fu1b3ufdQN2Aw1ymSvc5C%2FChangelog_Icon.png?alt=media&amp;token=02462ea7-e07b-4bff-9bb0-29e1c4bc2fb1">Changelog_Icon.png</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/release-notes">Release notes</a></td></tr></tbody></table>

## Documentation by pillar

<table data-view="cards"><thead><tr><th></th><th data-type="content-ref"></th><th data-type="content-ref"></th><th data-type="content-ref"></th><th data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub">Global Inventory Hub</a></h4></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock">Stock</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles">Articles</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing">Listing</a></td><td></td></tr><tr><td><h4><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing">Advanced Order Routing</a></h4></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/fences">Fences</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/ratings">Ratings</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/routing-strategy">Routing strategy</a></td><td></td></tr><tr><td><h4><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/order-management">Order Management</a></h4></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/orders">Orders</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-modification">Order modification</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-event-history">Order event history log</a></td><td></td></tr><tr><td><h4><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising">Availability and Promising</a></h4></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising/delivery-promise">Delivery promise</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising/checkout-options">Checkout options (deprecated)</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising/earliest-possible-delivery-date">Earliest possible delivery date</a></td><td></td></tr><tr><td><h4><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations">Store Operations</a></h4></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking">Picking</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/packing">Packing</a></td><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/returns">Returns</a></td><td></td></tr></tbody></table>


# fulfillmenttools and surrounding systems

Fulfillment is the overall process of fulfilling a consumer's request for goods or services. It starts by providing availability and delivery options during the shopping process, then identifies the best facility for fulfillment. The picking and packing process then takes place at the facility itself. It ends with the consumer being supplied via a suitable delivery service or the goods being handed over on site. Additionally, fulfillment includes the returns process if the customer returns the ordered goods.

fulfillmenttools supports the whole fulfillment process as it's an Agentic Order Management System (OMS).

An Agentic OMS is an Order Management System designed from the ground up to support autonomous, goal-driven decision-making across the fulfillment lifecycle. It connects inventory, orders, and fulfillment operations across your entire network, continuously improving decision-making.

​Instead of relying on static rules, it uses real-time data and adaptive logic to automatically optimize routing, availability, and order execution in line with defined business objectives.

​It monitors and adapts continuously, not once per order. Traditional systems make a single routing decision when the order enters the system and then move on. An Agentic OMS evaluates conditions continuously. If something changes in the network (a warehouse becomes unavailable, carrier performance degrades, inventory shifts, and so on), fulfillmenttools reassesses and adjusts, even for orders already in process.

​When we say fulfillmenttools is an Agentic OMS, we mean:

* We build AI-driven products, like Advanced Order Routing, that use intelligent algorithms to optimize fulfillment decisions.
* We integrate AI-enabled capabilities, from demand forecasting to anomaly detection.
* We provide autonomous agents that monitor, analyze, reassess, and optimize — not just individual products, but the entire system as a network.

Agentic serves as the orchestrating layer above AI-driven and AI-enabled capabilities, continuously refining how they work together.

​Our Agentic OMS is divided into five pillars:

* [**Global Inventory Hub**](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub)**:** High-performance inventory data provision that ensures real-time transparency across the entire network (including inter-facility transfers).
* [**Order Management**](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management)**:** End-to-end management of the order lifecycle.
* [**Advanced Order Routing**](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing)**:** Intelligent pack-first order routing that identifies the most efficient fulfillment path within the network.
* [**Availability and Promising**](https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising)**:** Allow shop and commerce systems to show consumers accurate availability, delivery, and pickup options based on real-time sourcing to build consumer trust.
* [**Store Operations**](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations)**:** Streamline operational steps in the facility to optimize fulfillment in an omni-channel environment, enabling efficient picking, packing, dispatching, and returns.

​On top of our five pillars, you can connect your fulfillment operations with AI-driven decision-making, giving internal agents the intelligence to act and external agents the operational foundation they need, using the [fulfillmenttools MCP Server](https://docs.fulfillmenttools.com/documentation/integrations/mcp-servers/mcp-server-onx).

fulfillmenttools​ is a best-of-breed solution focused on delivering optimal order fulfillment. We're a founding member of the Commerce Operations Foundation, which created the Order Network eXchange (onX) Protocol. We're also GDPR-compliant and ISO-certified. See [Certification and compliance](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/helpful-information#certification-and-compliance) for more information.

Our customers integrate our Agentic Order Management System with other systems. Our API-first approach ensures seamless, rapid integration, enabling fulfillmenttools to exchange and manage all essential information with these interconnected systems.

**Systems that fulfillmenttools connects to:**

**Webshops** and **Point-Of-Sales** systems (POS) take the consumers' orders, which are then passed on to fulfillmenttools. fulfillmenttools supplies these systems with checkout information, such as fulfillment options or stock information.

A **Customer Relationship Management** (CRM) system manages and enhances customer interactions across all touchpoints. It's often used to add important customer information that might influence order fulfillment or to handle the "last mile" of communication to the consumer.

A **Payment Service Provider** (PSP) enables our customers to accept and handle payments. fulfillmenttools integrates closely with these systems to incorporate the payment process into the fulfillment process and trigger refunds and necessary adjustments.

A **Transportation Management System** (TMS) can be connected to our software to request shipping labels and/or exchange important shipping information, which can be handled in our OMS. All relevant data is collected during the shopping and fulfillment process.

A **Third-Party Logistics** (3PL) provider provides outsourced logistics services. Those providers are often part of larger fulfillment networks orchestrated by fulfillmenttools. The information exchanged between the systems primarily consists of order data and its current fulfillment status within the facility.

A **Warehouse Management System** (WMS) is optimized for handling warehouse operations. Warehouses are central facilities in fulfillment networks and often process large volumes of orders. Again, the information on the order and its fulfillment progress in the warehouse is typical data exchanged between the systems.

An **Enterprise Resource Planning** (ERP) system is usually a central component of our customers' software architecture. Depending on its usage, it can serve as a crucial source of information for inventory, customer data, or finances.

A **Product Information Management** (PIM) acts as a centralized hub for all product-related information, which often supplies fulfillmenttools with relevant data like product descriptions or images.

The fulfillmenttools MCP Server provides a standardized interface for interacting with fulfillmenttools. Built on the [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) and implementing the Order Network eXchange (onX) Protocol, it enables system-to-system communication, allowing AI Agents, orchestration layers, and external platforms to manage orders in natural language without relying on proprietary APIs. For more information, see our [MCP Server article](https://docs.fulfillmenttools.com/documentation/integrations/mcp-servers/mcp-server-onx).

<br>


# Helpful information

## API versioning

The fulfillmenttools API is considered versionless. That means our API evolves in a backward-compatible way. The following changes are considered backward-compatible:

* Adding new API resources.
* Adding new optional request parameters to existing API methods.
* Adding new properties to existing API responses.
* Changing the order of properties in existing API responses.
* Adding values to enums (see [enum handling](https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#enum-handling)).

All endpoints, fields, and types in our APIs have a lifecycle ranging from Alpha to Beta to General Availability (GA). Additionally, we may deprecate certain functionality in our API.

For more detailed information, see the [API versioning and lifecycle](https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle) article.

## Hosting

Our service is hosted on the Google Cloud Platform (GCP). We leverage products from different geographical regions. You can choose from a deployment in one of the following regions.

### Available regions

{% hint style="info" %}
If your region isn't currently available, contact us using [our contact form](https://fulfillmenttools.com/en/contact-us/).
{% endhint %}

<table><thead><tr><th width="260.32421875">Region code</th><th>Location</th></tr></thead><tbody><tr><td>europe-west1</td><td>St. Ghislain, Belgium (default, if no region is preferred)</td></tr><tr><td>europe-west3</td><td>Frankfurt, Germany</td></tr><tr><td>europe-west4</td><td>Netherlands</td></tr><tr><td>europe-north1</td><td>Finland</td></tr><tr><td>us-east1</td><td>South Carolina, United States</td></tr><tr><td>us-east4</td><td>North Virginia, United States</td></tr><tr><td>us-central1</td><td>Iowa, United States</td></tr><tr><td>us-west1</td><td>Oregon, United States</td></tr><tr><td>asia-east1</td><td>Taiwan</td></tr><tr><td>asia-northeast1</td><td>Tokyo, Japan</td></tr><tr><td>asia-southeast1</td><td>Singapore</td></tr></tbody></table>

## Backup policies

As a Software-as-a-Service (SaaS), fulfillmenttools takes care of backups of your data automatically, you don't need to do anything. The following information should give you a first idea of how backups are being taken.

### Regular backups

We impose a policy that takes backups:

* Hourly (every hour of a day, 24/7)
* Daily
* Weekly
* Monthly

By default, all of the above backup cycles are in place. The retention times (how long backups are stored and how long they remain restorable) vary. The backups are saved by default to the GCP zone europe-west1 with the option to duplicate them in another zone if desired.

Downloading the database or any other backups managed by fulfillmenttools isn't currently supported.

### Point-in-time recovery (PITR)

We also provide a point-in-time recovery mechanism that lets you "go back in time" and is even more flexible for restoring backup data to a specific date in the past.

## Certification and compliance

fulfillmenttools is GDPR-compliant and ISO-certified.

### GDPR

fulfillmenttools is General Data Protection Regulation ([GDPR](https://gdpr-info.eu/))-compliant.

All customer-related data needed for the fulfillment process (such as names, addresses, and contact details) is anonymized once all evolved entities are in a final operational state. The exact date for anonymization is configurable via API. The field `retentionTime` defines how many days after creation, operationally finished processes are anonymized. The default value is 30 days after the process is operationally finished.

{% hint style="info" %}
The GDPR retention time affects all parts of the operational process, including returns.
{% endhint %}

Furthermore, anonymized entities are deleted after a configured period (default `deletionTimeAfterRetention` 180 days).

This deletion functionality only deletes operational data. The anonymized data is still stored for analytics.

Auditing is in place to track changes to entities (for example, pick job, order, and so on). The audit entries contain the date, the affected entity, the operation (for example, canceling an order, closing a pick job), and the username and the user ID of the user who performed the operation. GDPR configuration contains the attribute `actorAnonymization`. If it is missing or set to `true`, the username and user ID are stored in the audit entry in an anonymized form. If set to `false`, the data is written without being anonymized. The default value is `true`.

See the [GDPR configuration article](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/gdpr-configuration) for more information.

### ISO

fulfillmenttools is [ISO 27001-certified](https://cdn.prod.website-files.com/69c5031adc2ca601a5d3d104/6a856f9561da1204531bcb13_Certificate%20DE016794_OC%20fullfillment%20GmbH_2026_EN.pdf), independently audited by Bureau Veritas.

## Service Level Agreements (SLAs)

fulfillmenttools commits to a minimum availability of the service of 99.9%.

The service will be considered available to the extent that a customer is able to use the service through the API and access the application data at the service transfer point of the API (at the exit of the respective data center) ("availability").

Availability (VUp) is measured over the entire operating period (24/7) and shall be calculated on the calculation below:

$$
VUp = (TMonth - TDown) / TMonth
$$

Where TMonth is the total number of minutes in a contractual month and TDown is the total\
downtime (the times the SaaS Services are unavailable, excluding authorized\
downtimes) in minutes in the same contractual month.

Authorized downtimes are planned maintenance work which has been announced in advance.


# Limits and scaling

## Responsible API use

To ensure reliable service, integrity, and fair access for all users, fulfillmenttools expects all API consumers to follow a set of basic usage principles. While many of these should be self-evident to experienced developers, we state them explicitly to establish a shared understanding:

* **Use the API responsibly:** Avoid excessive or abusive request patterns, including unnecessary retries, polling loops, or scripted load tests against production endpoints.
* **Store only relevant data:** Only data that's necessary and appropriate within the context of the Order Management System (OMS) may be stored. Storing unrelated or excessive data isn't permitted.
* **Respect rate limits:** Don't attempt to bypass or manipulate rate limits. These limits are in place to protect stability and ensure equitable access.
* **Avoid misuse of credentials:** API keys and tokens must be kept secure and used only by authorized systems. Sharing credentials across unrelated systems or teams is prohibited.
* **Don't scrape or replicate data:** The API is designed for transactional and operational use. Bulk extraction or replication of data for purposes outside the intended scope isn't permitted.
* **Follow retry guidelines:** Implement exponential backoff and respect `Retry-After` headers when handling transient errors such as `429: Too many requests` or `408: Request timeout`. See [Retry policies](#retry-policies) for more information.
* **Report issues responsibly:** If you encounter unexpected behavior, performance degradation, or suspect a bug, [contact fulfillmenttools support](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/4) rather than attempting workarounds that could impact integrity.
* **It's strictly forbidden to attempt to crash or destabilize fulfillmenttools:** Any such behavior will result in immediate suspension and may lead to permanent revocation of access.
* **Load testing must be controlled:** Simulations should reflect realistic daily traffic and expected peak loads. Sudden request spikes are prohibited. A controlled ramp-up phase is essential. See the [Load testing](https://docs.fulfillmenttools.com/documentation/getting-started/preparation-for-go-live/load-testing) article for more information.

By integrating with our API, you agree to adhere to these principles. Violations may result in throttling, temporary suspension, or revocation of access.

## Retry policies

In the event of an HTTP request failure, clients may implement a retry mechanism. fulfillmenttools recommends using an [exponential backoff strategy](https://en.wikipedia.org/wiki/Exponential_backoff) to avoid overwhelming the system and increase the likelihood of a successful retry.

Implementing this type of retry mechanism adds substantial resilience to an integration. It ensures the client application can cope with brief periods of service unavailability, which can occur in any distributed system.

### General guidance

Retries should be avoided for most client-side errors (HTTP 4xx), as these typically indicate issues that won't resolve without changes to the request. Retrying with identical parameters can result in unnecessary traffic and degraded performance.

However, there are some notable exceptions where retries might be appropriate:

* `404: Not found`\
  This status might indicate that the requested resource doesn't exist yet. If the resource is expected to be created shortly (for example, due to asynchronous processing), a retry after a delay might be reasonable. Otherwise, repeated retries will get the same result.
* `408: Request timeout`\
  The server timed out waiting for the request. A retry might be feasible, especially if the client is confident the request was valid and the timeout was due to transient network issues.
* `409: Conflict`\
  The request couldn't be completed due to a conflict with the resource's current state. A retry might be feasible, but only after resolving the conflict (see the [Optimistic-Locking section](https://docs.fulfillmenttools.com/documentation/getting-started/general-concepts#optimistic-concurrency-control-optimistic-locking) for more information)
* `429: Too many requests`\
  This status indicates that the client has exceeded the allowed request rate, either per endpoint or across the API. This can occur during scale-up phases or due to rate limits designed to protect system stability. Clients should respect the `Retry-After` header (if provided) and delay subsequent requests accordingly. If this error occurs frequently, [contact fulfillmenttools support](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/4) to discuss potential adjustments to your rate limits.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FLpP9Hwso1ZCaTHIyGnth%2FA%20flowchart%20illustrating%20the%20exponential%20backoff%20process.png?alt=media&amp;token=8d09e15e-24c9-4c93-a582-24926c98ba01" alt=""><figcaption><p>A flowchart illustrating the exponential backoff process. It shows an initial request, a failure response, a short wait, a retry, another failure, a longer wait, and a final successful retry.</p></figcaption></figure>

The following libraries provide pre-built implementations of the exponential backoff algorithm:

| Library             | Language | URL                                                 |
| ------------------- | -------: | --------------------------------------------------- |
| Resilience4J        |     Java | <https://github.com/resilience4j/resilience4j>      |
| exponential-backoff |     Node | <https://www.npmjs.com/package/exponential-backoff> |

### Retries for other HTTP status codes <a href="#retries-for-other-http-status-codes" id="retries-for-other-http-status-codes"></a>

This retry mechanism can also be leveraged for other transient server-side errors. It's beneficial to apply the same logic for the following HTTP status codes:

* `500 Internal Server Error`
* `502 Bad Gateway`
* `503 Service Unavailable`
* `504 Gateway Timeout`

## Rate limits and quotas

### Global API rate limits and quotas

To ensure stability and fair usage across clients, fulfillmenttools enforces a default rate limit of 1000 requests per second (RPS) across all API endpoints. This global limit applies cumulatively to all requests made by a client, regardless of the specific endpoint.

If your integration requires higher throughput, for example, during peak operational periods or batch processing, rate limits can be adjusted upon request. [Contact fulfillmenttools support](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/4) to discuss your requirements and initiate a quota increase.

Clients exceeding the allowed rate might receive a `429: Too many requests` response. In such cases, it's recommended to implement exponential backoff and respect the `Retry-After` header if present.

### Endpoint-specific rate limits (planned)

In addition to the global rate limit of 1000 requests per second, fulfillmenttools will introduce endpoint-specific rate limits to reflect better the operational characteristics and business relevance of individual API resources.

These limits will be defined based on the assumed usage patterns per business functionality. For example, endpoints supporting high-volume read operations, such as `/api/promises/checkoutoptions/*` , may allow higher throughput. Endpoints involved in transactional or write-heavy operations, such as `/api/facilities/{facilityId}/listings` or `/api/users`, might have stricter limits to ensure consistency and system stability.

Rate limit information will be communicated through standard HTTP headers in each response:

```
X-RateLimit-Limit: [max requests]
X-RateLimit-Remaining: [remaining requests]
X-RateLimit-Reset: [timestamp]
```

Clients are encouraged to monitor these headers and implement adaptive throttling strategies. If your application requires higher limits for specific endpoints, [contact fulfillmenttools support](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/4) to request a tailored quota.

Further details, including endpoint-specific thresholds and usage tiers, will be published in upcoming releases of the API documentation.

## API limits

### Rate limits

fulfillmenttools APIs enforce a rate limit of approximately 1000 requests per second.

* This limit applies across the entire API.
* The limit can be increased on demand.
* A lower limit may be imposed in the future.

fulfillmenttools uses APIs as the primary interaction method. Clients issue API calls to create, update, or read data. When request volume increases, infrastructure must either block calls or scale with the load. fulfillmenttools applies the latter approach: it scales horizontally by creating additional containers to handle requests.

If fulfillmenttools can't scale quickly enough, the API responds with **HTTP 429: Too Many Requests**. This response may occur before reaching 1000 requests per second, depending on infrastructure load.

### List size limits

* REST read and write operations support a maximum of 500 items per call.
* GraphQL queries, subscriptions, and mutations support a maximum of 100 items per call.
* Requests exceeding these limits return an error.

Multiple calls and the paging function of the APIs can be used to handle larger datasets.

### Private Service Connect (optional)

Private Service Connect (PSC) is a Google Cloud networking capability that enables consumers to access managed services privately from within their own Virtual Private Cloud (VPC) network, without exposing traffic to the public internet.

{% hint style="info" %}
fulfillmenttools offers PSC as an optional add‑on. PSC must be explicitly booked and is a paid optional service. Use our [contact form](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11/create/39) to request this add-on.
{% endhint %}

#### Limits when using Private Service Connect

The following technical limits apply to PSC‑based connections:

* Maximum request rate: 5000 requests per second (req/s)
* Maximum new connection rate: 500 new connections per second

These limits apply to all traffic routed through the PSC endpoint.

## Scaling

API calls must be issued from the client side to create/update or read data at/from fulfillmenttools. When the number of requests rises during usage, a given infrastructure either needs to block calls (for example, by imposing rate limits that limit the resource to only one instance) or scale with the load. fulfillmenttools decided on the latter: It scales with the load imposed by the clients using the API.

That means API usage can scale with our customers' businesses. To provide the necessary service level, however, fulfillmenttools transparently scales the needed services horizontally (new containers that can answer requests need to be created). In that case, the HTTP Code `429: Too many requests` comes into play — potentially way earlier than 1000 requests a second.

### Scaling behavior under load

The below diagram shows the different phases.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FB0VeVhzrv8gUC1dhu2PK%2FScaling%20diagram.png?alt=media&amp;token=5a15ae89-0f6e-4946-a577-30a91cd39075" alt=""><figcaption></figcaption></figure>

#### Scaling up phase

When there is a low load, the provided resources are minimal. In the example above, one instance is enough to handle all the calls in the depicted "low load phase."

At the beginning of a "high load phase," we also enter the "scale up phase". On the server side, one or more instances are started to provide the needed resources to handle the current and anticipated load shortly. This happens fully automated.

These new instances begin processing requests as soon as they are available, distributing the load across the newly available resources.

During a scale-up phase, the API might respond with `429: Too many requests`. This doesn't necessarily indicate that a rate limit has been reached. Instead, the request couldn't be processed due to insufficient resources.

When this response occurs, a new instance is already starting. The request must be reissued to be processed successfully.

#### High load phase

During periods of high traffic, the available resources handle incoming requests. If the load continues to rise, additional instances are started. The behavior is similar to the initial scale-up phase. As the number of operational instances increases, the percentage of affected calls decreases as the ratio of operationally available instances rises over time.

#### Scaling down

When API usage decreases, unneeded instances are shut down to conserve resources. This process is fully transparent to clients. After the load subsides, a single instance may again be sufficient to handle requests.

### When does the system scale?

There's no definitive answer to this question. It depends on multiple parameters, such as the complexity of the call, the required CPU or memory, the number and type of parallel calls to be processed, and the number of available instances.

At low load, minimal resources are provided. In the example above, a single instance can handle all requests during a low-load phase.

At the beginning of a high-load phase, the system automatically starts one or more additional instances to provide the required resources. Once scaling is complete, the new instances handle incoming requests. For example, two instances may now process calls instead of one.

### Scaling parameters

The exact point at which the system scales depends on several factors:

* Complexity of the call
* Required CPU or memory
* Number and type of parallel calls
* Currently available number of instances


# Incident management

{% embed url="<https://status.fulfillmenttools.com/>" %}

Follow the steps below to request support from the fulfillmenttools team:

{% stepper %}
{% step %}
**Visit our** [**support portal**](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/4/create/12)

{% hint style="info" %}
You'll need to be a customer to access this portal. If you're using our free trial and need support, reply to the email you received from our team.
{% endhint %}
{% endstep %}

{% step %}
**Summarize the problem**
{% endstep %}

{% step %}
**Describe the problem in detail**

Describe the issue in as much detail as possible, including steps to reproduce if relevant.
{% endstep %}

{% step %}
**Select a priority**

| Incident priority | Description                                                                                                                                                    |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Priority 1        | You can't use our SaaS services, or essential applications aren't executable or create data loss or corruption. This results in a complete loss of production. |
| Priority 2        | You can use our SaaS services, but not all functions are available. This results in a significant reduction in production.                                     |
| Priority 3        | Most SaaS services' functions are functional, with only slight limitations.                                                                                    |
| {% endstep %}     |                                                                                                                                                                |

{% step %}
**Add attachments**

Attach any relevant screenshots or files.
{% endstep %}

{% step %}
**Submit the ticket**

We'll reply to you as soon as possible.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
If the support portal is unavailable, or you haven't had any response from our team and it's a P1, you can call us on our emergency hotline: **+49 221 956 732 10.**
{% endhint %}

You can also use [our feedback form](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/13/create/47) for feature requests or any feedback in general, or [our service request form](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11) to be added to our support portal or other service requests.


# Release notes

This page highlights recent updates, new features, and product improvements delivered across our API and Apps.

{% hint style="info" %}
Subscribe to updates using the **RSS feed** button or sign up for our monthly newsletter using the [form on our website](https://fulfillmenttools.com/newsletter-abo-release-summary/).
{% endhint %}

The below release notes focus on the current calendar year (2026). For previous years, see the [2025](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/release-notes/release-notes-2025) or [2024](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/release-notes/release-notes-2024) release notes.

{% updates format="full" %}
{% update date="2026-11-04" tags="store-operations,apps" %}

## Store Operations app new versions released

We've released the latest versions of the Store Operations app for Android and iOS. In v40 (Android) and v17 (iOS), you'll find the changes below.

**New features:**

* Optimized loading performance of the orders overview, plus improved filter selection.
* Removed handovers from the open filter and from urgent alerts on the home page.
* Added guided input from recordable attribute values during picking.
* Improved the pack job takeover process for when packing is taken over by another team member (must be enabled via the [packing configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/packing#packing-configuration)).

**Bug fixes:**

* Picking no longer gets stuck on a loading screen when another user starts the same pick job at the same time.
* The order process details no longer show pick jobs which were rerouted to another facility.
* A handover is no longer rejected when only additional items are handed over.
* Optimized processing when finishing short picked pick jobs.
  {% endupdate %}

{% update date="2026-11-03" tags="global-inventory-hub,apis" %}

## Stock availability threshold configurations released to Beta

We've released our stock availability thresholds endpoints to Beta.

This lets you configure automated, reusable stock-level rules once and have them evaluated consistently across your targeted scope, instead of managing thresholds manually for each article or facility.

When configured, [Backoffice](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/notification-center) shows a notification as soon as a threshold is reached, so you're informed as stock levels drop without needing to actively monitor them.

See the [Stock availability article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability#stock-availability-thresholds) for more information.
{% endupdate %}

{% update date="2026-11-03" tags="backoffice" %}

## New UI for Analytics in Backoffice

We've updated the Analytics section UI in Backoffice.

This aligns the section layout with the rest of Backoffice, making it more intuitive, consistent, and easier to navigate.

All metrics, calculations, and data sources are unchanged, so your figures stay comparable with previous reports.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FhjhUzdQOXHJWFBtk77UH%2FNew%20analytics%20Dashboard.png?alt=media&amp;token=dd2df140-c439-4e3b-83c0-030778b2aea5" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2026-10-29" tags="store-operations,apps" %}

## Store Operations app new versions released

We've released the latest versions of the Store Operations app for Android and iOS. In v38 (Android) and v16 (iOS), you'll find the changes below.

**New features:**

* Enhanced push notification settings to be more individual and specific. See the [Notification section](https://docs.fulfillmenttools.com/documentation/apps/store-operations-app#notifications) for more information.
* Added the ability to connect managed devices to a tenant through your MDM solution's managed app configuration. See the [Connect apps article](https://docs.fulfillmenttools.com/documentation/apps/connect-apps#connect-android-devices-via-mdm) for more information.
* Improved the process for adding and removing items in click-and-collect handovers.
* Added the ability to transfer the final handover data to a point-of-sale (POS) system.

Some of these features must be activated via the remote configuration.

**UI changes:**

* New app icon.
* Adjusted the display of the price breakdown and payment information in the handover summary.
  {% endupdate %}

{% update date="2026-10-23" tags="backoffice,order-management" %}

## Bulk order cancellation in Backoffice

We've added a new bulk action to the Network order view in Backoffice.

You can now cancel multiple orders at once using multi-select. The initial release supports standard order cancellation.

The feature is enabled by default and can be deactivated in the [Remote configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/remote-configuration#backoffice).

See the [Order overview article](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders#operational-actions) for more information.

<div data-with-frame="true"><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FEOXFfhdCFiDwpSXsM3C8%2FBildschirmfoto%202026-10-23%20um%2009.09.37.png?alt=media&amp;token=7f4cb5ef-3297-4ab4-bafb-67ab08e5e6a5" alt="" width="375"><figcaption></figcaption></figure></div>
{% endupdate %}

{% update date="2026-10-20" tags="backoffice,order-management" %}

## Alert filter added to Backoffice

We've added a new filter to the Network order view in Backoffice.

Now you can filter orders by alerts using either the alert type or the affected area. Both active and inactive alerts are included, making it easier to analyze current issues as well as previously triggered alerts.

See the [Network order view article](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders) for more information.
{% endupdate %}

{% update date="2026-10-12" tags="apis,store-operations,apps" %}

## Configurable position of the ID check in handovers

In the latest release of the Store Operations app (v37 (Android) and v15 (iOS)), we've added the possibility to configure whether a customer ID check occurs at the beginning or end of the handover process.

This setting is defined in the remote configuration as either `BEFORE_REMARK` (ID check at the beginning of the handover) or `AFTER_SUMMARY` (ID check at the end).

See the [Remote configuration article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/remote-configuration) for more information.
{% endupdate %}

{% update date="2026-10-09" tags="apis,advanced-order-routing" %}

## Reroute limit reached event after maximum reroute attempts

We've added support for the `TIME_TRIGGERED_REROUTE_LIMIT_REACHED` event. The event is emitted once when a pick job reaches the configured `rerouteAttemptThreshold`, and no further time-triggered reroute will be executed. This lets external systems react operationally through the existing notification and webhook mechanisms.

For more information, see the [Reroute article](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/reroute).
{% endupdate %}

{% update date="2026-10-06" tags="mcp,apis,beta" %}

## AI Sidekick and MCP updates

We've released more functionality in our AI Sidekick and added a fulfillmenttools API MCP.

The AI Sidekick in Backoffice now has read access to your entire tenant so that you can ask any question about your fulfillment network. For example, how many open pick jobs there are, or how much stock is at a particular facility.

The fulfillmenttools MCP Server on `/fft` gives AI agents read access to the fulfillmenttools API. It runs alongside our [onX MCP Server](https://docs.fulfillmenttools.com/documentation/integrations/mcp-servers/mcp-server-onx). The onX Server offers a fixed set of tools defined by the onX protocol. The `/fft` server works with the fulfillmenttools data model itself: pick jobs, pack jobs, handover jobs, shipments, parcels, carriers, facilities, routing, stock, and about 70 resources in total.

For more information, see the [MCP Server (fulfillmenttools API) article](https://docs.fulfillmenttools.com/documentation/integrations/mcp-servers/mcp-server-fulfillmenttools-api) and the [AI Sidekick article](https://docs.fulfillmenttools.com/documentation/backoffice/ai-sidekick).
{% endupdate %}

{% update date="2026-09-29" tags="backoffice,advanced-order-routing" %}

## Updating routing node configuration in Backoffice

We've redesigned the screen for configuring nodes in the routing strategy in Backoffice.

The new view brings several improvements:

* **Easy-to-use UI**: Fences and ratings are now separated into different sections, with the active ones filtered by default.
* **Trade-off display for ratings**: See the relation between two ratings directly while you adjust them.
* **Inheritance transparency**: See at a glance which fences and ratings are inherited from a preceding node and which ones override an inherited value.
* **Search and filters**: Added to every rule list, with active rules shown by default.

The previous view remains the default and can be selected at any time using the **Switch to classic view** button in the banner. The new view will replace the previous one on 30 November 2026.

<div data-with-frame="true"><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F13akVBrmGbVR7MQMdrMN%2FReferences%20in%20weighted%20ratings.png?alt=media&amp;token=3f6e2db5-b297-45d8-a2f8-0c705b9d4808" alt=""><figcaption></figcaption></figure></div>

For more information, see the [Routing strategy article](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/routing).
{% endupdate %}

{% update date="2026-09-28" tags="apis,global-inventory-hub" %}

## Inventory events moved to GA

We've moved the listing events below to GA:

* `LISTINGS_CREATED`
* `LISTINGS_DELETED`
* `LISTINGS_INFORMATION_CHANGED`
* `LISTINGS_STATUS_CHANGED`
* `LISTINGS_STOCK_CONFIGURATIONS_CHANGED`
* `INVENTORY_STOCKS_CREATED`
* `INVENTORY_STOCKS_DELETED`
* `INVENTORY_STOCKS_LOCATION_CHANGED`
* `INVENTORY_STOCKS_VALUE_CHANGED`

For more information, see the [Available events article](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events).
{% endupdate %}

{% update date="2026-09-23" tags="store-operations,apps" %}

## Extended handover process in the Store Operations app

We've released the latest versions of the Store Operations app for Android and iOS. In v36 (Android) and v14 (iOS), you'll find the changes below.

**New features:**

* Extended click-and-collect handover functionality
  * Container scan validation during handover preview
  * Item selection, remarks, and an editable summary with pricing
  * Pickup services:
    * Customer ID check
    * Customer details capture (address, salutation) with review before completing
    * Digital signature
  * Handover summary screen refined with clearer pricing display and a back button
* Support for substitutes set up on listing and order level
* Search orders directly from the home screen (including scanning)
* "Customer did not show" option directly in the order overview
* Single documents selected for printing will keep the filename given by the API

{% hint style="info" %}
Some of these features must be enabled via the [remote configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/remote-configuration).
{% endhint %}

**Bug fixes:**

* Fixed missing container information in item overlays
* Fixed custom item attributes propagation
* We now respect the local timezone when entering shipping information like pickup time
  {% endupdate %}

{% update date="2026-09-17" tags="order-management,backoffice" %}

## Order view improvements for transparency and operational control

We've introduced several operational improvements across order management, fulfillment processing, and their visibility to provide greater transparency and control throughout the order lifecycle.

The latest enhancements include:

* Address changes in Backoffice now require a change reason, and all changes are tracked in the [Order event history](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view#event-history).
* Picking tasks can now be canceled directly from the [Order overview](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders) and the [Order details view](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view). Note that it doesn't cancel the order.
* Creation date column added to [Order overview](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders) table, with filtering and sorting capabilities.
* Recorded attributes captured during fulfillment operations are now displayed in the [Fulfillment status quick view](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders#fulfillment-status-quick-view).
* Consumer ID added to the **Addresses** section in the [Order details view](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view#consumer), which has also been renamed to **Consumer**.
  {% endupdate %}

{% update date="2026-09-17" tags="backoffice,apis,beta,order-management" %}

## Order records released to Beta

We've released order records to Beta. Order records represent the finalized state of an order that has already been completed. Unlike an order, an order record doesn't express customer intent that needs to be fulfilled. It captures what happened.

Order records give you the ability to add and view orders that come from offline or historical data to have a record of previous orders.

For more information, see the [Order records](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-records) and [Order records in Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-records) articles.
{% endupdate %}

{% update date="2026-09-15" tags="order-management,backoffice,apis,beta" %}

## Pricing enhancements and order totals in Beta

We've introduced a new pricing model that allows fulfillmenttools to store and process pricing information throughout the entire order lifecycle while maintaining full transparency and traceability.

The new pricing capabilities support:

* **Line item pricing**, including base prices, discounts, taxes, and surcharges
* **Order-level pricing**, including discounts, fees, and tax summaries
* **Deterministic calculation of derived pricing values and order totals**
* **Complete price reconstruction** based solely on pricing data stored with the order

With this release, fulfillmenttools acts as a transparent pricing data container and calculator, storing all pricing inputs as provided and deriving operational totals through deterministic arithmetic calculations. fulfillmenttools doesn't apply pricing, tax, or business logic and isn't intended to serve as a financial or invoicing system of record.

#### Order total in order details

As part of this enhancement, the order total now appears directly in the order details view in Backoffice. This gives you immediate visibility into the overall order value without needing access to external systems.

<div data-with-frame="true"><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FBdcI1swYbc3nhTJdz6ky%2FOrder%20total%20view%20in%20Backoffice.png?alt=media&amp;token=e4867df6-4c28-4e23-8519-58ae0f2421f4" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="info" %}
The pricing values and derived totals calculated by fulfillmenttools are intended solely for operational and fulfillment purposes. Customers remain responsible for maintaining authoritative pricing, invoicing, accounting, tax, and financial reporting processes in their own systems.
{% endhint %}

For more information, please refer to the [Pricing data model article](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/pricing-data-model).
{% endupdate %}

{% update date="2026-09-10" tags="apis,store-operations" %}

## Additional handover job line items

We've added the ability to add and remove additional line items at handover.

With the `additionalHandoverJobLineItems` array, you can now add line items to the handover job in case the consumer wants to add extra items when they pick up their order.

See the [Handover article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/handover) for more information.
{% endupdate %}

{% update date="2026-08-18" tags="apps,store-operations" %}

## Returns integrated into the Store Operations app

We've integrated returns processing into the latest version of the Store Operations app (v34 for Android and v12 for iOS).

This means you can now process the full returns flow directly in the app, without switching to the standalone app.

This has also allowed us to improve the returns flow, making it easier to use with better messaging and error handling.

We've also added new [remote configurations](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/remote-configuration) so you can tailor the returns experience to your team's workflows.

See the [Returns article](https://docs.fulfillmenttools.com/documentation/apps/store-operations-app/returns-beta) for more information.

As part of this release, we've also simplified the snackbar behavior so that a new snackbar dismisses the current one instead of queuing.
{% endupdate %}

{% update date="2026-08-11" tags="apps,store-operations" %}

## Store Operations app new versions released

We've released the latest versions of the Store Operations app for Android and iOS. In v30 (Android) and v10 (iOS), you'll find the changes below.

**New features:**

* Added three new [remote configurations](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/remote-configuration#store-operations-app), all deactivated by default:
  * Assign location in packing.
  * Deactivate scanning in picking and packing.
  * Auto-select system default printer.
* Released multi-document printing for iOS devices.
* Added support for laser scanning in the packing packages overview.

**UI changes:**

* Enhanced the scanning experience for connecting the mobile app to Backoffice.
* Updated the picking status icons in the order overview screen to clearly illustrate the differences between the statuses.
* Adjusted wording and translations for clarity.

**Quality of life:**

* Added a loading spinner before showing the start packing button in the picking summary screen.
* Added the ability to see the container sequence numbers in packing.
* Improved the packing experience for when only one target container is configured by automatically selecting it.
* Added the ability to see load unit IDs in the pack job preparation screen.
* Changed the order of the filter chips in the order overview to show job entities (pick, service, pack, and so on) as the first filters by default. You can configure this via the remote config.
* Enhanced the printing experience so that selected documents are automatically deselected after a successful print.

**Bugfixes:**

* Stopped blocking users with multiple assigned roles from using the app. Note that the app still only uses and supports the first assigned role of a user.
* Released various other small technical bug fixes.
  {% endupdate %}

{% update date="2026-08-04" tags="backoffice,apis,order-management" %}

## **New alerts for fulfillment risks and exceptions**

We've introduced new operational alerts as a new column in the order overview in Backoffice.

Alerts provide additional visibility into fulfillment conditions that may require attention, helping you to identify discrepancies and potential delays during order execution.

The initial release includes alerts for stuck, mismatch, and delayed conditions. These indicators are also available through the process API as status and substatuses.

{% hint style="info" %}
Newly introduced columns are added to the end of the table by default. If alerts are relevant to your workflow, you can reposition the column within the table according to your preferences.
{% endhint %}

For more information, see the [Order overview article](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders#order-table-field-definitions).

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FwKjtXW5JV0kQsziusOi7%2FOrder%20overview%20page.png?alt=media&amp;token=23fa77a1-d26d-4c99-86b7-e7f38a14f24c" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fa46daEWmS0eRh02JYFWu%2FRelease_Note_Alerts_detail%20(1).png?alt=media&amp;token=80cd073f-02e7-4568-9986-5ecb54ebac34" alt=""><figcaption></figcaption></figure></div>
{% endupdate %}

{% update date="2026-08-03" tags="apis" %}

## OpenID Connect identity-only role management

We've added a new OIDC provider configuration mode: `IDP_IDENTITY_ONLY`.

When enabled, the Identity Provider (for example, Microsoft Entra ID or Keycloak) is used only for authentication and user identity management. Roles and facility assignments are managed directly in fulfillmenttools and are no longer overwritten during login.

This is useful for organizations that manage authorization and facility assignments outside of their Identity Provider.

For more information, see the [OIDC role management modes article](https://docs.fulfillmenttools.com/documentation/integrations/openid-connect/openid-connect-role-management-modes).
{% endupdate %}

{% update date="2026-07-28" tags="apis,global-inventory-hub,beta" %}

## Event scopes in Beta

We've introduced event scopes to public Beta.

You can now create a scope key that includes facilities or facility groups that will aggregate an event. For now, this is only for the `INVENTORY_ARTICLE_AVAILABILITY_CHANGED` event type.

This is so you get aggregated information within the event, to make it easier for tracking.

For more information, see the [Eventing article](https://docs.fulfillmenttools.com/documentation/getting-started/eventing#event-scopes).
{% endupdate %}

{% update date="2026-07-21" tags="store-operations,apis" %}

## New pick job actions added

We've added three new pick job actions to support the headless picking process.

See the [pick job actions endpoint](https://docs.fulfillmenttools.com/documentation/apis/api-reference/picking#post-api-pickjobs-pickjobid-actions) and the [headless picking article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking/headless-picking) for more information.
{% endupdate %}

{% update date="2026-07-22" tags="store-operations,apps" %}

## Store Operations app now available on iOS

The Store Operations app is now available in the Apple App Store.

The iOS version offers the same functionality as the Android version. So now, stores can choose their devices freely and use iOS and Android devices side by side without any difference in functionality.

No separate setup is required. The app is configured the same way, and the existing documentation applies to iOS as well.\
​\
For more information, see the [Store Operations App article](https://docs.fulfillmenttools.com/documentation/apps/store-operations-app).
{% endupdate %}

{% update date="2026-07-20" tags="backoffice" %}

## Improved navigation and spotlights in Backoffice

We've introduced several improvements to the Backoffice navigation. These include an updated design and structure, personalized navigation preferences, and improved usability across different screen sizes. We've also streamlined and refreshed parts of our icon set to ensure a more consistent visual language.\
​\
These enhancements help you work more efficiently, reduce navigation effort, and deliver a cleaner, more consistent experience throughout Backoffice.\
​\
We're also introducing spotlights to highlight important updates and new features directly within Backoffice. Spotlights help you to quickly discover and understand relevant changes after a release, making new functionality easier to find and use.

For more information on the new navigation structure, see the [Network view article](https://docs.fulfillmenttools.com/documentation/backoffice/network-view).

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FBxX4unZgYYBQ2qf6XyGj%2FRelease_Note_Navi.png?alt=media&amp;token=e8b54920-3a0b-4d2c-88b5-80a1026f4725" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2026-07-08" tags="backoffice,order-management,apis" %}

## Locked order enhancements

We've introduced a new `LOCKED_ORDER_CREATED` event. The event is now also available in the notification center and can be used for subscriptions and automated monitoring.

We've also enhanced the order event history to include the reason why an order was locked. This information will be available for newly created events. It's also displayed in the order details view in Backoffice, providing users with more context when investigating locked orders.

For more information, see the [Notification center,](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/notification-center) [Order event history](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-event-history), and [order details view](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view#order-history) articles.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F0QcAfSaGijNKkSYNCJPI%2FEvent%20history%20A.png?alt=media&amp;token=ac75bf56-8246-42ef-9a42-f7c70810a425" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2026-07-03" tags="apis" %}

## Support for Bruno and Insomnia

In addition to Postman, we now also offer collections for the API client tools [Bruno](https://www.usebruno.com/) and [Insomnia](https://insomnia.rest/).

This gives you more flexibility to use different API client tools more easily.

Find the collections in [our public repository](https://github.com/fulfillmenttools/fulfillmenttools-api-reference) and see the [Access to fulfillmenttools APIs article](https://docs.fulfillmenttools.com/documentation/getting-started/access-to-fulfillmenttools-apis) for instructions on using them.
{% endupdate %}

{% update date="2026-06-26" tags="store-operations,apps" %}

## Store Operations app moved to GA

The Store Operations app has been released to General Availability (GA). It can be downloaded from the Google Play Store.

The app has been redesigned with a simplified navigation structure to make it easy to use. With a new home screen, and improved picking, packing, and handover processes, our new app ensure smooth operations.

For more information, see the [Store Operations app article](https://docs.fulfillmenttools.com/documentation/apps/store-operations-app).
{% endupdate %}

{% update date="2026-06-11" tags="backoffice,order-management" %}

## New returns module in Backoffice

We've introduced a new returns module in the order details view, providing a structured overview of all items returned in an order.

This enables users to quickly understand the current status of returned items, identify issues, and track the progress of return handling in detail directly from the order details view.

For more information, see the [Order details view article](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view#returns).

<div data-with-frame="true"><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FuxxGB1jNVgFL4KDUTGlO%2FReturns%20container_current.png?alt=media&amp;token=247a87e1-c653-4496-9fc8-349c201f4338" alt=""><figcaption></figcaption></figure></div>
{% endupdate %}

{% update date="2026-06-03" tags="order-management,apis" %}

## New order events

We've added two new events to improve transparency in order processing and exception handling:

* **Reroute failed:** Indicates that an attempted rerouting of the order was unsuccessful.
* **Picking paused:** Signals a temporary halt in the picking process.

For more information, see the [Order event history article](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-event-history).
{% endupdate %}

{% update date="2026-06-03" tags="order-management,backoffice" %}

## Backoffice order improvements

We’ve introduced several improvements to the order overview and order details view in Backoffice to streamline workflows and improve visibility.

* **New sorting options**: Facility, carrier, order type, and target country.
* **New column in overview**: Tracking link for direct access to shipment tracking.
* **Added title**: Professional title is now displayed in the order details.

Also, all relevant order actions are now available directly in the order overview via the more icon (three dots). This reduces the need to switch to the detail view and speeds up handling.
{% endupdate %}

{% update date="2026-05-26" tags="apis,store-operations" %}

## Moving handover job line items

We've released the ability to move handover job line items via API.

With this change, you're now able to update `expectedLineitems` to `lineItems` so that the status of a handover job can be updated.

For more information, see the [Handover article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/handover#moving-handover-job-line-items).
{% endupdate %}

{% update date="2026-05-20" tags="apis,store-operations,beta" %}

## Service containers for service jobs

We've released our service container endpoints to Beta.

Each service container holds a set of line items (articles with quantities) and is linked to a facility through its referenced service jobs.

With this endpoint, service containers are either created manually or automatically to link to a service job. This aligns behavior with packing, picking, and handover jobs, making it easier to manage service jobs.

For more information, see the [Service container article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/service-container).
{% endupdate %}

{% update date="2026-05-19" tags="apis,beta,mcp" %}

## fulfillmenttools MCP Server (onX)

The fulfillmenttools MCP Server (onX) is now available in public Beta. It's a new integration that enables standardized, AI-driven agentic access to fulfillment capabilities via the Model Context Protocol (MCP).

It allows you to seamlessly integrate with MCP-enabled clients (for example, Claude), and work with the AI agents either on user instruction or as part of automated workflows.

For now, fulfillmenttools MCP Server supports read-only capabilities, such as querying inventory, products, and variants. This is to deliver early value while ensuring data security. In the future, we'll expand capabilities, including order management operations.

For more information, see the [fulfillmenttools MCP Server article](https://docs.fulfillmenttools.com/documentation/integrations/mcp-servers/mcp-server-onx).
{% endupdate %}

{% update date="2026-05-19" tags="apis,advanced-order-routing,beta" %}

## Packaging units for shipping cost calculation

We've released our packaging units endpoints to Beta.

With this endpoint, you can provide configurations for different packaging unit types, including pricing. This allows you to calculate better transport costs for interfacility transfers and shipments to consumers.

We've also improved our algorithm to apply even smarter logic, making it more effective at bin packing.

For more information, see the [Transport cost calculation logic article](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/complex-routing-with-combinatorics/calculations-within-routing/transport-cost-calculation-logic).
{% endupdate %}

{% update date="2026-05-11" tags="backoffice,apis,apps" %}

## Upcoming changes to password policies

To further improve account security, we'll update the password policies for fulfillmenttools accounts.

The new policies will apply different password requirements depending on the user role. Accounts with elevated permissions will need stronger passwords and extra security checks against commonly known compromised passwords.

This change will only affect you when changing a password for non-SSO accounts.

The password policy settings remain configurable. If needed, you can make adjustments via [a service request](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11), including stricter or more lenient requirements. However, we strongly recommend keeping the default settings or increasing them only.

For more information, see the [User management article](https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management#user-creation).
{% endupdate %}

{% update date="2026-05-07" tags="backoffice,global-inventory-hub" %}

## Inventory update in Backoffice

The [Inventory detail view](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory/stock-detail-view) in Backoffice has been redesigned to improve usability and expand operational capabilities. Key changes include:

* **Customizable modules and tables:** rearrange and show/hide sections to fit your workflow
* **Advanced filtering and sorting options:** narrow down inventory data more precisely
* **Editing of safety stock values:** directly adjustable from the detail page
* **Over-reservation warnings:** visual alerts when reservations exceed facility capacity

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Flldn08UGm6pU781EH32N%2FstockDetailViewBanners.png?alt=media&amp;token=34a56393-3b39-4fe7-979b-1a201433204a" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2026-04-29" tags="backoffice,beta" %}

## AI Sidekick for Backoffice released in Beta

The fulfillmenttools AI Sidekick is now available in Backoffice in Beta.

Our AI Sidekick provides clear, contextual guidance about using fulfillmenttools, reducing the need to search through documentation or contact support. Questions are turned into immediate, actionable insights, which helps speed up onboarding, improve efficiency, and make everyday tasks easier to understand.

The feature is primarily designed for administrators and operations‑focused users, but can be used by anyone working in Backoffice.

Access to the AI Sidekick is controlled via the `AI_ASSISTANT_ACCESS` permission and is available by default for standard [SUPERVISOR and ADMINISTRATOR roles](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/users-roles-and-permissions).

{% hint style="info" %}
The AI Sidekick currently answers questions based on documented knowledge only and doesn't have access to live Backoffice data such as orders or consumer information.
{% endhint %}

For more information, see [the AI Sidekick article](https://docs.fulfillmenttools.com/documentation/backoffice/ai-sidekick).

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FRL26LluNW0xZRh7zkGCC%2FSidekick%20Routing%201.png?alt=media&amp;token=d5cf6d92-af9c-4a61-865e-cd7cc8351bf4" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2026-04-20" tags="backoffice,order-management" %}

## Preferred date editable via order edit

We've added the ability to add or edit the preferred date directly from the **Edit order** screen, accessible via the three‑dot menu on the [order details page](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view#order-modification-and-operational-actions).

This allows you to quickly adjust delivery or handover dates when plans change.

The feature is available when order modification is enabled and the required permissions are assigned.

For more information, see the [Order modification article](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-modification).

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FO5v9NjVUHOdyrAH52BT4%2FBildschirmfoto%202026-04-22%20um%2012.16.34.png?alt=media&amp;token=17880c52-20df-4804-883a-5513db9dfcb5" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2026-04-16" tags="backoffice,advanced-order-routing" %}

## Routing simulation in Backoffice

The routing simulation feature is now available. It enables the creation and evaluation of test orders directly in Backoffice.

Test orders are processed using the currently active routing strategy, and the resulting metrics provide insights into assignment quality, delivery performance, and cost implications. This allows administrators to validate routing behavior without affecting live operations.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FIV5XB1wjc0SjgaeeNPFu%2FScreenshot%202026-04-01%20at%2011.00.25%201%20(1).png?alt=media&amp;token=57d0dd70-71fb-45c6-8689-a1f4d6cd3eaa" alt=""><figcaption></figcaption></figure>

For more information, see the [Routing simulation article](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/routing/routing-simulation).
{% endupdate %}

{% update date="2026-04-14" tags="store-operations,apps,beta" %}

## Store Operations app released to Beta

The whole new Store Operations app is now available in public beta. For now, this is for Android devices only.

With a new home screen, and improved picking, packing, and handover processes, our new app ensure a smooth operation.

This version is currently available as a [Beta release](https://docs.fulfillmenttools.com/documentation/apps/mobile-app-availability) via the Google Play Store. To access it, you need to be enrolled in our beta program. If you'd like to participate, [contact us using our Support portal](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11/create/39) to request access.

For more information, see the [Store Operations app Beta articles](https://docs.fulfillmenttools.com/documentation/apps/store-operations-app).

The planned release date for General Availability is 9 June 2026.
{% endupdate %}

{% update date="2026-04-09" tags="backoffice,store-operations" %}

## Tags available in facility settings

We've added the option to assign pre‑defined tags to facilities directly in the facility settings. This allows teams to better categorize and organize facilities based on operational needs. Tagging supports faster filtering, improved navigation, and clearer segmentation across different facility groups.

The facility table now displays all assigned tags, and a new tag filter makes it easier to narrow facility lists by specific tags.

For more information, see the [Facility settings in Backoffice article](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/facilities#facility-data).
{% endupdate %}

{% update date="2026-04-09" tags="backoffice" %}

## New KPIs available in the Network view

We've introduced new KPIs on the Backoffice Network view homepage. This shows you key performance indicators, such as a list of high‑performing facilities or the distribution of entered short‑pick reasons. These KPIs provide a more timely and focused overview of recent activity.

The visibility of these KPIs depends on two factors:

* The **permissions** assigned to the user
* The **availability of relevant data** on the tenant

This ensures that every user sees only KPIs that are meaningful and relevant to their role and data context.

For more details, see the [Available KPIs in the Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/network-view#operation-overview) and [Permissions to view KPIs](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/users-roles-and-permissions/backoffice-permissions#view-kpis-on-network-view) articles.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FdUfkbdJqRJNC7sRChKSH%2FHome_KPIs.png?alt=media&amp;token=5eb33892-480c-45a5-a29b-174f196c714c" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2026-04-08" tags="order-management,backoffice" %}

## Free‑text search improved in the order view

We've changed the default settings in the Order view of Backoffice. Orders from the last 12 months are now shown.

We've also removed the automatic date filter when you use the search bar. This means that older orders are included right from the start.

We've changed the default sort order of the table so that older orders now appear first. To change the table to show the latest orders first, click the sorting arrow in the column header.

See the [Orders in Backoffice article](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders) for more information.
{% endupdate %}

{% update date="2026-03-27" tags="apis,global-inventory-hub" %}

## API lifecycle updates

We've updated the lifecycle status of several API endpoints as part of our continuous effort to increase stability and transparency.

The following endpoints have matured from Alpha to Beta and are now considered feature-complete with improved stability:

* `GET /api/externalstockchangereasons`
* `POST /api/externalstockchangereasons`
* `GET /api/externalstockchangereasons/{externalStockChangeReasonId}`
* `PUT /api/externalstockchangereasons/{externalStockChangeReasonId}`
* `GET /api/reservations`
* `GET /api/reservations/{reservationId}`
* `GET /api/stowjobs`
* `POST /api/stowjobs`
* `GET /api/stowjobs/{stowJobId}`
* `PATCH /api/stowjobs/{stowJobId}`
* `POST /api/stowjobs/{stowJobId}/actions`

The following endpoints have progressed from Beta to General Availability (GA). They're now fully supported for production use:

* `PUT /api/listings`
* `POST /api/inboundprocesses/{inboundProcessId}/receipts`
* `POST /api/inboundprocesses/search`
* `PUT /api/inboundprocesses/{inboundProcessId}/purchaseorder`
* `POST /api/listings/search`
* `POST /api/stocks/search`
* `POST /api/storagelocations/search`
* `POST /api/zones/search`

See the [API lifecycle article](https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle) or the [API reference section](https://docs.fulfillmenttools.com/documentation/apis/api-reference) for more information.
{% endupdate %}

{% update date="2026-03-26" tags="apis,order-management" %}

## API lifecycle updates

We've updated the lifecycle status of several API endpoints as part of our continuous effort to increase stability and transparency.

The following endpoints have matured from Alpha to Beta and are now considered feature-complete with improved stability:

* `POST /api/orders/search`
* `POST /api/processes/search`

The following endpoints have progressed from Beta to General Availability (GA). They're now fully supported for production use:

* `GET /api/configurations/ordercancelation`
* `GET /api/configurations/tags/order`
* `GET /api/process`
* `GET /api/processes/{processId}`
* `POST /api/processes/{processId}/documents`

See the [API lifecycle article](https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle) or the [API reference section](https://docs.fulfillmenttools.com/documentation/apis/api-reference) for more information.
{% endupdate %}

{% update date="2026-03-24" tags="store-operations,apps,beta" %}

## Picking released to Beta in the new Store Operations app

The new Store Operations app now includes a fully redesigned picking experience, available in public beta.

You're guided step-by-step through the picking process, no matter which method you use. This makes it easier to complete the picking process and ensures a smooth operation.

This version is currently available as a [Beta release](https://docs.fulfillmenttools.com/documentation/apps/mobile-app-availability) via the Google Play Store. To access it, you need to be enrolled in our beta program. If you'd like to participate, [contact us using our Support portal](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11/create/39) to request access.

For more information, see the [Beta picking article](https://docs.fulfillmenttools.com/documentation/apps/store-operations-app/picking).

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F3h4PLmuC4BoAhwB2JAmm%2Fpicking_01.png?alt=media&amp;token=9380c311-5331-49b6-8654-8c2241f4969e" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FdgIzQT5xoHMMCZpNohGY%2Fpicking02.png?alt=media&amp;token=4a09b7d6-59ab-4eab-9f57-b3714724515b" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F1D936RvocgPvBUW9zi12%2Fpicking_03.png?alt=media&amp;token=28afe3ab-f961-4312-892b-1763174d7acc" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FQqsJrueTunjH39FyId3X%2Fpicking_04.png?alt=media&amp;token=9977e55b-e692-45da-97ce-c2f30212674f" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fcwmmn4v1VvNrzy7oPsq6%2Fpicking_05.png?alt=media&amp;token=1d414075-7f6d-4eda-afe8-a0494a9a8649" alt=""><figcaption></figcaption></figure></div>
{% endupdate %}

{% update date="2026-03-24" tags="backoffice,store-operations" %}

## **Notification center introduced in Backoffice**​ <a href="#notification-center-introduced-in-the-backoffice" id="notification-center-introduced-in-the-backoffice"></a>

Backoffice now includes a [**Notification center** in the top bar](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/notification-center), giving operational teams immediate visibility into critical order-, reservation-, and process-related issues.

This ensures faster reaction times, more consistent exception handling across tenants and facilities, and improved operational reliability across the entire fulfillment network.

The feature centralizes alerts from multiple system processes, such as routing issues, new pick jobs, or upcoming reroutes, and provides a unified entry point for monitoring and assessing operational health.

More technical information about notifications can be found in the [Notification Center article](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/notification-center).
{% endupdate %}

{% update date="2026-03-02" %}

## Documentation navigation change

We updated the navigation in our documentation, so all articles are now in a single section.

This reduces duplicate articles, removes short or redundant articles, improves search results, and introduces a new homepage.

This change results in many changes to article URLs. Redirects will be in place where possible, but this could result in dead links. Ensure you've updated any bookmarks you have.
{% endupdate %}

{% update date="2026-02-25" tags="backoffice" %}

## Custom roles in Backoffice

We've introduced a new **Roles** page in Backoffice. It allows you to create your own custom roles, either by starting with a [role template](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/users-roles-and-permissions#create-a-role-with-role-templates) or by [building a role from scratch](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/users-roles-and-permissions#create-a-role-with-the-customizer).

This update gives more flexibility and control over permission management in Backoffice. It supports clearer access structures and helps ensure that users only receive the permissions they need.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F6YqNDnkVIS5hupMobU07%2FBackoffice%20access%20chips.png?alt=media&amp;token=4eddfaf5-bcd6-442c-8ab0-c3a9f7a48296" alt="The setup of customized roles"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FACkdAoqowcy66gmQQfwS%2FSelect%20a%20template%20for%20a%20role.png?alt=media&amp;token=24451413-3a98-470d-81e7-28b709d8644c" alt=""><figcaption></figcaption></figure></div>

See the [Backoffice permissions](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/users-roles-and-permissions/backoffice-permissions) and [users, roles, and permissions articles](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/users-roles-and-permissions) for more information.
{% endupdate %}

{% update date="2026-02-11" tags="backoffice,order-management" %}

## Edit orders

We've introduced the ability to modify an order directly from the three‑dot menu in the **Order items** module of Backoffice.

You can now adjust quantities, cancel items, or add new items as long as operational processing has not yet started.

This update gives you more flexibility while managing orders.

Order modification must be enabled via the API and can be further controlled through role‑based permissions. Any change to the order currently triggers a reroute.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FrnwOL9leP73QpiTvYYb6%2FModify%20order%202.png?alt=media&amp;token=49d18034-5895-4cf2-b06f-281fed49a61d" alt=""><figcaption></figcaption></figure>

For more information, see the [orders detail view section of the documentation.](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view)
{% endupdate %}

{% update date="2026-02-11" tags="backoffice" %}

## Event history

We've introduced a new module in the order details that provides a chronological timeline of all system events and operational actions throughout an order's lifecycle.

Each entry includes a timestamp, event type, and contextual details to help understand why the event occurred and how it impacted the order. This gives you more transparency in the order journey.

Where allowed by GDPR‑compliant actor anonymization, the triggering user is also shown. Access to this information depends on the role's assigned permissions. All event history data is also available via the [Process history log REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/processes/-processId-/historylogs) for integration into external systems or reporting workflows.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FrHOUupeX9VNxhtMDKQOY%2FEvent%20history.png?alt=media&amp;token=4ff26f49-c4de-4ab8-963c-7179ba2cb889" alt=""><figcaption></figcaption></figure>

For more information, see the [orders detail view section of the documentation](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/orders).
{% endupdate %}

{% update date="2026-02-05" tags="backoffice" %}

## Unified filter button for tables

We've changed the way filters are displayed across all tables in Backoffice.

Instead of showing all available filters side by side under the search bar, each table now provides a single **Filter** button. On click, a dropdown allows you to select which filters to apply. Once filters are active, the button displays the number of applied filters.

This update reduces visual noise and frees up valuable horizontal space, allowing more table content to be displayed without sacrificing functionality.​

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FgSHSYyIGDNEPj8Nqim1S%2FGeschlossen_Filter.png?alt=media&amp;token=91bec285-94d0-4e63-ac96-568acaa40b6e" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FY4d9pvGEgNtXtPitOlD2%2FOffen_Filter.png?alt=media&amp;token=cc46da1e-0bb5-42f4-a775-70e0afe420c0" alt=""><figcaption></figcaption></figure></div>
{% endupdate %}

{% update date="2026-02-04" tags="backoffice" %}

## New toast notification pattern

We've introduced a new toast-based notification pattern to replace the previous blocking notification style.

This update improves accessibility and ensures that essential UI elements remain usable while notifications are displayed.

Notifications now appear in the top‑right corner of the screen. Success and information notifications disappear automatically after 8 seconds, while warning and error notifications will remain visible until you manually close them.

For more information, see the [Backoffice section of the documentation](https://docs.fulfillmenttools.com/documentation/backoffice/accessing-backoffice).

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FAdfZF5lXHsEl3TwYXUOp%2FRelease_Notes_Notification_Pattern_s.png?alt=media&amp;token=6b050420-0ef3-4261-9317-c2d1ff94b4ee" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2026-02-04" tags="backoffice,advanced-order-routing" %}

## Routing details view

You can now access a dedicated routing details section in the order overview.

{% hint style="warning" %}
This view is only available when “complex routing with combinatorics” is enabled.

If you'd like to use these functionalities, [contact our Support team](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11/create/39) for more information and activation support.
{% endhint %}

This view shows the complete routing decision of an order, including facility assignments, transfers, carrier information, package calculations, timestamps, and the routing rules applied. It also displays the rating statistics used during the routing evaluation.

This gives you complete transparency into how the sourcing decision for an order was made. It also supports you in operational analysis and helps you troubleshoot problems more easily.

For more information, see the [orders detail view section of the documentation](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view).
{% endupdate %}

{% update date="2026-02-04" tags="apps,store-operations,beta" %}

## Guided packing and printing Beta release

The packing process in the Operations app has been redesigned as a guided flow for packing items into one or multiple parcels.

You're guided step-by-step from starting the packing process to completing all required parcels, instead of working with an open list. This makes it easier to complete the packing process and ensures a smooth operation.

This version is currently available as a [Beta release](https://docs.fulfillmenttools.com/documentation/apps/mobile-app-availability) via the Google Play Store. To access it, you need to be enrolled in our beta program. If you'd like to participate, [contact us using our Support portal](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11/create/39) to request access.

For more information, see the [Beta packing and printing article.](https://docs.fulfillmenttools.com/documentation/apps/store-operations-app/beta-packing-and-printing-android-app)

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FY6h2kBCazGOPZhfydkaW%2FRelease-Notes-Packing-January.png?alt=media&amp;token=9f901d87-0679-4765-9699-bab3287ba240" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2026-02-01" tags="backoffice,order-management" %}

## Orders view moved to GA

The Orders (Beta) Network view in Backoffice has been released to General Availability (GA). This means that the legacy Orders view has been removed from the navigation. You can still access it using the URL, but this will be turned off on 31 March 2026.

For more information, see the [Orders Backoffice documentation](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders).
{% endupdate %}

{% update date="2026-01-27" tags="apis,global-inventory-hub" %}

## Expected stock configuration

You can now automatically create expected stock during advanced order routing.

When activated, routing plans generate expected stock entries for incoming goods and reserve them immediately. As physical stock arrives, these reservations are transferred from expected to available stock.

This means incoming stock is made visible without using the inbound module.

The configuration is available at the network level through the [Stock Configuration REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/configurations/stock).
{% endupdate %}

{% update date="2026-01-20" tags="apis,global-inventory-hub" %}

## Reserved stock configuration added

You can now define which event triggers the removal of reservations and their stock.

This means you can align with your individual operational workflows instead of relying on the default `PICK_JOB_CLOSED` event.

{% hint style="warning" %}
This configuration should be set during initial setup to avoid inconsistent reservation states.
{% endhint %}

See the [reserved stock configuration section of the Configurations article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#reserved-stock-configuration) for more information.
{% endupdate %}

{% update date="2026-01-14" tags="apis,global-inventory-hub" %}

## Versionless stock updates

The `UPDATE_VERSIONLESS` action in the **stock actions** REST API enables versionless creation or update of stock quantities.

* Supports two operation types:
  * `CREATE` – Creates a new stock record for a specific `tenantArticleId` and `facilityRef`.
  * `UPDATE` – Updates an existing stock record identified by `id`.

{% hint style="info" %}
More information can be found under [REST API documentation - Stock Actions](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stocks/actions).
{% endhint %}
{% endupdate %}
{% endupdates %}


# Release notes 2025

This page highlights recent updates, new features, and product improvements delivered across our API and Apps.

{% hint style="info" %}
Subscribe to updates using the **RSS feed** button or sign up for our monthly newsletter using the [form on our website](https://fulfillmenttools.com/newsletter-abo-release-summary/).
{% endhint %}

The below release notes focus on the 2025. For other years, see the [2026](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/release-notes) or [2024](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/release-notes/release-notes-2024) release notes.

{% updates format="full" %}
{% update date="2025-12-18" tags="backoffice" %}

## Password self service

Backoffice now provides a password reset option at login.

Users can also change their own password directly in the user profile. Password resets are only available when an email address is configured.

{% hint style="info" %}
More information can be found under [Backoffice access and authentication](https://docs.fulfillmenttools.com/documentation/backoffice/accessing-backoffice).
{% endhint %}
{% endupdate %}

{% update date="2025-11-20" tags="apis,order-management" %}

## Order modification update

The order modification feature allows users to adjust original order details.

* Update order line items (cancel or adjust quantities).
* Update delivery or handover dates.

This feature is activated by default and can be deactivated via [REST API](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-modification). Every order update triggers a re‑route to ensure compliance with all routing rules.

{% hint style="info" %}
More information can be found under [Order modification](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-modification).
{% endhint %}
{% endupdate %}

{% update date="2025-11-13" tags="backoffice,order-management" %}

## Order (beta) fulfillment status pop-up

The new **Fulfillment statu**s pop‑up enables quick cross‑checks without leaving the overview and offers all standard functions, including column rearrangement, show/hide options, and actions such as reset or restart. The pop-up opens by clicking on the order ID in the overview.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FOWtCI45vACUJB2sCJD5m%2FBildschirmfoto%202025-12-17%20um%2012.59.51.png?alt=media&amp;token=5da00fa4-aa7d-40fc-9f50-71adc373e30e" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-11-11" tags="backoffice,apis" %}

## Facility discounts

Facility discounts determine the value by which the [sales price](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/prices#sales-price) of the facility's listings is reduced for a specific group. It is configured on the facility that supplies the listing to other facilities.

The facility discounts are displayed on the facility detail page in the Backoffice.

{% hint style="info" %}
More information can be found under [Facility discounts](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/prices).
{% endhint %}

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FsKDZSHSzAZ6GsyjJp8Rq%2FFacility%20Settings_Discounts%20(1).png?alt=media&amp;token=4e152d60-146c-4874-a631-fc05af9ae7db" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-11-07" tags="backoffice,global-inventory-hub" %}

## Inventory views enhancements

The below improvements are now available on the inventory views in Backoffice:

**Network**

* Search overview by article name and ID.
* Article filter (filter for multiple articles by their name or ID).
* Tooltip on headers and filters, offering explanations on the concepts.
* Default columns (only basic columns shown by default - additional columns can be activated via customization button).

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Ftdj9LalpatlwGetyqIaF%2FStock%20overview_0.png?alt=media&amp;token=747df087-1024-496e-a6c0-03bee71b2cd1" alt=""><figcaption><p>Stock overview in Backoffice with column customization</p></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FZp9PFxToJCvzvMqfLCAH%2FStock%20overview_00.png?alt=media&amp;token=005ac731-de7e-45a0-a120-334c4cc0a69c" alt=""><figcaption><p>Stock overview in Backoffice with article filter</p></figcaption></figure></div>

{% hint style="info" %}
More information can be found under [Stock Overview](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory).
{% endhint %}

**Facility**

* Customize which modules are displayed on the page.
* Customize columns in each table.
* Delete [sales prices](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/prices#sales-price) via the three-dot menu in the sales price table.
* New [purchase price](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/prices#purchase-price) module shown in purchasing facilities if there is a facility connection between the supplier and the purchaser.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FvQre7Lou9s27OTDFEKDx%2FListings%20detail%20page_0.png?alt=media&amp;token=2a46ae72-b1c0-4ba6-9e6a-f956b699f928" alt="" width="563"><figcaption><p>Listing detail view in Backoffice</p></figcaption></figure>

{% hint style="info" %}
More information can be found under [Facility view – Inventory](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory).
{% endhint %}
{% endupdate %}

{% update date="2025-11-04" tags="backoffice" %}

## New layout and KPI enhancements

Backoffice homepage is updated with small changes. The map and KPIs are now in movable, concealable modules.

Existing KPIs are clickable and link to the new order page including KPIs for open orders, unroutable orders, and error orders. Pick, pack, and handover tasks lists have been removed for now. The Facility View Home page remains unchanged.

This update also lays the foundation for additional KPIs currently in development.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FihDAB3wSMiFYHqrTv4bP%2F01_Home.png?alt=media&amp;token=54b82c6a-9e12-41f5-b18c-2dbe74e8c74c" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FtapC0sjFSFPpJpXgz3W0%2F02_Home.png?alt=media&amp;token=d731388b-2cd5-4c78-a957-2343b08080c3" alt=""><figcaption></figcaption></figure></div>
{% endupdate %}

{% update date="2025-09-18" tags="backoffice" %}

## Backoffice navigation update

The Backoffice navigation has been enhanced with several new functions. Menu sections can now be expanded or collapsed, and submenus provide direct access to additional options.

The navigation can be customized by rearranging or hiding items, with the option to reset the layout to its default state at any time. Account settings, preferences, and personal information are available in a centralized account area. Documentation is accessible directly from the interface.

The footer has been updated to include important links and information. In addition, profile settings are now grouped in a single location, and the interface language can be switched as required.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FFTAF8kSFVu6SLODhmH9p%2FNew%20navigation%20expanded_with%20as_shadow.png?alt=media&amp;token=252345dc-da5f-4656-a024-a2a64f1ba026" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F8GZMnPykEztko37rha2P%2FNavigation%20collapsed_shadow.png?alt=media&amp;token=e25b90e7-3c39-4984-a633-a7cba91528dc" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FlhgUDaQsxWBFoqDod84G%2FAccount%20settings%20max_shadow.png?alt=media&amp;token=f760d6be-e906-42d2-937b-83aa238b7b50" alt=""><figcaption></figcaption></figure></div>
{% endupdate %}

{% update date="2025-09-18" tags="backoffice,order-management" %}

## Enhanced order status insight

The updated order overview now includes a clickable order status. This feature opens a modal that delivers detailed visibility into the operational status of order fulfillment, answering queries like whether an order is being picked, packed, or if labels have been generated.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fro73CqUxBF59IAPEn9z8%2FBildschirmfoto%202025-09-17%20um%2013.00.42.png?alt=media&amp;token=5ab2b54d-55bf-42c9-a273-648fd2ee0d69" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
More information can be found under [Order status](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view).
{% endhint %}
{% endupdate %}

{% update date="2025-09-10" tags="backoffice,store-operations" %}

## Order documents access

The new module in the order details offers comprehensive access to all documents linked to an order. This includes shipping labels and external documents like invoices.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FzNaNPbbSKWSs18pu3HwJ%2FBildschirmfoto%202025-09-24%20um%2010.54.00.png?alt=media&amp;token=39343487-fd90-437d-942c-447ec90c06f3" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
More information can be found under [Documents](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view#documents).
{% endhint %}
{% endupdate %}

{% update date="2025-09-09" tags="backoffice,apis,global-inventory-hub" %}

## Sales and purchase price

The sales price of an article is now configurable via API and Backoffice. The sales price (and its respective purchase price) are displayed in the [Backoffice facility inventory detail view](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory).

The **sales price** is the amount at which articles are sold to other facilities in the network and is always stored by the facility selling the articles. It can be configured via [API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/facilities/-facilityId-/listings) on listing level in the listing [attributes](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes#sales-price-with-currency). The **purchase price** refers to the price at which articles are acquired from other facilities within the network. It is not specifically stored in the platform but is contingent upon the facility from which an article is sourced.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F7lZOWE3t7KUDj4d8MSVl%2FFrame%202409%20(1).png?alt=media&amp;token=042ab528-e24f-4560-a0b1-9d83a9936c00" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FJqOtD1APSWtXQLeld9yc%2FFrame%202409.png?alt=media&amp;token=119159c3-d261-4bd3-8db4-c6b2ac9b18f7" alt=""><figcaption></figcaption></figure></div>
{% endupdate %}

{% update date="2025-07-24" tags="apis,global-inventory-hub" %}

## Customer-defined IDs in requests

For some entities, it is possible to specify a user-defined ID. This field can be utilized for the purpose of transferring IDs from external systems to the fulfillmenttools platform. If this ID is unambiguous, it can be now used to read and write the entity in HTTP.

**At present, this functionality is exclusively available for stocks.**

{% hint style="info" %}
More information can be found under [Customer-defined IDs in requests](https://docs.fulfillmenttools.com/documentation/apis/customer-defined-ids-in-requests).
{% endhint %}
{% endupdate %}

{% update date="2025-07-22" tags="apis,global-inventory-hub" %}

## Bulk update of listings in multiple facilities

When inserting listings for different facilities, the bulk insert API can now be used to minimize the number of calls. First, the listings to be updated need to be searched for obtaining the current version. Afterwards, the listings bulk API can be used to update multiple listings for multiple facilities simultaneously.

{% hint style="info" %}
More information can be found under [Bulk insert listings](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing#bulk-upserting-listings).
{% endhint %}
{% endupdate %}

{% update date="2025-07-22" tags="backoffice,global-inventory-hub" %}

## New stock overview

The stock overview provides an overview of all articles in the network and their respective stock.

* **Inventory across the entire network**: View and filter the inventory of all articles and all facilities in the fulfillment network.
* **All availability values at a glance**: From the quantity available for sale and reservations to expected stock and safety stock.
* **Customization Options**: Users can rearrange columns and thus, tailor the view to their needs.

{% hint style="info" %}
More information can be found under [Network view – Inventory](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory).
{% endhint %}

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fz9uYHIXYxRyI3Ak77AaQ%2FThalia%20Stock%20overview.png?alt=media&amp;token=9bf54b3f-1fc4-478c-a529-173c2b050052" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-07-22" tags="backoffice,global-inventory-hub" %}

## New listing detail view

The listing detail view provides facility specific information on an article that is listed in a facility. The new view is presented in an improved layout, offering more extensive listing details and new functionalities such as viewing and editing custom attributes.

{% hint style="info" %}
More information can be found under [Facility view - Inventory](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory).
{% endhint %}

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FHP7V0KyQfReEl6a8gCvX%2FListings%20detail%20page.png?alt=media&amp;token=e6ffd232-1e61-43aa-aac5-d1a8a28ea3d8" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-07-17" tags="backoffice,order-management" %}

## New orders view (Beta)

The new order view, running alongside the current order page, is designed to provide a clearer and more efficient overview of orders.

* **Improved Layout**: An easier-to-read layout optimizes visibility of the order processes.
* **Enhanced Status Indicators**: Newly added status indicators provide insights into the last mile delivery within the order process.
* **Detailed Information**: More comprehensive details about fulfillment processes, parcels and services are now available on the detail page, which can be opened separately for better comparison.
* **Better Performance**: Improved system performance ensures a faster and smoother user experience.
* **Customization Options**: Users can now rearrange, sort and hide columns and containers to tailor the view to their needs.

{% hint style="info" %}
If you are interested in using and trying out the new view, please contact our customer support. Further information can be found under [Orders (Beta)](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders).
{% endhint %}

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FI6cpEgam3hVroIruCT8s%2FBildschirmfoto%202025-06-24%20um%2013.58.24.png?alt=media&amp;token=4986beab-e6d6-4672-97a5-0455333573b6" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-07-15" tags="apis,store-operations" %}

## Optimized shipping cost calculation through intelligent packing algorithms

The packing algorithm evaluates various methods for grouping ordered items into packages during the routing process. Therefore, shipping costs can be calculated more precisely based on the actual composition of the packages. Considering the dimensions of the items and the available shipping box types, realistic packaging scenarios are simulated.

In addition to fixed package rates assigned to specific shipping routes, the system can also calculate dynamic package-based costs such as costs per unit of weight or volume shipped.\
This detailed and data-driven calculation of shipping costs provides leverage to reduce shipping expenses across the network.

{% hint style="info" %}
If you are interested in using this feature, contact our customer support. It is only available if fulfillment locations are configured as an interconnected fulfillment network.
{% endhint %}
{% endupdate %}

{% update date="2025-06-17" tags="apis" %}

## Usage of tenantFacilityId in API request paths

Users are no able to leverage tenant-defined IDs in API requests. For the start, the `tenantFacilityId` can be used to identify a facility entity.

**Key Benefits:**

* Improved interoperability with third-party services utilizing their own identifiers.
* Enhanced user experience by supporting familiar, business-specific IDs.
* Streamlined integration and reduced complexity in ID mapping.
* Alignment of API operations with business logic for intuitive resource management.

{% hint style="info" %}
More information can be found under [Uniform-Resource-Name-Pattern (URN) in path parameters](https://docs.fulfillmenttools.com/documentation/apis/api-reference#uniform-resource-name-pattern-urn-in-path-parameters).
{% endhint %}

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FWLIwOna64niCOwSoxiPD%2FScreenshot%202025-06-27%20at%2009.17.25.png?alt=media&amp;token=b279ebec-a14f-4a5b-9251-091d95817bdc" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-06-12" tags="backoffice,global-inventory-hub" %}

## Performance improvements article search

Thanks to technical optimizations carried out in the background, the article search in the Backoffice now offers optimized performance (even with large amounts of data). The article searches on the [stock overview](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory) and the [listing views](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory/stock-detail-view) benefit from this.

{% hint style="info" %}
More information on the Backoffice view can be found under [Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/network-view).
{% endhint %}

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FdKpPtNOz8PJCuTtI7uIw%2Fimage.png?alt=media&amp;token=2f86c9ed-7b83-44bb-a017-3e07415ada17" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-06-11" tags="backoffice,apis,advanced-order-routing" %}

## Facility groups can be used to define routing rules <a href="#facility-groups-can-be-used-in-order-to-set-routing-rules" id="facility-groups-can-be-used-in-order-to-set-routing-rules"></a>

[Facility groups](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/facility-groups) allow multiple facilities to be bundled together. These groups can now be used when configuring new routing strategies, toolkit ratings, or fences.

{% hint style="info" %}
More information on routing strategies can be found under [Advanced Order Routing](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/routing-strategy).
{% endhint %}

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FUdXknIQZY86ylnQJghXn%2Fimage.png?alt=media&amp;token=ca593f8c-a7aa-4aac-9a9e-dd11f52045ca" alt=""><figcaption><p>The ordering facility defines when a toolkit fence or rating is being considered</p></figcaption></figure>

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FnAWdqhmW4TH2QULgKF0X%2Fimage.png?alt=media&amp;token=a4df64c0-5fb9-46ac-990c-297e5ff0bcc2" alt=""><figcaption><p>The ordering facility defines when a routing strategy "knot" becomes valid</p></figcaption></figure>
{% endupdate %}

{% update date="2025-06-10" tags="apps,store-operations" %}

## Mandatory short-pick reasons

Short-pick reasons can now be made mandatory through remote configuration. If this configuration is active, users must provide reasons for every short-pick before they can finish the picking task.

{% hint style="info" %}
More information about remote configurations can be found under [Remote configurations](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/remote-configuration).
{% endhint %}

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fa6iFzyYz44dFFiuKoSED%2FRelease-Notes-Shortpick-01-portrait.png?alt=media&amp;token=0b349711-a84f-4b7c-9a6e-2fc1bcf078e5" alt=""><figcaption><p>Confirm button inactive</p></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FsviI9sZlwlkdgKfb6DPW%2FRelease-Notes-Shortpick-02-portrait.png?alt=media&amp;token=c7df1f3b-6f42-481a-9026-afecb3ac2846" alt=""><figcaption><p>Reason selected</p></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FqwHNzmhe94ggUV2g2qdw%2FRelease-Notes-Shortpick-03-portrait.png?alt=media&amp;token=bd91ac80-c54a-4d82-b639-38e280407f2e" alt=""><figcaption><p>Confirm button active</p></figcaption></figure></div>
{% endupdate %}

{% update date="2025-06-10" tags="apis,availability-and-promising" %}

## Custom attributes filter for checkout options earliest endpoint

The [earliest possible delivery date shop endpoint](https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising/earliest-possible-delivery-date) now offers a new filter option by custom attributes.

The endpoint provides the earliest possible delivery date for an item or a list of items. This information can be used on a search result or product overview page to inform the shop user about the earliest delivery date that can be expected for a specific item.

By applying a filter to the request, only facilities that share the specified attribute(s) are considered when evaluating fulfillment options.

A typical use case can be found among retailers operating across multiple countries. In such scenarios, it is essential to ensure that consumers in the online shop are only presented with fulfillment options and delivery promises that are based on resources actually available and accessible within their country.

{% hint style="info" %}
More information can be found under [custom attributes](https://docs.fulfillmenttools.com/documentation/getting-started/custom-attributes). More API information can be found here: [REST API documentation – checkoutoptions/delivery/earliest](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/checkoutoptions/delivery/earliest).
{% endhint %}
{% endupdate %}

{% update date="2025-04-24" tags="apis,global-inventory-hub" %}

## Sales price in listing attributes

Listings can have a sales price. The sales price is particularly relevant for [facilities with type supplier](https://docs.fulfillmenttools.com/documentation/getting-started/facilities#supplier-facilities). These facilities sell/deliver articles to other facilities. Therefore, it might be necessary to define the price for which these supplier facilities sell their listings to other facilities / facility groups.

{% hint style="info" %}
More information can be found under [Article attributes](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes).
{% endhint %}
{% endupdate %}

{% update date="2025-04-22" tags="apis" %}

## Facility groups

Facility groups can be used to mark individual facilities as belonging to a specific group. A facility can be part of several facility groups. Facility groups can be created, edited and deleted via [REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#tag--Core---FacilityGroups). Facility groups can be used, for example, to define [sales prices](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes) for certain facility groups.

{% hint style="info" %}
More information can be found under [Facility groups](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/facility-groups).
{% endhint %}
{% endupdate %}

{% update date="2025-04-17" tags="apis,global-inventory-hub" %}

## Categories

Categories can be used to mark [listings](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing) as belonging to a specific category. A listing can belong to one to many categories. Categories can be created, edited and deleted via [REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#tag--Inventory-Management---Categories).

{% hint style="info" %}
More information can be found under [Categories](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/categories).
{% endhint %}
{% endupdate %}

{% update date="2025-03-25" tags="backoffice,apis" %}

## Search and filter in user management

A new search on the user view enables searching and filtering by facility, role, or name.

{% hint style="info" %}
More information on user management can be found under [User Management](https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management).
{% endhint %}

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FQpUxAwK6rcaUghjHxILu%2Fimage.png?alt=media&amp;token=477d4dc5-4998-414b-bd2e-79151b80917e" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-03-25" tags="apis,global-inventory-hub" %}

## New webhook events in inventory

New events were introduced for `storageLocation` and `listing`, improving the usage of both for event-based system architectures.

{% hint style="info" %}
All available events in the fulfillmenttools platform can be found under [Available events](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events).
{% endhint %}
{% endupdate %}

{% update date="2025-03-18" tags="apis,global-inventory-hub" %}

## Defective stock

It is possible that stock is delivered to a facility in a defective state or that it gets damaged during storage. In such instances, it is advisable to label the stock accordingly and make it unavailable for sale. This option is provided by the [stock condition](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock#stock-condition).

Stocks with the condition defective are displayed in a separate section in the [listing detail view](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory/stock-detail-view) and the [storage location view](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/storage-locations). Users can set the condition to defective when adding new stock.

{% hint style="info" %}
More information can be found under [Stock condition](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock#stock-condition).
{% endhint %}

<table data-header-hidden data-full-width="false"><thead><tr><th width="376.12890625" align="center"></th><th align="center"></th></tr></thead><tbody><tr><td align="center"><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FxsKkW0odVlCSErN0GOJZ%2FStorage%20Location%20-%20Defective%20%26%20Reserved%20Stock%20(4).png?alt=media&amp;token=13dc24af-b68c-40bf-b01f-46b72969d10e" alt="" data-size="original"></td><td align="center"><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FyGxoyKtjrfbiR8ZJudn2%2FStorage%20Location%20-%20Add%20article.png?alt=media&amp;token=3f0b063f-48f2-4007-8218-f63945564e4f" alt="" data-size="original"></td></tr></tbody></table>
{% endupdate %}

{% update date="2025-02-19" tags="apis" %}

## Additions to search functionality

New search endpoints were introduced, allowing searching entities by various search parameters using sorting and several search operators. This covers the following entities: facilities, handover jobs, inbound processes, listings, orders, pack jobs, pick jobs, processes, routing plans, stocks, storage locations, stow jobs, users, and zones.

{% hint style="info" %}
More information can be found under [Search](https://docs.fulfillmenttools.com/documentation/getting-started/search).
{% endhint %}
{% endupdate %}

{% update date="2025-02-12" tags="apis,order-management" %}

## Auditing functionality

The auditing functionality enables users to retrieve information on which actor changed an entity or process. This covers human actors as well as business functions responsible for any changes. Audits can be retrieved via [API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#tag--Core---Audit).

{% hint style="info" %}
More information on can be found under [Audits](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/audits).
{% endhint %}
{% endupdate %}

{% update date="2025-02-11" tags="apis,global-inventory-hub" %}

## New webhook events in inventory

New events were introduced for `stock`, `stow job`, `inbound process`, and `receipt`, improving the usage of the inbound feature, stow jobs, and stock updates for event-based system architectures.

{% hint style="info" %}
All available events in the fulfillmenttools platform can be found under [Available events](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events).
{% endhint %}
{% endupdate %}

{% update date="2025-02-05" tags="backoffice,global-inventory-hub" %}

## Help center in inventory views

The help center is available on the stock overview, listing view, inbound view, and storage location view in the Backoffice. Upon clicking on the help button, the user receives helpful links to the fulfillmenttools documentation, supporting the usage and understanding of the respective view.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FerUdvYhvKnIyzOOT6VRy%2FListings%20-%20release%20notes%402x.jpg?alt=media&amp;token=341c0cd2-2035-4b78-a1c7-0ac0ad2a272f" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-02-05" tags="backoffice,advanced-order-routing" %}

## Routing strategy

With the new routing strategy feature, multiple context-specific routing setups can be configured on a tenant. This enables fully customized routing decisions tailored to different use cases, allowing for greater flexibility and precise control over routing behavior.

{% hint style="info" %}
More information can be found under [Routing strategy](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/routing-strategy).
{% endhint %}

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FvhcPvK6jO7GLlTCQeDYU%2Fimage.png?alt=media&amp;token=7f07551a-d545-49f5-a277-1b3977f3225e" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-02-05" tags="apis" %}

## New search functionality

The new search functionality introduces a search endpoint for individual entities in fulfillmenttools. The search offers a counting and sorting mechanism as well as search operators such as `eq`, `notEq`, `in`, `notIn`, `gt` (>)**,** `gte` (>=)**,** `lt` (<)**,** and `lte` (<=).

{% hint style="info" %}
More information on the search can be found under [Search](https://docs.fulfillmenttools.com/documentation/getting-started/search).
{% endhint %}
{% endupdate %}

{% update date="2025-02-05" tags="apis,global-inventory-hub" %}

## External stock change reasons

External stock change reasons represent user-defined reasons for stock movements within a facility. These reasons can optionally be included in stow line items of [stow jobs](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stow-jobs) to explain why the stock was adapted.

{% hint style="info" %}
More information can be found under [External stock change reasons](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/external-stock-change-reasons).
{% endhint %}
{% endupdate %}

{% update date="2025-02-05" tags="apis,global-inventory-hub" %}

## New webhook events for purchase order and stocks

New events were introduced for `stock` and `purchaseOrder`, improving the usage of the inbound feature and stock updates for event-based system architectures.

{% hint style="info" %}
All available events in the fulfillmenttools platform can be found under [Available events](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events).
{% endhint %}
{% endupdate %}

{% update date="2025-02-04" tags="apis,global-inventory-hub" %}

## Status on purchase order and receipt

* An open status was added to the receipt, simplifying the mapping of the process of accepting incoming goods.
* A canceled status was added to the purchaseOrder, replacing the deprecated canceled flag.

{% hint style="info" %}
More information about the status of the the inbound process and its sub-entities can be found under [Inbound process](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process).
{% endhint %}
{% endupdate %}

{% update date="2025-02-04" tags="backoffice,global-inventory-hub" %}

## Requested date and time visible in inbound view

The date and time for which a delivery of goods was requested is displayed in the [inbound view](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/inbound) in the Backoffice.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Ft2DiINbuQSaDiCevRy1A%2FInbound%20(1).png?alt=media&amp;token=4f626d07-395a-4d8e-89dc-abec0c29e2e7" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-02-04" tags="backoffice,global-inventory-hub" %}

## Reservations column in stock overview

A reservation column is added the [stock overview](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory) in Backoffice, displaying the sum of all reservations for the respective facility including [reservations](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/reservations) without stock and reservations on [expected stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/expected-stock-in-availability).

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FCr7x91Qz71eJBidSwIRq%2FStock%20Overview_.png?alt=media&amp;token=66fa2185-3728-4542-8a3b-0de1f68bae38" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2025-02-04" tags="backoffice,store-operations" %}

## Label error messages are shown

In case there has been an error during the label request, the error message from the carrier is shown in the [order view](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders).

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F9RFDKNmYQs6lR4fHmPwi%2FBildschirmfoto%202025-01-31%20um%2011.22.08.png?alt=media&amp;token=eae013f3-b5a5-4f95-bdc6-03b13b162417" alt=""><figcaption></figcaption></figure>
{% endupdate %}
{% endupdates %}


# Release notes 2024

This page highlights recent updates, new features, and product improvements delivered across our API and Apps.

{% hint style="info" %}
Subscribe to updates using the **RSS feed** button or sign up for our monthly newsletter using the [form on our website](https://fulfillmenttools.com/newsletter-abo-release-summary/).
{% endhint %}

The below release notes focus on the 2024. For other years, see the [2026](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/release-notes) or [2025](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/release-notes/release-notes-2025) release notes.

{% updates format="full" %}
{% update date="2024-12-17" tags="apis,global-inventory-hub" %}

## Stow jobs

Stow jobs represent the intention or instruction to change the storage location and/or the amount of stock in a facility. They support employees in a store or warehouse to execute one or several of the below tasks:

* Relocate items within a facility.
* Stow items from a goods receipt.
* Discard expired or broken items.
* Create stock for items that are not registered yet.

{% hint style="info" %}
More information can be found under [Stow jobs](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stow-jobs) or in the [REST API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#tag--Inventory-Management---Stowing).
{% endhint %}
{% endupdate %}

{% update date="2024-12-17" tags="backoffice" %}

## CSV export via Backoffice

In the handover tab of the facility view there is now the option to compile a CSV export with the data displayed on the page.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F1j2J5AlXlLhRMr795UNt%2FBildschirmfoto%202024-12-20%20um%2014.57.09.png?alt=media&amp;token=1d0a7dd0-8753-421d-9e79-ec825918079b" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2024-11-19" tags="backoffice,global-inventory-hub" %}

## New listing view

The new listing overview offers the option to visit a detail page for each listing by clicking on the arrow on the right. The new detail views give insights into important stock availability values, product information, and storage locations or stocks for the listing. In addition, users can edit stock on this page if the respective setting is active.

{% hint style="info" %}
More information can be found under [Listing view](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory).
{% endhint %}

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FFf4Mf1L5yO0gzwifBkLT%2Fimage%20(2).webp?alt=media&amp;token=af2b07bb-0094-4d7b-87de-0c35299ac28a" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2024-11-19" tags="apis,global-inventory-hub" %}

## Defective stock

It is possible that stock is delivered to a facility in a defective state or that it gets damaged during storage. In such instances, it is advisable to label the stock accordingly and make it unavailable for sale. This option is provided by the new 'condition' field on the stock.

If rejected items are accepted during goods [receipt](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process#receipt), this stock is automatically marked as defective and labelled as not pickable and not accessible.

{% hint style="info" %}
More information can be found under [Stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock#stock-condition).
{% endhint %}
{% endupdate %}

{% update date="2024-11-19" tags="apis,global-inventory-hub" %}

## Trait configuration on stock

Traits provide information on how [storage locations](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones) and [stocks](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock) are to be handled in operational and order processes. Previously, traits could only be set on storage locations and were inherited to stocks. As part of the latest releases, traits can also be set explicitly on stock. This allows users who do not use storage locations, to mark stock as not accessible or not pickable and therefore, exclude it from order routing. Traits on stocks overwrite the default traits and the traits set on the storage location.

{% hint style="info" %}
More information can be found under [Inventory traits](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits).
{% endhint %}
{% endupdate %}

{% update date="2024-11-19" tags="backoffice,global-inventory-hub" %}

## Configuration for stock modification

Users can decide whether it should be allowed to modify stock levels in the Backoffice. While this configuration was previously only applied to the listing view, storage locations are affected now as well. If modifying stock is disallowed, it is not possible to add stock to storage locations or change the existing stock on locations.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FXVCAPYn2FCzdW21HCF8n%2Frelease-notes-03.png?alt=media&amp;token=2fa2c932-cc8c-4b88-ac1f-9ebe5e0c7c4c" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
More information can be found under [Network settings](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/settings#manual-stock-adjustment).
{% endhint %}
{% endupdate %}

{% update date="2024-11-12" tags="apps,store-operations" %}

## **Search and filter operations web app**

A new search and filter function for packing and handover tasks allows users to find specific tasks, such as the last task processed or a task from a particular consumer.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FfOuGZmNVLY2bIRFh281U%2FMockup-Search-Packing-Desktop-02.png?alt=media&amp;token=c9d929f7-2d27-4a4d-a1f6-6d6c6fc34ec1" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F50UIRmRQUjwxrtffSZOP%2FMockup-Search-Packing-Mobile-02.png?alt=media&amp;token=5f4749ca-17bb-4d82-8d3d-f5235948d2f8" alt=""><figcaption></figcaption></figure></div>
{% endupdate %}

{% update date="2024-11-12" tags="backoffice,store-operations" %}

## **Optimized design in the picking view**

In the new picking view, items can now be edited directly in the list view. The item card now contains more attributes and can be expand or collapse to see more or less attributes, as desired. Users can also enlarge the image by clicking on it.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FC1I8AI8az1sVL8csh3rU%2FMockup-Desktop-Picking-View-02.png?alt=media&amp;token=1967dcaf-b591-48a9-8f4d-39352cde06e9" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FY2NB4G9NlXwT1E2c7x65%2FMockup-Desktop-Picking-View-03.png?alt=media&amp;token=e14d66c2-f3d8-489b-8227-0d5d471652cd" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
If you want to use the new picking view, please get in contact with us.
{% endhint %}
{% endupdate %}

{% update date="2024-11-12" tags="apps,store-operations" %}

## Android Operations app update 1.24

The new update enables partial hand over of items to a consumer as part of click-and-collect. Customers who also use the fulfillmenttools Returns App now have a direct link to the Returns App.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FNXQSMbl1eIEfYzQ2dHYV%2FRefuse-reasons-01.png?alt=media&amp;token=faf1880a-5b6a-4dd2-b49e-6d39fc160f81" alt=""><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fu5Mk6VEft19rVCLuIr6J%2FRefuse-reasons-03.png?alt=media&amp;token=d2c89427-24ea-46d9-88dc-37b792369df3" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
Download the new update from the [Google Play Store](https://play.google.com/store/apps/details?id=com.ocfulfillment.fulfillmentapp).
{% endhint %}
{% endupdate %}

{% update date="2024-11-12" tags="backoffice,store-operations" %}

## Facility carrier capacity

We introduce the ability to manage and allocate carrier capacity at a granular level for a facility and its carrier pickup time. This ensures that carriers’ truck loading constraints are respected while routing orders effectively.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fehf7cppZ5HlSUq0CB9Qi%2FScreenshot%202024-12-03%20at%2011.52.43.png?alt=media&amp;token=6dc70d89-d288-4644-91c7-b844691f9ad0" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
More information can be found under [facilities settings](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/settings).
{% endhint %}
{% endupdate %}

{% update date="2024-10-23" tags="apis" %}

## Search orders and processes by consumer ID

It's now possible to filter orders and processes by consumerId.
{% endupdate %}

{% update date="2024-10-23" tags="apis" %}

## New custom attributes

The below [custom attributes](https://docs.fulfillmenttools.com/documentation/getting-started/custom-attributes) were introduced:

* Custom attributes in [zone](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones).
* Custom attributes in inboundLineItem of [receipt](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process#receipt).
* Custom attributes in inboundLineItem of [purchase order](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process/purchase-order).

Custom attributes can be used to maintain information that is not storable via our predefined fields. They have no direct influence on our processes, but can be helpful to map information from and for external systems.
{% endupdate %}

{% update date="2024-10-23" tags="backoffice,global-inventory-hub" %}

## Future stock movements

The [future stock movements](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory/stock-detail-view#future-stock-movements) graph and table are accessible on the [stock overview](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory). The graph shows the development of stock that will be [available for picking](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability) in the future. The table on the right provides more details into the events that triggered the changes in stock levels. Stock levels can change due to delivery of goods (increase) or due to the expiry of stock (decrease).

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FVVoBfMuJEU0tnCG2kpUN%2Fstock%20movements%20new.png?alt=media&amp;token=f1663850-4e73-4093-8d24-707d2cf45b5c" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2024-10-23" tags="backoffice,global-inventory-hub" %}

## Over-reservations

After a reservation has been assigned to a stock, our systems constantly ensure that the reservations can still be fulfilled. If reservations cannot be fulfilled anymore (due to, for example, stock becoming broken) our systems will try to re-distribute the reservation. In case there is no other stock available, an [over-reservation](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/reservations#over-reservation) is created. Users are informed in the[ stock overview](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory) in Backoffice if there are over-reservations for a product.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FLR4NirKL1Kj15AhPH8kT%2Fover%20resrvations%20new.png?alt=media&amp;token=5a19daaf-980f-4393-9865-44d9d127ae0e" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2024-09-24" tags="backoffice" %}

## New languages available in the Backoffice

The following languages are now available:

* Bulgarian
* Croatian
* Czech
* Hungarian
* Portuguese (Portugal)
* Romanian
* Slovakian
* Slovenian

Languages can be changed via the menu on the top right of all Backoffice pages.
{% endupdate %}

{% update date="2024-09-10" tags="backoffice,store-operations" %}

## Links to our apps in the Backoffice

All our apps are now listed on both the [facility view settings](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/settings) and the [network view settings](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/settings) page under "fulfillmenttools apps" including a link to the respective app store.

<div><figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/iS3fgWMjo2GVKgKALJzC/Settings_1.png" alt=""><figcaption><p>Get instant access by following the links to our clients</p></figcaption></figure> <figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/a5x3XvUNHjjFsUhBRZcT/Settings_apps.png" alt=""><figcaption><p>Scan the QR code for quick and easy download</p></figcaption></figure></div>
{% endupdate %}

{% update date="2024-09-03" tags="apis,global-inventory-hub" %}

## Unmixed storage principle

Storage principles can be defined on facility level. The principle “unmixed storage” means that the same item with different properties (e.g., expiry date) must not be stored on the same storage location. Enabling unmixed storage has the following effects:

* If a user tries to stow the same items with different properties on the same storage location, a user prompt is shown in the inventory app.
* For storage location recommendations only locations are shown where the unmixed storage principle is met.

See the [unmixed storage configuration section](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#unmixed-storage-configuration) to get more information.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/Edu4o6dll5V1OEx6yzFC/NET%20Facilities%20Settings%20-%20Unmixed%20storage%20active_02.png" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2024-09-03" tags="apps,store-operations" %}

## Operations web app improvements

**Consumer names** are displayed in the task overview:

<div><figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/J8vDbhY17TYlwB8eL1LH/Picking-tasks-overview.png" alt="" width="180"><figcaption></figcaption></figure> <figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/bexq4rvTCDqTFMueboVK/Service-tasks-overview.png" alt="" width="180"><figcaption></figcaption></figure> <figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/bjk7qGpqZSFbiZtPTJyS/Packing-tasks-overview.png" alt="" width="180"><figcaption></figcaption></figure> <figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/hPmo0BY3wf6aJCF3wZja/Shipping-taks-overview.png" alt="" width="180"><figcaption></figcaption></figure></div>

**Notifications** can be enabled for specific browser versions. If you are interested in this feature, please reach out to your fulfillmenttools contact person for assistance.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/malcZ5oJvgM2f0fV5wFd/Notification.png" alt="" width="375"><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2024-08-20" tags="apis,global-inventory-hub" %}

## Reservations on expected stock

Expected stock can be tracked and communicated to shop systems via our platform. As a result, expected stock can be made available for sale before it has even arrived at the site or has been produced. If necessary, reservations can also be made on expected stock. Expected stock can be communicated to our systems via [purchase orders](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process/purchase-order).

See the [Expected stock in availability article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/expected-stock-in-availability) to get more information on making expected stock available for sale.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/OxmV9nff6o49TjhYg2id/image" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2024-08-20" tags="apis,global-inventory-hub" %}

## Redistribution of reservations

After a reservation has been assigned to an (expected) stock, our systems constantly ensure that the reservations can still be fulfilled. If reservations cannot be fulfilled anymore (due to, for example, stock becoming broken) our systems will try to re-distribute the reservations on stocks meeting the [reservation criteria](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/reservations). In case there is no other stock available, the reservations are still tracked and assigned to a fitting stock as soon as any becomes available.

See the [reservations article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/reservations) for more information.
{% endupdate %}

{% update date="2024-08-20" tags="apis,global-inventory-hub" %}

## Outbound trait for storage locations and stocks

Outbound inventory describes stock that has already been picked for an order and has been physically separated from other stock. It is placed on an outbound location until being handed over to another party and finally, leaving the warehouse. Previously, users could already define whether stock should be booked out or transferred to a (virtual) outbound location after picking. In addition, it is now possible to specifically mark storage locations and their stock with the `OUTBOUND` trait.

See the [Inventory traits article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits) to get more information on the outbound trait.

See the [outbound stock configuration section of the configurations article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#outbound-stock-configuration) to get information on the outbound configuration.
{% endupdate %}

{% update date="2024-08-20" tags="apis,availability-and-promising" %}

## New checkout endpoints

**Earliest possible delivery date**

Provides the earliest possible delivery date for an item or a list of items. This information can be used on a search result or product overview page to inform the shop user about when to expect the delivery of an item at the earliest. Go [here for more REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/checkoutoptions/delivery/timeperiod) information.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/wiB8R3g4DQrNs2P4rRoM/Earliest%20product%20delivery%20date.png" alt=""><figcaption></figcaption></figure>

**Possible delivery dates within time period**

Provides all available delivery dates based on a basket of items within a specific timeframe. This information can be used to provide the user with a calendar view on the product detail page or during checkout. In the calendar view, users can select the most suitable delivery date from all possible dates within the defined time frame. Go [here for more REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/checkoutoptions/delivery/timeperiod) information.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/LkI1aZ9hp66lvd1Ud71R/Specific%20product%20delivery%20date.png" alt=""><figcaption></figcaption></figure>

**Stock availability for delivery date**

Provides available stock quantities over facilities for items on a specific delivery date. This information can be used on a product overview page or product detail page to determine the availability of certain items for a delivery day selected by the consumer. Go [here for more REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/checkoutoptions/delivery/timepoint) information.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/zE3eZRaWYIvdAYkmvBb0/Product%20availability%20check%20calendar.png" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2024-08-06" tags="backoffice,store-operations" %}

## Partial handover

Rework of the handover page for click & meet in the web app. The rework includes:

* A list view providing information on picked versus ordered items.
* Showing respective reasons if the picked amount is lower than the ordered amount (also known as "short-pick").
* An amount handler allowing the user to specify how many items were handed over.
* The possibility to add refuse reasons, describing why the handover to the consumer has not been successful.
* Display of line item information on picked items along with refuse reasons in Backoffice.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/DjyFPvG7WSbLxhgtISkj/handover_003.png" alt=""><figcaption><p>Line item information on picked items along with refuse reasons</p></figcaption></figure>
{% endupdate %}

{% update date="2024-08-06" tags="apps,store-operations" %}

## New printing overview

* Re-design of the print overview.
* Showing packed items separately by parcel.
* Automated pre-fill of custom data, if needed.
* Possibility to request a label per parcel.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/MevXdMGF8gWpK0hJ8mA0/new_printing_004.png" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2024-07-23" tags="backoffice" %}

## Design adjustments for text fields

The updated look of form fields in the whole Backoffice application provides an improved usability.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FHkHGHERFetfH4mItBk10%2Fimage.png?alt=media&amp;token=9467ad8a-2bc4-4593-93a7-f18737a87a3d" alt=""><figcaption></figcaption></figure>
{% endupdate %}

{% update date="2024-07-16" tags="apis,store-operations" %}

## New public events available

**Returns**

* `REFUND_TRIGGERED`
* This event is triggered when every lineItem of a returnJob is set to `closed`
* More information about [returns](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/returns)

**Services**

* `SERVICE_JOB_CREATED`
* `SERVICE_JOB_FINISHED`
* More information about [services](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/service-jobs)

All public events can be found in the [Available events article](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events).
{% endupdate %}

{% update date="2024-07-16" tags="backoffice,apis" %}

## New type of external action

* New type of external action: `COMMENT`
* The external action enables adding any kind of additional information to a process.
* The comment can refer to a previously submitted external action (for example, the payment service provider confirms the adjustment of the payment amount) or a general information (for example, the consumer called and changed the pick-up appointment for their click-and-collect order).

Please find further information in the [External actions article](https://docs.fulfillmenttools.com/documentation/integrations/external-actions).
{% endupdate %}

{% update date="2024-07-09" tags="backoffice" %}

## New links in Backoffice

* Introduction of links allowing users to quickly move between views.
* Administrator users can directly jump from the stock overview on network level to the listings page on facility level.
* By clicking on the link in the stock overview, administrator users can get an overview of all orders containing with reservations for a certain product.
  {% endupdate %}

{% update date="2024-07-09" tags="apis,apps,store-operations" %}

## Packing process with packages

* Pack items into one or several packages during a pack job in the Operations Web App.
* A new view incorporating these changes will follow in the upcoming releases. Please contact us if you are interested in using it beforehand.

More information on the [packing process](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/packing).
{% endupdate %}

{% update date="2024-07-02" tags="apps,store-operations" %}

## Improved task overview

Two design adjustments were made to the task overview in the [Operations Web App:](https://docs.fulfillmenttools.com/documentation/apps/operations-app)

* The consumer's name is included in the entry (if available).
* The status icons of a task include information about the type of task: shipping or pickup. The "Shipping" and "Pickup" tags have been replaced by these combined status and type icons.
  {% endupdate %}

{% update date="2024-07-02" tags="apis,store-operations" %}

## Non-delivery days

* Define carrier and region specific weekdays / dates on which no deliveries can be made
* This information will be considered within specific routing and promising cases

Please find further information in the [non-delivery day section of the facility carrier connections article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/carrier-management#carrier-connections-to-facilities).
{% endupdate %}

{% update date="2024-06-18" tags="backoffice,apis" %}

## External actions

* Define an external action which allows triggering actions and processes in external systems (outside fulfillmenttools). This covers, for example, sending an email to a consumer, adjusting the payment for an order, or other order-related processes.
* The feature enables generic communication with third-party systems. The definition of the external action (done via our API) and the integration of our platform into other systems determines the functional capabilities of the action.
* There are two types of external actions:
  * LINK: A link or deeplink can be attached to an order. A user can then execute processes via the linked external system.
  * FORM: Configure a modal with individual texts and input fields fields. When completing this action, an external event is sent which then can be used to trigger further processes.
* Executing an external action is logged and displayed in our order history.

Please find further information in the [external actions article](https://docs.fulfillmenttools.com/documentation/integrations/external-actions).

<img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/d7d5bpoC5Kki8rNzBMbS/image.png" alt="Example for an external action triggering a payment adjustment" data-size="original">
{% endupdate %}

{% update date="2024-06-18" tags="backoffice,apps" %}

## New language: Spanish

Spanish is supported as a new language in Backoffice, Operations Web App, Operations App, and Returns App.
{% endupdate %}

{% update date="2024-06-18" tags="backoffice,apis,global-inventory-hub" %}

## Extend expected stocks by properties

* Stock that is expected to arrive in inbound processes can have stock properties and an `availableUntil` value reflecting the residual life of the stock.
* This improves the calculation of future (inventory) availability since systems know when stock cannot be sold anymore before it even arrived in a facility.
* Stock properties can be configured via `requestedItems` in the `purchaseOrder`. For more information please refer to [Inbound process](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process).
* The `availableUntil` value is automatically calculated for `expectedStocks` if configured in the respective listing (same as for stocks). For more information please refer to [Stock available until](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing#stock-available-until).
* If there are stock properties specified in the purchase order, they are visible in the [inbound view](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/inbound) in the Backoffice.
  {% endupdate %}

{% update date="2024-06-18" tags="apis,apps,store-operations" %}

## Carrier news

* For DHL users the service "Bulky Goods" is supported which can be configured in the label classifications via the [carrier configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/carrier-management#carrier-configurations) on tenants.
* INTEX and UPS Capital are supported.
  {% endupdate %}

{% update date="2024-06-11" tags="apis,store-operations" %}

## Support of different address types on delivery and return note

* The currently available types of consumer addresses can be used on documents for delivery and return note: `POSTAL_ADDRESS`, `PARCEL_LOCKER`, `INVOICE_ADDRESS`
* Pleas also consider the prioritization rules when providing more than one address type.
* More information about the usage of address types and their impact on documents can be found in the [Printing and document configuration article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/configurations#printing-and-document-configuration).
  {% endupdate %}

{% update date="2024-06-11" tags="apis,apps,store-operations" %}

## Provide short pick reasons when performing a short-pick while picking

* Reasons why certain items were short picked by the picker can be provided as optional information by the picker during the picking process.
* When available and active, the reasons will automatically be shown to the user when trying to complete a picking task with short picked items.
* More information on how to configure reasons for short-picks can be found in the [short pick reasons section of the picking article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking#short-pick-reasons).
  {% endupdate %}

{% update date="2024-06-11" tags="apis,backoffice,store-operations" %}

## Trigger refund screen

* On the [returns](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/returns) page, a refund for items with status ACCEPTED can be triggered.
* Items with status REJECTED or WAITING\_FOR\_INPUT are displayed but cannot be edited.
* Items eligible for a refund can be updated, including entering the refund amount / percentage and currency.

Please note: Only price and currency provided within the order can be displayed. If this information is not available, no refund amount or currency will be shown.
{% endupdate %}

{% update date="2024-05-22" tags="apis,global-inventory-hub" %}

## Expired or outdated goods are omitted in stock availability

* Stocks that have expired or have exceeded their availableUntil value are not considered anymore in the stock availability, namely in `availableForPicking` and `availableOnStock`. For more information please refer to [Stock availability](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability).
* In addition to the expiry date, users can configure an "available until" value on stocks. For example, this allows products to be withdrawn from a sales channel a certain time before they expire. For information on configuration of availableUntil refer to [Listings](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing).
  {% endupdate %}

{% update date="2024-05-14" tags="apis" %}

## Localizations for listing titles and attributes

* Improved concept for localizations in our platform. For more information please refer to [Localizations](https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization).
* Allowing multi-language translations for titles and attributes of listings. For more information please refer to [Listings](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing).
  {% endupdate %}

{% update date="2024-05-14" tags="apis" %}

## New event added to notification center

Trigger emails to configurable mail addresses each time a routing plan is waiting. For more information please refer to [Notification center](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/notification-center).
{% endupdate %}

{% update date="2024-05-14" tags="apis,global-inventory-hub" %}

## New stock availability

* New availability concepts that streamline our availability endpoints and improve comprehensibility.
* The following fields in our endpoints `api/stocks/summaries` and `api/stockdistribution` will be marked as "deprecated" (but will still be available for usage):
  * `available`
  * `availableToPromise`
  * `readyToPick`
* The following fields in our endpoints `api/stocks/summaries` and `api/stockdistribution` are added:
  * `stockOnHand`: Stock that is physically present in a facility
  * `availableOnStock`: Stock that is available to be sold (replaces availableToPromise)

For more information, refer to the [Stock availability article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability).
{% endupdate %}

{% update date="2024-05-08" tags="apis,store-operations" %}

## Services in the task view

We have added a new tab for service tasks (if activated) which show service tasks with their status and content.

* More about services can be found in [the custom services and service jobs article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/service-jobs).
* Search function and filters are still in progress and will follow soon.
  {% endupdate %}

{% update date="2024-05-07" tags="apis,advanced-order-routing" %}

## Bundling items

* Order lines or each of order lines can now be bundled within an order.
* We make sure that [bundled items](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/bundled-line-items) will be fulfilled in the same location and a split of these items is prevented in the routing decision.
  {% endupdate %}

{% update date="2024-05-02" tags="apis,store-operations" %}

## Handling appointment times

* [Collect orders](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management#click-and-collect-order) can now include a consumer pick-up date.
* This pick-up date can be adjusted flexibly in case consumer's plans change.
* In case the consumer does not show up, the pickup task will be [canceled automatically](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management#order-statuses) after a defined timeframe and the corresponding operational restow tasks are triggered.
  {% endupdate %}

{% update date="2024-05-01" tags="backoffice,store-operations" %}

## Returns overview

We now have a new page in the Network Overview which displays available returns including their status and content (if module is used).

* More about return management can be found [in the Returns management article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/returns).
* Search function and filters are still in progress and will follow soon
  {% endupdate %}
  {% endupdates %}


# Free trial information

The trial version of fulfillmenttools lets you try all functions and features for 30 days and test them with individual use cases and scenarios.

If you haven't already requested a free trial, click the button below.

<a href="https://fulfillmenttools.com/en/request-free-trial/" class="button primary">Get the trial version</a>

{% hint style="info" %}
Any settings you create during your free trial can be transferred when you switch to the full version.
{% endhint %}

Once your trial version is ready, you'll receive an email with the following information:

* **API access information**
  * These include:
    * API URL of your tenant[^1]
    * API key (also referred to as `AUTHKEY`)
    * Username
    * Password
* **Backoffice URL**
  * This is how you can access the fulfillmenttools Backoffice[^2] in your browser.
* **Initial login credentials**
  * These are your initial login details. You should change the password in the Backoffice[^2] once you've logged in for the first time. Ensure you don't use any backslashes (`\`) in your password, as this could create issues in Postman.

The rest of this section will take you through setting up your free trial instance and using our product during your free trial.

fulfillmenttools is designed as an API-first product. This means that functionality is first developed and released as an API, before it's released to our clients (Backoffice and apps). So, some features are only configurable using our APIs, while others can be easier to modify in the clients.

{% hint style="info" %}
Our free trial tutorial focuses on working with the fulfillmenttools endpoints, and not how to integrate with other systems. For that, see [our Integration section](https://docs.fulfillmenttools.com/documentation/integrations/client-sdks).
{% endhint %}

In the next article, we'll take you through how to set up Postman for your free trial.

[^1]: An instance of fulfillmenttools for each customer. Each tenant works in different environments. For example, there'll be a tenant for pre-production, and one for production.

[^2]: Our web-based application, where customers manage their fulfillment network and operations via a UI.


# Setting up Postman for your free trial

{% hint style="success" %}

#### Prerequisites

* Access to a free trial tenant[^1] (email with credentials)
* Read our [Free trial information](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information) article
* Access to Postman (you can use an HTTP tool of your choice, but for this article, we'll focus on setting up with Postman)
  {% endhint %}

To set up Postman for your free trial, follow the steps below:

{% stepper %}
{% step %}
**Import the fulfillmenttools collection to Postman**

Download the [raw GitHub file](https://raw.githubusercontent.com/fulfillmenttools/fulfillmenttools-api-reference/master/postman/fulfillmenttoolsAPI.postman_collection.json) and add it to the collection section of Postman.
{% endstep %}

{% step %}
**Create an environment**

Go to the environment section and create a new environment. Add the below to your new environment. Your `projectId` can be found in the email you received from us, which will resemble `ocff-{uniqueID}-dmo`.

<table><thead><tr><th width="298.89453125">Variable</th><th>Value</th></tr></thead><tbody><tr><td><code>projectId</code></td><td>{the project ID in the email you received}</td></tr><tr><td><code>host</code></td><td><code>https://{{projectId}}.api.fulfillmenttools.com/</code></td></tr></tbody></table>
{% endstep %}

{% step %}
**Add credentials to the Postman Vault**

Go to the Postman Vault (bottom right of the Postman screen), and add the below to your Vault. You'll find all the values in the email you received from us (if you've changed the password in Backoffice, use that password instead of the one in the email).

| Variable               | Value                                    |
| ---------------------- | ---------------------------------------- |
| `{projectId}-user`     | {the username in the email you received} |
| `{projectId}-password` | {the password in the email you received} |
| `{projectId}-api-key`  | {the API key in the email you received}  |

{% hint style="info" %}
We use the Postman Vault to store these sensitive variables to avoid syncing them to the Postman Cloud.
{% endhint %}
{% endstep %}

{% step %}
**Make your first API call to get an Auth token**

Go to the fulfillmenttools collection, select `POST Request Auth Token`, ensure your environment is selected, and click **Send**.

You should get a `200` response. If you go back to your environment settings, you'll see that an `authToken` and a `refreshToken` have been automatically created.

{% hint style="info" %}
You'll need to run the `POST Refresh Auth Token` endpoint at least every 60 minutes.
{% endhint %}
{% endstep %}
{% endstepper %}

You're now ready to use all the other calls in the collection :tada:

In the next article, we'll take you through facilities. What they are, how to set them up, and how to edit them.

[^1]: An instance of fulfillmenttools for each customer. Each tenant works in different environments. For example, there'll be a tenant for pre-production, and one for production.


# Facilities in your free trial

{% hint style="success" %}

#### Prerequisites

* Access to a free trial tenant[^1] (email with credentials)
* Read our [Free trial information](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information) and [Setting up Postman for your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/setting-up-postman-for-your-free-trial) articles
* Access to Postman (you can use an HTTP tool of your choice, but for this article, we'll focus on working with Postman)
  {% endhint %}

## What's a facility?

Facilities represent various locations that form part of the fulfillment network. These locations fulfill distinct roles in ensuring the smooth movement of goods, both inbound and outbound. A distinction is made between two primary types of facilities: Managed facilities and suppliers.

Managed facilities are fulfillment locations operated and controlled within the network. The defining characteristic of these facilities is that the complete operational fulfillment process, including picking, packing, shipping, and related tasks, is managed internally or by a partner.

Suppliers are external entities within the supply chain that provide products to the network. These can include manufacturers, publishers, wholesalers, and distributors, among others.

For more information, see the [Facilities article](https://docs.fulfillmenttools.com/documentation/getting-started/facilities).

## Why does it matter for my free trial?

For fulfillmenttools, everything is attached to a facility. Without one, a consumer[^2] could never receive their order.

So, to work with fulfillmenttools, let's create a facility.

## Create a facility

{% stepper %}
{% step %}
**Open the create facility endpoint**

In Postman, find the `POST Add New Facility` endpoint and click to open. You'll see the body is prefilled with some data.

{% code title="Body" %}

```json
{
  "name": "Nerd Herd Clothing",
  "type": "MANAGED_FACILITY",
  "address": {
    "companyName": "Nerd Herd Clothing Ltd",
    "country": "US",
    "postalCode": "42420",
    "city": "Los Angeles",
    "street": "Bison Drive",
    "houseNumber": "42"
  },
  "services": [
    {
      "type": "PICKUP"
    }
  ],
  "status": "ONLINE",
  "locationType": "STORE"
}
```

{% endcode %}

{% hint style="info" %}
We're only using the required fields in this example, and not all the available options. See [our facilities article](https://docs.fulfillmenttools.com/documentation/getting-started/facilities) for more details and the API specification.
{% endhint %}
{% endstep %}

{% step %}
**Edit the data**

You can change the name, address, and so on for testing, or leave it as it is to see how it works.
{% endstep %}

{% step %}
**Send the request**

Click **Send**.

{% hint style="info" %}
Ensure you've refreshed your `authToken` if it's been more than 60 minutes since your last refresh.
{% endhint %}

You should get a `201 Created` response. You'll notice some extra fields that are part of the response and have been automatically created, including the facility `id`, which you'll need to make further requests:

{% code title="Response" %}

```json
{
...
  {
...
         "resolvedCoordinates": {
            "lat": 33.9906506,
            "lon": -118.4666995
        },
        "resolvedTimeZone": {
            "offsetInSeconds": -18000,
            "timeZoneId": "America/New_York",
            "timeZoneName": "Eastern Standard Time",
            "source": "BACKEND_GENERATED"
        },
...        
    "fulfillmentProcessBuffer": 240,
...
    "capacityEnabled": false,
    "lastModified": "2025-12-02T15:12:16.505Z",
    "version": 1,
    "id": "019adf9f-1679-70ee-aeeb-4e94aa65d22b",
    "created": "2025-12-02T15:12:16.505Z"
}
```

{% endcode %}
{% endstep %}

{% step %}
**Open the all facilities endpoint**

In the collection list, select the `GET all facilities` endpoint and click **Send**. You'll see your newly created facility in the list with a `200 OK` response.
{% endstep %}
{% endstepper %}

The facility will also be visible in Backoffice for other team members to use, but we'll go through that later in this section.

In the next article, we'll take you through listings. What they are, how to set them up, and how to edit them.

[^1]: An instance of fulfillmenttools for each customer. Each tenant works in different environments. For example, there'll be a tenant for pre-production, and one for production.

[^2]: The end user is making the purchase, whether online or offline.


# Listings in your free trial

{% hint style="success" %}

#### Prerequisites

* Access to a free trial tenant[^1] (email with credentials)
* Read our [Free trial information](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information), [Setting up Postman for your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/setting-up-postman-for-your-free-trial), and [Facilities in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/facilities-in-your-free-trial) articles
* Access to Postman (you can use an HTTP tool of your choice, but for this article, we'll focus on working with Postman)
  {% endhint %}

## What are listings?

Listings represent the articles offered at a specific facility. Listings are managed per facility, ensuring that only available articles are listed. Although optional, they are essential for certain functionalities, such as dynamic order routing.

{% hint style="info" %}
A listing can be seen as a product, an item, an article, and so on.
{% endhint %}

## Why does it matter for my free trial?

For this tutorial, we're assuming we're a shop with products to sell and a consumer[^2] wants to order those products. For that, we need to attach those products (listings) to our shop (facility).

Let's add a listing to the facility we created.

## Create a listing

{% stepper %}
{% step %}
**Copy the facility ID**

In Postman, copy the `id` that was created from our [Facilities in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/facilities-in-your-free-trial) article.
{% endstep %}

{% step %}
**Open the create facility endpoint**

Find the `PUT Update Listings For Facility` endpoint (under Facilities, then Facility Listings) and click to open. You'll see the body is prefilled with some data for multiple listings. For example:

```json
{
    "listings": [
        {
            "tenantArticleId": "SNEAK-W-4891", // required unique ID you provide for your listing 
            "title": "White sneakers", // optional name of article that will be displayed in Backoffice and apps
            "imageUrl": "https://img.example.com/img/sneakw4891.jpg", // optional image of the article that will be displayed in Backoffice and apps
            "scannableCodes": ["738502847562", "SNEAK-W-4891"] // optional unique ID codes for picking and packing purposes, could be an EAN or barcode
        },
        {
            "tenantArticleId": "TSHIRT-W-2468",
            "title": "Basic T-shirt white",
            "imageUrl": "https://img.example.com/img/tshirtw2468.jpg",
            "scannableCodes": ["829401938473", "TSHIRT-W-2468"]
        }
    ]
}
```

{% hint style="info" %}
We're not all the available fields in this example. See our [Listings article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing) for more details.
{% endhint %}
{% endstep %}

{% step %}
**Paste the facility ID**

In the request, click **facilityId** and paste your copied ID into the **Params**.
{% endstep %}

{% step %}
**Edit data**

You can edit the **Body** in any way you wish, or leave it as it is.
{% endstep %}

{% step %}
**Send the request**

Click **Send**.

{% hint style="info" %}
Ensure you've refreshed your `authToken` if it's been more than 60 minutes since your last refresh.
{% endhint %}

You should get a `200 OK` response. You'll notice some extra fields that are part of the response and have been automatically created.
{% endstep %}
{% endstepper %}

The listing will also be visible in Backoffice for other team members to use, but we'll go through that later in this section.

In the next article, we'll take you through configuring stock. What they are, how to set them up, and how to edit them.

[^1]: An instance of fulfillmenttools for each customer. Each tenant works in different environments. For example, there'll be a tenant for pre-production, and one for production.

[^2]: The end user is making the purchase, whether online or offline.


# Configuring stock in your free trial

{% hint style="success" %}

#### Prerequisites

* Access to a free trial tenant (email with credentials)
* Read our [Free trial information](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information), [Setting up Postman for your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/setting-up-postman-for-your-free-trial), [Facilities in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/facilities-in-your-free-trial), and [Listings in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/listings-in-your-free-trial) articles
* Access to Postman (you can use an HTTP tool of your choice, but for this article, we'll focus on working with Postman)
  {% endhint %}

## What's stock?

Stock is the total amount of goods or the amount of a particular type of goods available in a store or warehouse.

## Why does it matter for my free trial?

For this tutorial, we're assuming we're a shop with products to sell and a consumer[^1] wants to order those products. For that, we need to let the system know how many products (listings) we have to sell in our shop (facility).

Let's add a stock to the listings we created for our facility.

## Add stock to listing

{% stepper %}
{% step %}
**Open the stocks endpoint**

In Postman, find the `POST Create Stock` endpoint and click to open. You'll see the body is prefilled with some data. For example:

```json
{
    "facility": {
        "facilityRef": "{YOUR_FACILITY_ID}" // the ID of the facility you created
    },
    "tenantArticleId": "{YOUR_TENANT_ARTICLE_ID}", // the ID of the listing you created
    "value": 42, // the amount of stock on hand
    "traitConfig": 
    [
        {
        "trait": "ACCESSIBLE", // setting this allows the stock to be considered for incoming orders
        "enabled": true
        }, 
        {
        "trait": "PICKABLE", // setting this allows the stock to be picked for incoming orders
        "enabled": true
        }
    ]
}
```

{% hint style="info" %}
We're only using the required fields in this example, and not all the available option. See [our stocks article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock) for more details and the API specification.
{% endhint %}
{% endstep %}

{% step %}
**Get the facility ID**

Copy the `id` that was created from our [Facilities in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/facilities-in-your-free-trial) article and paste into the request body where it says `YOUR_FACILITY_ID`
{% endstep %}

{% step %}
**Get the article ID**

Copy the `tenantArticleId` from one of the listings we created in [Listings in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/listings-in-your-free-trial) and paste into the request body where it says `YOUR_TENANT_ARTICLE_ID`
{% endstep %}

{% step %}
**Edit data**

You can edit the body in any other way you wish, or leave it as it is.
{% endstep %}

{% step %}
**Send the request**

Click **Send**.

{% hint style="info" %}
Ensure you've refreshed your `authToken` if it's been more than 60 minutes since your last refresh.
{% endhint %}

You should get a `201 Created` response. You'll notice some extra fields that are part of the response and have been automatically created.
{% endstep %}
{% endstepper %}

The stock will also be visible in Backoffice for other team members to use, but we'll go through that later in this section.

In the next article, we'll take you through orders. What they are, how to set them up, and how to edit them.

[^1]: The end user is making the purchase, whether online or offline.


# Orders in your free trial

{% hint style="success" %}

#### Prerequisites

* Access to a free trial tenant[^1] (email with credentials)
* Read our [Free trial information](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information), [Setting up Postman for your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/setting-up-postman-for-your-free-trial), [Facilities in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/facilities-in-your-free-trial), [Listings in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/listings-in-your-free-trial), and [Configuring stock in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/configuring-stock-in-your-free-trial) articles
* Access to Postman (you can use an HTTP tool of your choice, but for this article, we'll focus on working with Postman)
  {% endhint %}

## What's an order?

An order is the entry point for the fulfillment process. fulfillmenttools consumes the following information from an order object:

* The consumer's location
* The time the order was placed
* The line items of the order, including:
  * Article (`title` and `tenantArticleId`)
  * `quantity`

This is the minimum information fulfillmenttools needs for order fulfillment. However, more information can be provided. For example, an order line item can contain a list of scannable codes that must be scanned when the item is picked in a facility. Furthermore, it's recommended to configure the `deliveryPreferences` for the order.

## Why does it matter for my free trial?

For this tutorial, we're assuming we're a shop with products to sell and a consumer wants to order those products, and then pick up that order from our shop. For that, we need to let the system know that an order has taken place on our online shop.

Let's add an order to our facility.

## Placing an order

{% stepper %}
{% step %}
**Open the orders endpoint**

In Postman, find the `POST Add new order` endpoint (under Order routing, then Orders). You'll see the body is prefilled with some data. For our example, we'll replace all the prefilled data with our own.

```json
{
    "orderDate": "2025-12-11T08:16:07.000Z",
    "status": "OPEN",
    "consumer": {
        "addresses": [
            {
                "firstName": "Phil",
                "lastName": "Bison",
                "street": "42nd street",
                "houseNumber": "42",
                "postalCode": "42420",
                "city": "Los Angeles",
                "country": "US",
                "phoneNumbers": [
                    {
                        "value": "0177-555-4242",
                        "label": "private",
                        "type": "MOBILE"
                    }
                ],
                "email": "phil.bison@ocff.com"
            }
        ]
    },
    "orderLineItems": [
        {
            "article": {
                "tenantArticleId": "TSHIRT-W-2468",
                "title": "Basic T-shirt white"
            },
            "quantity": 1
        },
        {
             "article": {
                "tenantArticleId": "SNEAK-W-4891",
                "title": "White sneakers"
            },
            "quantity": 1
        }        
    ],
    "deliveryPreferences": {
        "collect": [
            {
            "facilityRef": "{YOUR_FACILITY_ID}",
            "paid": true
            }
        ]
    },
      "tenantOrderId": "R42424240"
}
```

{% hint style="info" %}
We're only using the required fields in this example, and not all the available option. See [our orders article](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/orders) for more details and the API specification.
{% endhint %}
{% endstep %}

{% step %}
**Edit data**

You can edit the body in any way you wish, or leave it as it is.
{% endstep %}

{% step %}
**Send the request**

Click **Send**.

{% hint style="info" %}
Ensure you've refreshed your `authToken` if it's been more than 60 minutes since your last refresh.
{% endhint %}

You should get a `201 Created` response. You'll notice some extra fields that are part of the response and have been automatically created.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Although you can create orders manually, we recommend implementing a solution that receives incoming orders from shop systems. See our orders integration article for more information.
{% endhint %}

The order will also be visible in Backoffice for other team members to use. We'll take you through using Backoffice in the next article.

[^1]: An instance of fulfillmenttools for each customer. Each tenant works in different environments. For example, there'll be a tenant for pre-production, and one for production.


# Using Backoffice during your free trial

{% hint style="success" %}

#### Prerequisites

* Access to a free trial tenant[^1] (email with credentials)
* Read our [Free trial information](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information), [Setting up Postman for your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/setting-up-postman-for-your-free-trial), [Facilities in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/facilities-in-your-free-trial), [Listings in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/listings-in-your-free-trial), [Configuring stock in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/configuring-stock-in-your-free-trial), and [Orders in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/orders-in-your-free-trial) articles
* Access to a browser on a desktop device
  {% endhint %}

## What's Backoffice?

Backoffice is our web-based application, where customers manage their fulfillment network and operations via a UI. It's recommended to use Google Chrome to access Backoffice.

## Why does it matter for my free trial?

Seeing how Backoffice works will give you an idea of how your team can work together with our solution. Some changes can only be made with our APIs, but others can be made within Backoffice, giving your team the freedom to choose and not be restricted to relying on developers for certain changes.

## Accessing Backoffice

{% stepper %}
{% step %}
**Open Backoffice**

Click the link to Backoffice you were provided in your free trial email. It will follow the `https://ocff-{projectId}-dmo.web.app` structure.
{% endstep %}

{% step %}
**Log in**

Input the credentials from your free trial email and click **LOG IN**.

You'll see a screen to select the facility or network view.

{% hint style="info" %}
If you haven't followed our [Facilities in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/facilities-in-your-free-trial) article, you'll need to create a facility in Backoffice before you can continue.
{% endhint %}
{% endstep %}
{% endstepper %}

## Facility view

When you click **Select facility**, you'll be shown a modal with the available facilities that you can select to see the relevant information for that facility. As we only created one facility, you'll only see this option in your list.

Once the facility view is open, you'll see a summary and can navigate to see orders, inventory, facility information, and users.

In the orders section, you'll see the order we created in [Orders in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/orders-in-your-free-trial).

In the inventory section, you'll see the listings we created in [Listings in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/listings-in-your-free-trial), along with the stock we added in [Configuring stock in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/configuring-stock-in-your-free-trial).

In the facility section, you'll see all the details we included about this facility in [Facilities in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/facilities-in-your-free-trial).

In the users section, you'll see your user information, and can invite other team members to the trial.

## Network view

When you click **Network view**, you'll be taken to the overview page where you'll see an operational overview and a facility map.

When you go through the navigation, you'll also see all the same information as in the facility view.

For more information on how to use Backoffice, see the [Backoffice section of the documentation](https://docs.fulfillmenttools.com/documentation/backoffice/accessing-backoffice).

[^1]: An instance of fulfillmenttools for each customer. Each tenant works in different environments. For example, there'll be a tenant for pre-production, and one for production.


# Using the apps during your free trial

{% hint style="success" %}

#### Prerequisites

* Access to a free trial tenant[^1] (email with credentials)
* Read our [Free trial information](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information), [Setting up Postman for your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/setting-up-postman-for-your-free-trial), [Facilities in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/facilities-in-your-free-trial), [Listings in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/listings-in-your-free-trial), [Configuring stock in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/configuring-stock-in-your-free-trial), [Orders in your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/orders-in-your-free-trial), and [Using Backoffice during your free trial](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information/using-backoffice-during-your-free-trial) articles
* Access to an Android device
  {% endhint %}

## What are the fulfillmenttools apps?

The Store Operations app helps you to carry out store operations. It's available on iOS and Android, and as a web app.

For this tutorial, we'll be using the Store Operations app on an Android device.

## Why does it matter for my free trial?

Seeing how our apps work will give you an idea of how your team can work together with our solution. It will also show you how our order we created can be picked and packed, then handed over to our consumer.

## Accessing the Store Operations app

{% stepper %}
{% step %}
**Open Backoffice and log in**

Click the link to Backoffice you were provided in your free trial email. It will follow the `https://ocff-{projectId}-dmo.web.app` structure.
{% endstep %}

{% step %}
**Download the app**

In the **Network view** of Backoffice, click **Settings** in the left-hand navigation. Then, in the **fulfillmenttools app** section, click the **Store Operations App** button. This opens a modal with a QR code you can scan with your Android device to download the app.

You can also search the Google Play Store and find the app within the results.
{% endstep %}

{% step %}
**Connect the app to Backoffice**

Once the Store Operations app is open on your Android device, scan the QR code in Backoffice in the **Connect apps** section. This will log you into the app and you're now ready to get picking.
{% endstep %}
{% endstepper %}

## Picking, packing, handover, and returns

Now we've received an order from a consumer, we need to prepare the items from our shop so they're ready for when the consumer arrives.

### Picking

Picking is the act of collecting the items for an order. We can use the Store Operations app to guide us through the process.

{% hint style="info" %}
As we haven't adjusted the remote configuration settings, some steps in the process will happen automatically. You can adjust these in the future.
{% endhint %}

{% stepper %}
{% step %}
**Access the order**

In the Store Operations app, tap **Orders** in the bottom bar. Then, you'll see the order we created earlier in the order list. Tap on the order to open it.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F9aoCXIVOOPZq5sjTltON%2FSelect%20the%20order%20from%20the%20list.png?alt=media&amp;token=020dd33b-9e1d-47dd-8e52-643fb75aa31f" alt="Store Operations app order list showing the order we&#x27;ve created" width="188"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Start the picking process**

Tap the **Start** button to begin the picking process.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F4zcFJU7mJ1dvSwBiLxgr%2FTap%20start.png?alt=media&amp;token=c6e4ca67-70bc-4d22-ad7c-a231e107397a" alt="Store Operations app screen to start picking process" width="188"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Pick the first item**

Tap on the first item in the list, then use the **+** icon to add to increase the amount to 1, then tap **Pick item**.

{% hint style="info" %}
We haven't added any attributes or locations to our items, which is why they appear empty in these screens.

In the future, you can enable scanning to easily add items.
{% endhint %}

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F8HMkvoNwdWv7m7UMbEYL%2FSelect%20the%20first%20item.png?alt=media&amp;token=cf97973d-4f99-4046-8785-fc9a24313716" alt="Store Operations app item list to pick" width="188"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F0WwkvhnPLLXbmnkO8OJu%2FClick%20the%20plus%20icon%20to%20input%20a%20number.png?alt=media&amp;token=1760859a-49d9-45a6-b0f9-9876bc16d53c" alt="Store Operations app item detail view to pick" width="188"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FQ43u5pemv6hODAkO3RvT%2FTap%20pick%20item.png?alt=media&amp;token=79ba4b8e-707d-4c77-b663-1c9ae56db6e3" alt="Store Operations app item detail with pieces selected" width="188"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Put the item in a container**

The item needs to be added to a container. Tap the + icon, input a name for the container, then tap **Confirm**. You'll then be taken back to the item list where this item has moved to the **Done** tab, and you'll be left with an **Open** item.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FT7Cof849u8itFLNQwXhT%2FClick%20the%20plus%20icon%20to%20input%20a%20name%20manually.png?alt=media&amp;token=ac09b327-d2d8-4fac-8db9-9cac3b5b782b" alt="Store Operations app scan container or tap plus icon to input manually" width="188"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FjzLpDHIkvKuz0xv28fwd%2FEnter%20a%20name%20for%20a%20container.png?alt=media&amp;token=56ce1731-e649-4eaf-8f10-9f9139af64d4" alt="Store Operations app input container name manually" width="188"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fr8bmAhd96jkcWO6eEr3m%2FItem%20picked%20succuessfully.png?alt=media&amp;token=34c1e381-83be-4933-98fb-0bb36ae18851" alt="Store Operations app item picked successfully confirmation" width="188"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Pick the second item**

Tap on the remaining item in the **Open** list, then use the **+** icon to add to increase the amount to 1, then tap **Pick item**, and select the same container you created in step 4. You'll then be taken back to the item list.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FfDTfhR2nPzRTdmfunzL9%2FSelect%20the%20previously%20created%20container.png?alt=media&amp;token=e1b782c6-8728-45ae-9d03-b3b60f5c7cb4" alt="Store Operations app select container" width="188"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Complete the picking process**

Slide the slider to finish the task. You'll then see the picking summary, where you can either start the packing process or go back to the order overview.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FMwxzaZdQpPEeR6m3cxGV%2FSlide%20to%20finish%20picking.png?alt=media&amp;token=b846c12e-d242-40fd-af5e-acba106cd9c1" alt="Store Operations app slide to finish picking" width="188"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FhaLIG8Q2dffxPsrnZ2jV%2FPicking%20summary%20to%20start%20packing.png?alt=media&amp;token=cada565a-81b7-4e32-ab4a-cb8584502dc3" alt="Store Operations app picking summary" width="188"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

Now our items have been picked for our consumer's order, we need to pack the items so they're ready for when the consumer arrives.

### Packing

Packing is the act of putting the items for an order into a container. We can use the Store Operations app to guide us through the process.

{% stepper %}
{% step %}
**Access the packing section**

Tap the **Start packing** button to start the packing process. You'll then be shown what items are needed to pack. Tap the **Continue** button to start.

{% hint style="info" %}
If you tap, **Go to order overview**, you'll be taken back to the task list where you can start the packing later.
{% endhint %}

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FhaLIG8Q2dffxPsrnZ2jV%2FPicking%20summary%20to%20start%20packing.png?alt=media&amp;token=cada565a-81b7-4e32-ab4a-cb8584502dc3" alt="Store Operations app picking summary" width="188"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FpJEL9vAXAh7JPuFgcS4j%2FTap%20continue%20to%20start%20packing.png?alt=media&amp;token=01895a77-9cf8-40d0-b66d-a3db7b2616a6" alt="Store Operations app items to pack" width="188"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Select the packed items**

Tap the + icon on each item so all items are packed, then tap **Finish**.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FqKjzyaptTiLhjOjOCwTm%2FAdd%20the%20items%20to%20the%20container.png?alt=media&amp;token=d6fee28f-3571-48a0-b899-1a3da00e9772" alt="Store Operations app item list to pack" width="188"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F3lkyPoG7Xesw0uHVUX8W%2FTap%20finish%20to%20finish%20packing.png?alt=media&amp;token=9f149185-81d6-4b47-ad71-ce8975bcbda5" alt="Store Operations app items packed and tap finish" width="188"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**View documents**

You have the option to print the return note. As we haven't set up a printer, you'll only be able to view the PDF. To do this, select the return note, then tap **Print documents**. When you're ready, tap **Done**.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FvKabW87KcgfYbHzTjC2J%2FSelect%20documents%20to%20be%20printed.png?alt=media&amp;token=b4098a96-dbc8-4a6f-b341-f27db6b2f269" alt="Store Operations app select documents to print" width="188"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Ff9bBvdz7Cx98jZwBEnLR%2FPrint%20documents.png?alt=media&amp;token=c52ba1c8-fdd6-41c6-bd1b-208063eabe00" alt="Store Operations app print documents" width="188"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Finish packing**

Tap the **Finish packing** button to complete the packing process. You'll be taken back to the order overview screen.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FZHZW0q0GgK8ERQxWRiRt%2FFinish%20packing%20summary.png?alt=media&amp;token=558c8fc4-2f21-46e8-b718-4b43bbf92d36" alt="Store Operations app finish packing process" width="188"><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

Now our items have been packed for our consumer's order, we need to let the system know when the consumer has picked up their items.

### Handover

Handover is the act of giving the items for an order over to either a carrier, or in this case, directly to the consumer. We can use the Store Operations app to guide us through the process.

{% stepper %}
{% step %}
**Select the order to handover**

Tap the order that you need to hand over.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FkkyLkyyt3px3AvNqKsYK%2FSelect%20the%20order%20to%20handover.png?alt=media&amp;token=f850658e-21fb-4a51-83a7-d3118156b8f1" alt="Store Operations app order list select order to handover" width="188"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Confirm containers**

Tap the **Continue** button to proceed.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FPktfl49IYMQx9X5nxL5I%2FPick%20up%20the%20container%20to%20handover.png?alt=media&amp;token=619922b4-4bfd-4508-ba29-a920e4081b7b" alt="Store Operations app handover process to start" width="188"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Review items to handover**

Check the items and number of items match, then tap **Confirm items**.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FnDkHu2PF3TS84QLm0ChB%2FHandover%20item%20list.png?alt=media&amp;token=dd26d488-0179-4300-8501-17f3828e6eaf" alt="Store Operations app handover item confirmation" width="188"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Complete the handover process**

The the **Handover** button to complete the handover process. You'll see a successful notification and return to the order overview.

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FWOqUdyHoQc8FKrgR77Xw%2FHandover%20order%20summary.png?alt=media&amp;token=64445fbb-734d-4a46-b103-1588e3818345" alt="Store Operations app handover confirmation screen" width="188"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FhQsE5OD5TLqSdRnwMQC3%2FOrder%20handed%20over.png?alt=media&amp;token=cdf341bb-9821-4c6f-a203-e56b54b795b0" alt="Store Operations app handover complete" width="188"><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

That completes our free trial basic tutorial. You can go further in depth into these topics and find our more about our further capabilities in the following sections.

[^1]: An instance of fulfillmenttools for each customer. Each tenant works in different environments. For example, there'll be a tenant for pre-production, and one for production.


# LLM-ready docs

Our documentation is LLM-ready. It's automatically published in AI-friendly formats for AI tools to discover, read, and use. These tools can discover and retrieve accurate documentation without parsing HTML.

## Ask AI

When searching for a term in our documentation, you can either select a page to view, or you can ask a question to AI by selecting Ask AI at the bottom of the results. It will search our documentation and respond with relevant information and links to the pages it used for references.

<div data-with-frame="true"><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FhxobSNJMWBnlECxrEHFY%2FAsk%20AI%20in%20search%20bar.png?alt=media&amp;token=a6f2568e-e9bd-4b8d-904e-795629922261" alt="" width="188"><figcaption></figcaption></figure></div>

## MCP

Because our documentation is hosted in GitBook, an MCP is automatically generated for our full documentation that you can use. This works with Claude, Claude Code, Cursor, Codex, VS Code, and other MCP clients.

You'll need to use our MCP URL (`https://docs.fulfillmenttools.com/documentation/~gitbook/mcp`) to access it.

{% hint style="info" %}
Opening the MCP URL in a browser returns an error. Use a tool that can make HTTP requests.
{% endhint %}

You can copy this URL directly from an article by using the dropdown actions menu and selecting **Connect with MCP**.

<div data-with-frame="true"><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FnIgx7zJXXWcidXl0SXtN%2FConnect%20docs%20to%20MCP.png?alt=media&amp;token=da0360e9-56f2-48e3-98f5-1d0220fd6880" alt="" width="375"><figcaption></figcaption></figure></div>

You can also follow the different instructions per provider below:

{% tabs %}
{% tab title="Claude" %}
These steps work in Claude on the web and in Claude Desktop.

Open **Settings**, and then select **Connectors**.

Click **Add custom connector**. Then paste the MCP server URL below:

```
https://docs.fulfillmenttools.com/documentation/~gitbook/mcp
```

{% endtab %}

{% tab title="Claude Code" %}
Run this command in your terminal:

```shellscript
claude mcp add --transport http fulfillmenttools-docs https://docs.fulfillmenttools.com/documentation/~gitbook/mcp
```

Replace `fulfillmenttools-docs` with any server name you want.
{% endtab %}

{% tab title="Cursor" %}
Open **Settings**, then select **MCP**.

Click **Add new MCP server**. Then paste `https://docs.fulfillmenttools.com/documentation/~gitbook/mcp`.

You can also add this file in `.cursor/mcp.json`:

```
{
  "mcpServers": {
    "fulfillmentools-docs": {
      "url": "https://docs.fulfillmenttools.com/documentation/~gitbook/mcp"
    }
  }
}
```

Replace `fulfillmenttools-docs` with your own server name if you want.
{% endtab %}

{% tab title="Codex" %}
Use the `codex mcp add` command, or add the server to your `config.toml`.

Command example:

```bash
codex mcp add fulfillmenttools-docs https://docs.fulfillmenttools.com/documentation/~gitbook/mcp
```

Config example:

```bash
[mcp_servers.fulfillmenttools-docs]
url = "https://docs.fulfillmenttools.com/documentation/~gitbook/mcp"
```

Replace `fulfillmenttools-docs` with your own server name if you want.
{% endtab %}

{% tab title="VS Code (Copilot)" %}
Open your `mcp.json` file. Then add a server entry with HTTP transport:

```json
{
  "servers": {
    "fulfillmenttools-docs": {
      "type": "http",
      "url": "https://docs.fulfillmenttools.com/documentation/~gitbook/mcp"
    }
  }
}
```

Replace `fulfillmenttools-docs` with your own server name if you want.
{% endtab %}
{% endtabs %}

If you use an agentic tool, you can also give it this setup prompt:

```
Add an MCP server named fulfillmenttools-docs with HTTP transport at https://docs.fulfillmenttools.com/documentation/~gitbook/mcp. Then verify it connects by listing its available tools.
```

{% hint style="info" %}
For information on the MCP Servers fulfillmenttools provides, see the [MCP articles](https://docs.fulfillmenttools.com/documentation/integrations/mcp-servers/mcp-server-fulfillmenttools-api).
{% endhint %}

## LLMs.txt

We have two versions of an LLMs.txt.

The [LLMs.txt](https://docs.fulfillmenttools.com/documentation/llms.txt) is a proposed standard for LLM-friendly web content. It lists every published page with a Markdown version. AI tools can use this index to discover our documentation.

The [LLMs.txt-full](https://docs.fulfillmenttools.com/documentation/llms-full.txt) includes our full documentation content in one place.

## AI Sidekick

The fulfillmenttools [AI Sidekick](https://docs.fulfillmenttools.com/documentation/backoffice/ai-sidekick) in Backoffice can be used to search our documentation, so you can stay in Backoffice but find the answers you need.


# General concepts

## Set up

When you become a fulfillmenttools customer, you'll have access to two environments:

* Pre-production (for example, `ocff-nerdherd-pre`)
* Production (for example, `ocff-nerdherd-prd`)

## Tenant

We refer to an instance of fulfillmenttools as a tenant. Each tenant works in different environments. For example, there'll be a tenant for pre-production, and one for production.

A tenant name will always start with `ocff-` followed by a `projectId`, then the environment (for example, `-prd`). The `projectId` is a unique identifier, usually your customer name. For example, `ocff-nerdherd-prd`.

Across our documentation, you'll either see `ocff-{PROJECT_ID}` or `{YOUR_TENANT_NAME}`. When you see `{PROJECT_ID}`, replace it with your project ID and the environment, for example, `nerdherd-prd`. When you see `{YOUR_TENANT_NAME}`, replace it with `ocff-{PROJECT_ID}-{ENVIRONMENT}`, for example, `ocff-nerdherd-prd`.

## Methods

Standard HTTP methods are used to define the type of operation being performed.

<table><thead><tr><th width="212.31640625">Method</th><th>Definition</th></tr></thead><tbody><tr><td><code>GET</code></td><td>Retrieves data without modifying any existing resource.</td></tr><tr><td><code>POST</code></td><td>Sends new data to create a new resource.</td></tr><tr><td><code>PUT</code></td><td>Updates or replaces an existing resource with new data.</td></tr><tr><td><code>PATCH</code></td><td>Partially modify a specified resource.</td></tr><tr><td><code>DELETE</code></td><td>Removes a specified resource.</td></tr></tbody></table>

## Status codes

Standard HTTP status codes are used for success and errors.

| Status code         | Definition                                                |
| ------------------- | --------------------------------------------------------- |
| `200`               | `OK`                                                      |
| `201`               | `Created`                                                 |
| `400`               | `Bad request`                                             |
| `401`, `403`        | `Missing authorization`, `Authentication`                 |
| `404`               | `Not found`                                               |
| `409`               | `Version conflict`                                        |
| `429`               | `Too many requests`                                       |
| `500`, `503`, `504` | `Internal server error`, `Service unavailable`, `Timeout` |

## Formats

### Currencies

When maintaining currencies in fulfillmenttools, the following fields must be defined to support different currencies and decimal precision:

* `value`
* `currency`
* `decimalPlaces`

The actual value = `value` / 10^`decimalPlaces`.

For example, the `value` below is `1559` with `decimalPlaces` set to `2`. This would be interpreted as 15.59 euros.

```json
{
  "value": 1559,
  "currency": "EUR",
  "decimalPlaces": 2
}
```

If no `decimalPlaces` are sent, the backend sets a default of `2`.

Nested numeric cost fields within an object, such as `deliveryCostCoefficient.value` on facility connections, don't define their own `currency` or `decimalPlaces`. They reuse the enclosing object's `decimalPlaces` value.

For example, the `value` below is `500` with `decimalPlaces` set to `2`. This would be interpreted as 5.00 euros. Then, the `deliveryCostCoefficient.value` is `12` and also uses `decimalPlaces` of `2`, resulting in 0.12 euros per `gram` (`measurementUnit`).

```json
{
  "currency": "EUR",
  "decimalPlaces": 2,
  "value": 500,
  "deliveryCostCoefficient": {
    "measurementUnit": "GRAM",
    "value": 12
  }
}
```

### Date and time

To ensure consistency across fulfillmenttools, all date and time attributes in API requests must follow a defined schema. The platform requires [ISO 8601/RFC 3339](https://en.wikipedia.org/wiki/ISO_8601)–based timestamps for all date and time values.

`date-time` is used when the specific time (including timezone) is relevant. Valid ISO 8601 date-time strings in UTC include:

* `2025-03-21T13:00:12Z`
* `2025-03-21T13:00:12.123Z`
* `2025-03-21T13:00:12.123456Z`
* `2025-03-21T13:00:12.123456789Z`

#### Dates

If the time component isn't required, `date` is used. The format `YYYY-MM-DD` is used. A valid date string would be, for example:

```
2025-02-03
```

#### Times

For attributes such as facility opening times, the `HH:MM` format is used. If higher precision is needed (seconds or milliseconds), use the pattern:

```
HH:MM:ss:SSS
```

#### Time duration

Durations must be defined using ISO 8601 duration notation (for example, `P30D` for 30 days). Negative values move the date backwards.

## Resource timestamps

All entities in fulfillmenttools include two primary timestamps to track their lifecycle:

* `created`: The date and time when the entity was created.
* `lastModified`: The date and time when the entity was last changed.

## Updates without modifications

When an entity is updated through the fulfillmenttools APIs and no data has changed, fulfillmenttools doesn't perform a database write. In this case:

* No version bump occurs.
* The `lastModified` field is not updated.
* No event is triggered.

This behavior reduces unnecessary cascading updates.<br>

## Mandatory parameters

In the fulfillmenttools APIs, all mandatory string parameters must have a minimum length of **one**. An empty string (`""`) isn't a valid value.

{% hint style="info" %}
Mandatory string parameters must contain at least one character.
{% endhint %}

For example, the fields `title` and `titleLocalized` in a listing must contain at least one character:

```json
"titleLocalized": {
  "en_US": "US title"
}
```

Requests that include mandatory parameters with fewer than one character will fail.

## Pagination

Pagination in fulfillmenttools enables efficient handling of large datasets when searching for entities, such as stocks. Instead of returning all results in a single response, the system divides them into smaller, manageable pages. Each search response includes a `pageInfo` object with cursors and flags (for example, `hasNextPage` and `endCursor`) that indicate whether additional results are available. These values can be applied to request subsequent pages until all records are retrieved.

### Iterating over multiple pages

When reading several entities that don't fit on a single page, it's necessary to iterate over multiple pages of search results to collect all required information. An example is iterating over pages to get the `id` and `version` of all entities for an update.

#### Search entities with pagination

The search endpoints return paginated responses. Each response includes a `pageInfo` object that indicates whether additional pages are available.

For example:

{% tabs %}
{% tab title="POST request" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/stocks/search
```

{% endtab %}

{% tab title="Body request" %}

```json
{
  "query": {
    "tenantArticleId": {
      "eq": "4242"
    }
  }
}
```

{% endtab %}

{% tab title="JSON response" %}

```json
{
    "total": 28,
    "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": false,
        "startCursor": "MDBhZjE1NzEtMjg5MC00ZTE0LTg1OTEtOWVjZjEyODYzMjIw",
        "endCursor": "YjljYTkwZDMtYWEyMC00MmIyLTlmMmItMDk5ZTIxNWFhZGU0"
    },
    "stocks": [
        {
            "created": "2025-11-06T13:11:35.738Z",
            "facilityRef": "d083f631-9f4c-463b-85d4-9414fb19239f",
            "id": "00af1571-2890-4e14-8591-9ecf12863220",
            "lastModified": "2025-11-26T07:54:35.624Z",
            "tenantArticleId": "4242",
            "value": 100,
            "locationRef": "SL-02",
            "scannableCodes": [],
            "scores": [...],
            "tenantStockId": null,
            "reserved": 0,
            "facilityWideReserved": 0,
            "available": 111,
            "traits": [
                "PICKABLE",
                "ACCESSIBLE"
            ],
            "traitConfig": null,
            "conditions": null,
            "properties": {},
            "serializedProperties": "{}",
            "receiptDate": "2025-11-16T07:46:16.215Z",
            "version": 2,
            "customAttributes": null,
            "availableUntil": null,
            "reservations": [],
            "combinedId": "d083f631-9f4c-463b-85d4-9414fb19239f_11111",
            "facility": {
                "facilityRef": "d083f631-9f4c-463b-85d4-9414fb19239f"
            }
        },
        {
            "created": "2025-11-10T13:19:15.624Z",
            "facilityRef": "d083f631-9f4c-463b-85d4-9414fb19239f",
            "id": "019a6deb-b698-7510-b7a2-ee891d09b1a7",
            "lastModified": "2025-11-10T13:19:15.624Z",
            "tenantArticleId": "4242",
            "value": 10,
            "locationRef": "SL-01",
            "scannableCodes": [],
            "scores": [...],
            "tenantStockId": null,
            "reserved": 0,
            "facilityWideReserved": 0,
            "available": 10,
            "traits": [
                "PICKABLE",
                "ACCESSIBLE"
            ],
            "traitConfig": null,
            "conditions": null,
            "properties": {},
            "serializedProperties": "{}",
            "receiptDate": "2023-06-16T07:42:54.646Z",
            "version": 1,
            "customAttributes": null,
            "availableUntil": null,
            "reservations": [],
            "combinedId": "d083f631-9f4c-463b-85d4-9414fb19239f_11111",
            "facility": {
                "facilityRef": "d083f631-9f4c-463b-85d4-9414fb19239f"
            }
        },
        ...
    ]
}
```

{% endtab %}
{% endtabs %}

* The entity array (in this example, `stocks`) contains the records, including `id` and `version`.
* The `pageInfo` object provides cursors and flags (`hasNextPage`, `hasPreviousPage`) to navigate through results.

#### Page iteration

To retrieve all entities, iterate through the pages until `hasNextPage` is `false`.

Example workflow:

{% stepper %}
{% step %}
**Send the initial search request**
{% endstep %}

{% step %}
**Collect the `id` and `version` values from the entity array**
{% endstep %}

{% step %}
**Check the `pageInfo.hasNextPage`**

* If `true`, send another request using the `endCursor` value as the starting point for the next page
* If `false`, all results have been retrieved
  {% endstep %}
  {% endstepper %}

## Data update guarantees

### Strong consistency

Each resource provides read-after-write consistency for the same entity endpoint. This ensures that when a client updates an entity, the system makes the changes immediately available in the response and for subsequent queries to the same endpoint for that entity.

{% tabs %}
{% tab title="REST API" %}
**Example:** The fulfillmenttools `REST API` provides this guarantee. If a client updates facility details via `POST /api/facilities/{ID}` and waits for the response, a subsequent `GET /api/facilities/{ID}` query will immediately reflect the updated state. However, a read of all facilities using `GET /api/facilities/` does not guarantee that the updated facility's details will be instantly reflected, as list views or aggregated views of data may rely on eventual consistency. This restriction explicitly includes reads with specific filters or pagination parameters.
{% endtab %}

{% tab title="GraphQL API" %}
**Example**: In the GraphQL API, read-after-write consistency is guaranteed for **root-level fields** when querying an entity by its ID. For instance, if a facility's details are updated using a mutation:

```graphql
mutation {
  updateFacility(input: { id: "123", ... }) { ... }
}
```

A subsequent query for the same facility will immediately reflect the updated state:

```graphql
query {
  facilityV2(id: "123") { ... }
}
```

However, a query for all facilities does **not guarantee** that the updated facility's details will be instantly reflected, as list views or aggregated views of data may rely on eventual consistency. This restriction explicitly includes reads with specific filters or pagination parameters.
{% endtab %}
{% endtabs %}

### Eventual consistency

Following an update, some changes are not immediately visible in client applications (especially mobile and web clients). For example, shipment creation is an asynchronous process. While updating the shipment resource itself provides read-after-write consistency, the platform delays updating its visibility in the respective client applications. Additionally, eventual consistency is guaranteed for any list views of data, such as a list of facilities.

These delayed updates provide an eventual consistency guarantee, meaning the changes become visible after a short delay. The length of this delay can vary depending on the amount of data to be processed. The system is designed to keep these delays to a minimum.

### Optimistic concurrency control (optimistic locking)

Many API resources use optimistic concurrency control to prevent lost updates when multiple clients concurrently modify data. These resources have a version attribute. When sending an update, the client must include the resource's last known version in the request. After a successful update, the HTTP response body contains the new version of the resource.

Background processes and other system events can update a resource and change its version number without an API client sending a request to that resource. The version number is not guaranteed to increase sequentially.

{% hint style="warning" %}
To ensure that updates are applied to the most recent state, the latest version of an entity should be retrieved before each update.
{% endhint %}

The API doesn't use `ETag` and `If-Match` HTTP headers to control optimistic concurrency. Instead, it returns a `409 HTTP status (Conflict)` error if a version mismatch occurs.


# Authentication and authorization

Authentication and authorization ensure secure access to fulfillmenttools. This article explains how tokens are issued, how they are used in requests, how they can be refreshed, and how roles and permissions control access.

## Authentication

{% hint style="info" %}
More authentication information is available on the [Google Identity Toolkit API website](https://cloud.google.com/identity-platform/docs/reference/rest).
{% endhint %}

fulfillmenttools is secured using an external Identity Provider (Google Identity Toolkit). This provider issues JSON Web Tokens (JWT) in exchange for a valid username and password. The JWT encodes attributes such as the username, role, and assigned facility. Authorization against the API requires including the issued JWT in every request as an HTTP header.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FEgvciBIHAQb5WKNmcAe4%2FDiagram%20showing%20a%20client%20requesting%20a%20JWT.png?alt=media&amp;token=b4c2ed0e-848d-45b9-81b4-da4c6fe0d757" alt=""><figcaption></figcaption></figure>

### Providing the JWT

All authenticated requests must include the following header:

```yaml
Authorization: Bearer {YOUR_ID_TOKEN}
```

### Authentication request

To retrieve an authentication token for a user, send an HTTP `POST` request:

```bash
POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key={authKey}
```

```json
{
    "email": "philippa.bison@ocff-nerdherd-pre.com",
    "password": "myPassword",
    "returnSecureToken": true
}
```

* `authKey`, `email`, and `password` must be valid for the fulfillmenttools instance.
* The email address must follow the format: `{USERNAME}@ocff-{PROJECT_ID}-{ENVIRONMENT}.com` (you should have received this via email on set up, [contact our Support team](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1) if you don't have this information).
* The identity platform enforces a rate limit of 2000 logins per 60 seconds. This limit can be raised if required.
* Additional rate limits apply to calls for new tokens based on username and password ([see Google Identity Platform Quotas](https://cloud.google.com/identity-platform/quotas)).

Caching and sharing tokens between function invocations may be necessary in connector implementations to avoid exceeding quotas.

### Authentication response

A successful response is similar to the following example:

```json
{
  "kind": "identitytoolkit#VerifyPasswordResponse",
  "localId": "jdwBuqqYWdYoqWTH1Xv85EJJMpm2",
  "email": "philippa.bison@ocff-nerdherd-pre.com",
  "displayName": "Philippa Bison",
  "idToken": "eyJhbGciOiJSUzI1NiIsImtpZ...ynLgbiNgHJJxtBXSTSFnp2fA",
  "registered": true,
  "refreshToken": "AE0u-NeGDdHWPB0RjOYO...pRMKoncagBq30OFCJkEgpvyI",
  "expiresIn": "3600"
}
```

Key attributes:

1. The `idToken` is the JWT that must be sent with every `REST` call to the `fulfillmenttools` API. It has an expiration period defined by the `expiresIn` attribute, which is 3600 seconds in this example. After this period, a new token must be requested.
2. The `refreshToken` should be used to obtain a new token without providing the user credentials again.

{% hint style="warning" %}
Every call to the fulfillmenttools API must include the JWT in an Authorization-Bearer header.
{% endhint %}

### Token refresh

To refresh a token, send an HTTP `POST` request:

```http
POST https://securetoken.googleapis.com/v1/token?grant_type=refresh_token&refresh_token={refreshToken}&key={authKey}
```

## Integration hints for serverless integration

The integration may run in a serverless context and is often subscribed to a message queue, which gives updates to an entity that should be updated at fulfillmenttools.

Let's assume that this queue publishes listing updates, and the integration needs to update the corresponding listing in fulfillmenttools.

In a serverless infrastructure, typically, no shared database or memory is present to share JWT tokens. Therefore, for each listing update, the function needs to obtain a token and then perform the listing update. This can cause issues if implemented naively, since the [Google Identity Platform - Quotas](https://cloud.google.com/identity-platform/quotas) limitations apply.

{% hint style="warning" %}
Overall, the identity platform enforces a rate limit of 2000 logins in 60 seconds. This limit can be raised if needed.
{% endhint %}

### Option 1: Best practice

If you use an external IDP (recommended), you can use the client credentials flow and use this token to authenticate via `signInWithIdp`. See [Client-Credential-Flow with IdP](https://docs.fulfillmenttools.com/documentation/integrations/openid-connect/client-credential-flow-with-external-idp) for a detailed explanation. This approach prevents the per-user limit from affecting your usage.

### Option 2: Iterate over multiple users

Due to the limitations of the Google Identity Platform ([Google Identity Platform - Quotas](https://cloud.google.com/identity-platform/quotas)), users cannot log in multiple times in parallel. After making several token requests, you may encounter quota errors while trying to obtain a token.

To address this issue, we recommend creating multiple user accounts (for example, 20) and randomly selecting one of these users to request the token. This approach helps distribute the load across different users, preventing any single user's limit from being exceeded.

## Authorization

fulfillmenttools provides a preconfigured roles and permissions system. A valid authentication is required before authorization is applied. Roles determine which data a user can access. Custom roles can also be created. Permissions define individual actions within the system, such as editing users or creating orders. See the [User management article](https://docs.fulfillmenttools.com/documentation/products/core/user-management) for details.

REST endpoints require specific permissions to be accessed. Endpoints are annotated with required permissions in the OpenAPI specification.

```yml
openapi: 3.0.0
info:
  title: Stock API
  version: 1.0.0
paths:
  /api/stocks:
    post:
      operationId: createStock
      summary: Create a stock
      deprecated: false
      description: ""
      x-fft-permissions:
        - STOCK_WRITE
        - STOCK_READ
```


# User management

The user management system controls access and permissions within fulfillmenttools through three interconnected components:

* **Users**: Individual accounts requiring system access
* **Roles**: Collections of permissions defining system capabilities
* **Permissions**: Specific actions and system access rights

The system operates on a role-based access control (RBAC) model where users receive permissions through role assignments rather than direct permission grants.

## Core concepts

### Users, roles, and permissions

**Users** represent individual accounts within fulfillmenttools requiring access to functionality.

**Roles** define collections of permissions that correspond to specific job functions or responsibility levels. Common role examples include:

* Supervisor
* Fulfiller
* Administrator
* Read-Only Viewer

**Permissions** specify individual actions that can be performed within fulfillmenttools, such as:

* Edit users
* Create orders
* View analytical data
* Modify facility settings

**Permission assignment model**

```
User → assigned → Role → contains → Permissions → allow access to → Functions
```

{% hint style="info" %}
Permissions are assigned to roles exclusively. Users can't receive direct permission assignments outside of role membership.
{% endhint %}

{% hint style="warning" %}
If users with a certain role should have access to one of the following [Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/network-view) views, the permission `REMOTE_CONFIG_READ` is required:

[Routing](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/routing), [Orders](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders), [Returns](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/returns), [Storage locations](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones), [Inbound](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/inbound)
{% endhint %}

### Context limitations

Context limitations restrict the scope of permission application within fulfillmenttools. When a user possesses a specific permission, context limitations define the subset of entities to which that permission applies.

**Example:** A user with "Edit facilities" permission and a facility context limitation for the North region can only edit facilities within that specific region.

#### **Available context types**

**Facility context**

* Restricts access to entities associated with specified facilities
* Example: "Edit pick job" permission combined with Facility context for "Facility A" limits editing to pick jobs associated with Facility A exclusively

**Facility group context**

* Restricts access to entities linked to specific facility groups rather than individual facilities.
* If both **Facility** and **Facility Group** contexts are applied, access is granted when the facility belongs to **either** context (logical **OR**).
* Example: The "Edit pick job” permission with a Facility Group Context for Facility Group A allows editing only for pick jobs associated with facilities within Facility Group A.

**User role context**

* Restricts user management capabilities to specified roles
* Limits both the users that can be managed (based on their role assignments) and the roles that can be assigned to other users
* Example: "Assign Roles" permission with User Role context for "Manager, Supervisor" restricts user management to users possessing Manager or Supervisor roles and limits role assignments to those same roles

### Context limitation implementation: Role versus user level

Context limitations can be implemented at two distinct levels within the system:

#### Role-level context limitation

When context limitations are defined at the role level, all users assigned to that role inherit identical limitations.

**Example:**

* Role: "Regional Manager"
* Facility Context: Restricted to "North Region Facilities"
* Result: All users assigned the Regional Manager role can access North Region facilities exclusively

#### User-level context limitation

When a role contains no predefined context limitation of a given type, specific limitations of that type can be applied during individual user role assignments.

**Example:**

* Role: "Facility Manager" (no predefined facility context limitations)
* User Assignment for John: Facility context restricted to "Facility A"
* User Assignment for Sarah: Facility context restricted to "Facility B"
* Result: John manages Facility A exclusively, Sarah manages Facility B exclusively

#### Implementation rules

* Roles with defined context limitations apply those limitations to all assigned users
* Roles without context limitations allow for customized limitations during user assignment
* Role-level context limitations can't be overridden at the user assignment level
* Context limitations defined at role assignment apply only to that specific user

## Multiple role assignments

Users can be assigned multiple roles simultaneously. Each role maintains its context limitations independently, creating flexible permission structures.

#### Multiple role example

A user assigned two roles:

1. **"Pick Job Viewer"** (no context limitations) → grants pick job viewing across all facilities
2. **"Pick Job Editor"** with Facility context limited to "Facility A" → grants pick job editing for Facility A exclusively

**Resulting Access:** The user can view pick jobs from all facilities but can edit pick jobs in Facility A only.

#### Multiple role behavior

* Each role preserves its individual context limitations
* User permissions represent the union of all assigned role permissions
* Context limitations apply individually to each role's permission set
* This enables sophisticated access patterns such as unrestricted read access with restricted modification rights

**Example**

In the example below, the user is assigned two roles "Pick Job Viewer" and "Pick Job Editor". Additionally, each role assignment has context limitations. Thus, the user can view and edit pick jobs in facility B but only view pick jobs in facility A.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FhpEealL5YAJSA8mZsB8l%2Fimage.png?alt=media&amp;token=aa660b7c-620b-4071-9480-2e14bf707721" alt="" width="375"><figcaption></figcaption></figure>

## User management operations

### User creation

**Required Permission:** `USER_WRITE`

**Creation requirements:**

* Username must be unique across the system
* Special characters undergo automatic conversion (ö → oe, ß → ss)
* Password minimum length:
  * 6 characters for Fulfiller role
  * 9 characters for Supervisors and Custom roles
  * 12 characters for Administrators
* Supervisors, Administrators, and Custom roles also has a check against a breached-password database to block commonly used or compromised passwords.
* Primary language assignment is optional

{% hint style="info" %}
**Context inheritance requirement:** Users with context limitations can only create users with equal or more restrictive limitations. Newly created users can't receive broader access than their creator possesses.
{% endhint %}

The password policy settings can be configured if needed. The breached-password database check can be added to all roles or removed. You can also set the minimum length required for each role. To do this, contact us using [a service request](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11). However, we strongly recommend keeping the default settings or increasing them only.

{% hint style="info" %}
To use Single Sign On (SSO), see the [OpenID Connect article](https://docs.fulfillmenttools.com/documentation/integrations/openid-connect).
{% endhint %}

### User modification and deletion

**Required permission:** `USER_MODIFY`

**Modification capabilities:**

* Role assignment changes
* User account property updates
* Permission revocation through role removal

**Automatic responses:**

* Edited users face immediate session termination, if their password or roles were changed
* Active tasks (such as pick jobs) are reset and returned to the available task pool

**Deletion rules:**

* Users with appropriate permissions can delete other user accounts

### Role assignment operations

**Required permission:** `USER_MODIFY` (not restricted to administrators)

**Assignment constraints:**

* Role assignments must comply with the assigning user's context limitations
* Assigned users cannot receive broader access than the assigning user possesses
* Facility context example: Users limited to "Facility A" can only assign roles with "Facility A" limitation or more restrictive access

## Role management operations

### Custom role creation

**Required permission:** `ROLE_WRITE`

**Role categories:**

* **Preconfigured roles:** fulfillmenttools-defined roles with fixed permissions (modification and deletion prohibited)
* **Custom roles:** Administrator-defined roles with configurable permission sets

### **Role management rules**

* Role names must be unique fulfillmenttools-wide
* Permission modifications take immediate effect for all users assigned to the role (propagation may require up to 5 minutes)
* Role deletion is permitted only when no users are currently assigned to the role

### Role configuration best practices

1. Begin with minimal required permissions
2. Test custom roles with limited user assignments before broader deployment
3. Implement descriptive naming conventions indicating role purpose
4. Maintain documentation for custom role use cases and intended applications

## Security and privilege escalation prevention

### Context inheritance rule

Role assignments must maintain or increase restriction levels relative to the assigning user's context limitations.

**Permitted Operations:**

* User with "Facility A, Facility B" access assigns role with "Facility A, Facility B" or "Facility A" limitation

**Prohibited Operations:**

* User with "Facility A" access assigns role without facility limitations or with broader facility access

### USER\_MODIFY permission security considerations

The `USER_MODIFY` permission grants extensive role assignment capabilities, including administrator-level role assignments.

**Recommended security measures:**

* Implement User Role context limitations on roles containing `USER_MODIFY` permission
* Define specific assignable roles through context limitations
* Exclude administrator roles from assignable role lists when appropriate

**Security implementation example:**

* Role: "Human Resources Manager"
* Permissions: Includes `USER_MODIFY`
* User Role Context: Limited to "Employee, Supervisor, Team Lead"
* Security Result: User management capabilities without administrator creation privileges

## System reference

#### Permission hierarchy structure

<pre><code><strong>Functions
</strong>    ↑ (access controlled by)
Permissions
    ↑ (organized within)
Roles
    ↑ (assigned to)
Users
</code></pre>

#### Context limitation processing flow

```
Role definition → Context limitation status assessment
    ↓ No limitations: Individual user assignment customization available
    ↓ Limitations defined: Applied uniformly to all role assignments
User role assignment → Context application
    ↓
Permission activation → Within defined context boundaries
```

#### Common issue resolution

**Insufficient access despite appropriate permissions**

* Verify context limitations - permissions may exist but apply to different entity subsets

**Role assignment failures**

* Confirm context limitations match inheritance requirements
* Verify possession of USER\_MODIFY permission
* Check User Role context limitations for target role inclusion

**Role permission changes not effective**

* Allow up to 5 minutes for fulfillmenttools-wide permission propagation
* Consider user session refresh requirements for certain permission types

## System summary

The user management system provides comprehensive access control through:

1. **Role-based permission grouping** for organized access management
2. **Context limitation framework** for granular access restriction
3. **Flexible assignment options** enabling role customization per user
4. **Multiple role support** facilitating complex permission requirements
5. **Security enforcement mechanisms** preventing unauthorized privilege escalation

These components combine to create a robust access control system capable of supporting diverse organizational security requirements while maintaining operational flexibility.

The user management enables the allocation of roles to users, thereby facilitating the control of permissions for various actions and access within the platform. Users have the option of either using preconfigured roles with static rights or creating custom roles with individual rights.

## Create user

To create a new user, send a `POST` request to the `/api/users` endpoint.

`POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/users`

```json
{
    "firstname": "Philippa",
    "lastname": "Bison",
    "username": "Philippa Bison",
    "password": "fsdf6556",
    "roles": [
        {
            "name": "FULFILLER",
            "facilities": [
                "0AMSoRCbm7kSM3LJPoeH"
            ]
        }
    ]
}
```

A successful request returns a `201 Created` response with the newly created user object.

```json
{
    "id": "x5jrZrDHvYYs6HpaDICKYG4QuIk2",
    "username": "Philippa Bison",
    "firstname": "Philippa",
    "lastname": "Bison",
    "customClaims": {
        "roles": [
            {
                "name": "FULFILLER",
                "facilities": [
                    "0T1vKaEar0nuG58CxzA5"
                ]
            }
        ]
    },
    "created": "2020-09-25T10:06:35.000Z",
    "lastModified": "2020-09-25T10:06:35.009Z",
    "version": 1
}
```

## Modify user

To modify an existing user, for example to assign a new role, send a `PATCH` request to the user's endpoint with a `ModifyUser` action.

```http
PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/users/{USER_ID_TO_EDIT}
```

```json
{
    "actions": [
        {
            "action": "ModifyUser",
            "roles": [
                {
                    "name": "SUPERVISOR",
                    "facilities": [
                        "0T1vKaEar0nuG58CxzA5"
                    ]
                }
            ]
        }
    ],
    "version": 1
}
```

A successful request returns a `200 OK` response with the updated user object.

```json
{
    "id": "x5jrZrDHvYYs6HpaDICKYG4QuIk2", 
    "username": "Philippa Bison",
    "firstname": "Philippa",
    "lastname": "Bison",
    "customClaims": {
        "roles": [
            {
                "name": "SUPERVISOR",
                "facilities": [
                    "0T1vKaEar0nuG58CxzA5"
                ]
            }
        ]
    },
    "created": "2020-09-25T10:06:35.000Z",
    "lastModified": "2030-10-01T09:12:22.000Z",
    "version": 2
}
```

## Delete user

{% hint style="danger" %}
When a user is deleted, all currently active **JSON Web Tokens (JWTs)** for that user are invalidated.
{% endhint %}

```http
DELETE https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/users/{USER_ID_TO_DELETE}
```


# User endpoints

## The User object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"}}}}
```

## The Role object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Role":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contextLimitations":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contexts":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"created":{"description":"The date when the role was created.","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the role, which can be used to store additional information.","type":"object"},"description":{"description":"The description of the role, which provides more details about its purpose.","maxLength":100,"type":"string"},"displayName":{"description":"The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).","maxLength":50,"type":"string"},"lastModified":{"description":"The date when the role was last modified.","format":"date-time","type":"string"},"name":{"description":"The name of the role, which must be unique and is used to identify the role.","maxLength":20,"minLength":3,"type":"string"},"permissions":{"description":"The permissions associated with the role, which define what actions the role can perform.","items":{"enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","OPERATIONS_VALIDATION_READ","OPERATIONS_VALIDATION_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","ADMIN_INTER_FACILITY_CONNECTION_MIGRATION","ADMIN_ROUTING_PLAN_ANALYSIS","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE","PRODUCT_READ","PRODUCT_WRITE"],"type":"string"},"maxItems":500,"type":"array"},"version":{"description":"The version of the role.","type":"number"}},"required":["name","permissions","version","created","lastModified"],"title":"Role","type":"object","description":"Role"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"}}}}
```

## GET /api/users/{userId}

> Return user

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users/{userId}":{"get":{"deprecated":false,"description":"","operationId":"getUser","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"The user."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Return user","tags":["User management"]}}}}
```

## Get user roles

> Returns the roles of a user.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users/{userId}/permissions":{"get":{"deprecated":false,"description":"Returns the roles of a user.","operationId":"getUserRoles","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The roles of the user."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get user roles","tags":["User management"]}}}}
```

## GET /api/users

> List users

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users":{"get":{"deprecated":false,"description":"","operationId":"getAllUsers","parameters":[{"description":"The number of items to return.","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"number"}},{"description":"The ID of the last item from the previous page. The next page will start after this ID.","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"Order the users by this field","in":"query","name":"orderBy","required":false,"schema":{"type":"string"}},{"description":"Filter the users by this facility","in":"query","name":"facilityId","required":false,"schema":{"type":"string"}},{"description":"Include all admins in the result (only applicable if facilityId is set)","in":"query","name":"includeAdminUsers","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"The users were successfully returned."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"List users","tags":["User management"]}}}}
```

## DELETE /api/users/{userId}

> Delete user

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users/{userId}":{"delete":{"deprecated":false,"description":"","operationId":"deleteUser","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The deleted user."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Delete user","tags":["User management"]}}}}
```

## PATCH /api/users/{userId}

> Update user

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserPatchActions":{"properties":{"actions":{"description":"The actions to perform","items":{"$ref":"#/components/schemas/ModifyUserAction"},"maxItems":5,"type":"array"},"version":{"description":"The version of the user to modify","type":"number"}},"required":["actions","version"],"title":"UserPatchActions","type":"object","description":"UserPatchActions"},"ModifyUserAction":{"properties":{"action":{"allOf":[{"$ref":"#/components/schemas/UserActionEnum"}],"description":"The type of action to perform"},"assignedFacilities":{"deprecated":true,"description":"Deprecated: Use assignedRoles with contextLimitation of type FACILITY instead","items":{"$ref":"#/components/schemas/UserAssignedFacilityForCreation"},"type":"array"},"assignedRoles":{"description":"The new roles of the user","items":{"$ref":"#/components/schemas/AssignedRoles"},"maxItems":100,"type":"array"},"customAttributes":{"description":"The new custom attributes of the user","nullable":true,"type":"object"},"email":{"description":"The changed email of the user","type":"string"},"firstname":{"description":"The new firstname of the user","type":"string"},"lastname":{"description":"The new lastname of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"password":{"description":"The new password of the user","type":"string"},"roles":{"deprecated":true,"description":"Deprecated: Use assignedRoles instead","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["action"],"title":"ModifyUserAction","type":"object","description":"ModifyUserAction"},"UserActionEnum":{"description":"The type of action to perform","enum":["ModifyUser"],"title":"UserActionEnum","type":"string"},"UserAssignedFacilityForCreation":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef"],"title":"UserAssignedFacilityForCreation","type":"object","description":"UserAssignedFacilityForCreation"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"},"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users/{userId}":{"patch":{"deprecated":false,"description":"","operationId":"changeUser","parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPatchActions"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"The modified user."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Update user","tags":["User management"]}}}}
```

## POST /api/users

> Creates user

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserForCreation":{"properties":{"assignedFacilities":{"description":"The assigned facilities of the user","items":{"$ref":"#/components/schemas/UserAssignedFacilityForCreation"},"type":"array"},"assignedRoles":{"description":"The roles which are assigned to the user","items":{"$ref":"#/components/schemas/AssignedRoles"},"maxItems":10,"minItems":1,"type":"array"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"email":{"description":"The email of the user","type":"string"},"firstname":{"description":"The first name of the user","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"password":{"description":"The password of the user","type":"string"},"roles":{"deprecated":true,"description":"Deprecated: Use assignedRoles instead","items":{"$ref":"#/components/schemas/UserRole"},"maxItems":1,"minItems":1,"type":"array"},"username":{"description":"The username of the user","type":"string"}},"required":["firstname","lastname","username","password"],"title":"UserForCreation","type":"object","description":"UserForCreation"},"UserAssignedFacilityForCreation":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef"],"title":"UserAssignedFacilityForCreation","type":"object","description":"UserAssignedFacilityForCreation"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"},"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users":{"post":{"deprecated":false,"description":"","operationId":"createUser","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"The users was successfully created."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Creates user","tags":["User management"]}}}}
```

## List users (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for User

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/UserSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/UserSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"UserSearchPayload","type":"object","description":"UserSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"UserSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/UserSearchQuery"},"maxItems":500,"type":"array"},"assignedFacilities":{"allOf":[{"$ref":"#/components/schemas/UserAssignedFacilitiesListFilter"}],"description":"Nested list search by assignedFacilities"},"assignedRoles":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesListFilter"}],"description":"Nested list search by assignedRoles"},"auth":{"allOf":[{"$ref":"#/components/schemas/UserAuthFilter"}],"description":"Nested search by auth"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsFilter"}],"description":"Nested search by customClaims"},"facilityLimitations":{"allOf":[{"$ref":"#/components/schemas/StringListExistsFilter"}],"description":"Search by facilityLimitations"},"firstname":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstname"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"lastname":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastname"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/UserSearchQuery"},"maxItems":500,"type":"array"},"username":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by username"}},"title":"UserSearchQuery","type":"object","description":"UserSearchQuery"},"UserAssignedFacilitiesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedFacilitiesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedFacilitiesListFilter","type":"object","description":"UserAssignedFacilitiesListFilter"},"UserAssignedFacilitiesFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"}},"title":"UserAssignedFacilitiesFilter","type":"object","description":"UserAssignedFacilitiesFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"UserAssignedRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesListFilter","type":"object","description":"UserAssignedRolesListFilter"},"UserAssignedRolesFilter":{"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextListFilter"}],"description":"Nested list search by context"},"contextLimitations":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsListFilter"}],"deprecated":true,"description":"Deprecated: Use context field instead"},"ref":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ref"}},"title":"UserAssignedRolesFilter","type":"object","description":"UserAssignedRolesFilter"},"UserAssignedRolesContextListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextListFilter","type":"object","description":"UserAssignedRolesContextListFilter"},"UserAssignedRolesContextFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextFilter","type":"object","description":"UserAssignedRolesContextFilter"},"UserAssignedRolesContextContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextContextTypesEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"UserAssignedRolesContextLimitationsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextLimitationsListFilter","type":"object","description":"UserAssignedRolesContextLimitationsListFilter"},"UserAssignedRolesContextLimitationsFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextLimitationsFilter","type":"object","description":"UserAssignedRolesContextLimitationsFilter"},"UserAssignedRolesContextLimitationsContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextLimitationsContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextLimitationsContextTypesEnumFilter"},"UserAuthFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAuthAuthenticationProviderTypeEnumFilter"}],"description":"Search by type"}},"title":"UserAuthFilter","type":"object","description":"UserAuthFilter"},"UserAuthAuthenticationProviderTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"}},"title":"UserAuthAuthenticationProviderTypeEnumFilter","type":"object","description":"UserAuthAuthenticationProviderTypeEnumFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"UserCustomClaimsFilter":{"properties":{"roles":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesListFilter"}],"description":"Nested list search by roles"}},"title":"UserCustomClaimsFilter","type":"object","description":"UserCustomClaimsFilter"},"UserCustomClaimsRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserCustomClaimsRolesListFilter","type":"object","description":"UserCustomClaimsRolesListFilter"},"UserCustomClaimsRolesFilter":{"properties":{"facilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilities"},"name":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesUserRoleNamesEnumFilter"}],"description":"Search by name"}},"title":"UserCustomClaimsRolesFilter","type":"object","description":"UserCustomClaimsRolesFilter"},"UserCustomClaimsRolesUserRoleNamesEnumFilter":{"properties":{"eq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"in":{"description":"Search by name","items":{"enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"}},"title":"UserCustomClaimsRolesUserRoleNamesEnumFilter","type":"object","description":"UserCustomClaimsRolesUserRoleNamesEnumFilter"},"StringListExistsFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"},"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"StringListExistsFilter","type":"object","description":"StringListExistsFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"UserSort":{"properties":{"assignedRoles":{"$ref":"#/components/schemas/UserAssignedRolesSort"},"authenticationProvider":{"$ref":"#/components/schemas/UserAuthenticationProviderSort"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"firstname":{"enum":["ASC","DESC"],"type":"string"},"lastLogin":{"enum":["ASC","DESC"],"type":"string"},"lastname":{"enum":["ASC","DESC"],"type":"string"},"username":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserSort","type":"object","description":"UserSort"},"UserAssignedRolesSort":{"properties":{"ref":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserAssignedRolesSort","type":"object","description":"UserAssignedRolesSort"},"UserAuthenticationProviderSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserAuthenticationProviderSort","type":"object","description":"UserAuthenticationProviderSort"},"UserPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"},"users":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"required":["pageInfo","users"],"title":"UserPaginatedResult","type":"object","description":"UserPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for User","operationId":"searchUser","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List users (search)","tags":["User management"]}}}}
```

## Call user action

> Executes an action to manipulate my user.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ModifyMeAction":{"properties":{"action":{"description":"The type of action to perform","enum":["ModifyMe"],"type":"string"},"firstname":{"description":"The new firstname of the user","type":"string"},"lastname":{"description":"The new lastname of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["action"],"title":"ModifyMeAction","type":"object","description":"ModifyMeAction"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ModifyMyCredentialsAction":{"properties":{"action":{"description":"The type of action to perform","enum":["ModifyCredentials"],"type":"string"},"currentPassword":{"description":"Current password for verification (required)","type":"string"},"email":{"description":"New email address (optional)","type":"string"},"password":{"description":"New password (optional)","type":"string"}},"required":["currentPassword","action"],"title":"ModifyMyCredentialsAction","type":"object","description":"ModifyMyCredentialsAction"},"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users/me/actions":{"post":{"deprecated":false,"description":"Executes an action to manipulate my user.","operationId":"executeMeAction","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ModifyMeAction"},{"$ref":"#/components/schemas/ModifyMyCredentialsAction"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"User action was successfully executed."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."}},"summary":"Call user action","tags":["User management"]}}}}
```

## Update me user

> This part of the API is deprecated. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Update my own data.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ModifyUserPersonalData":{"properties":{"firstname":{"description":"The new firstname of the user","type":"string"},"lastname":{"description":"The new lastname of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"}},"title":"ModifyUserPersonalData","type":"object","description":"ModifyUserPersonalData"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users/me":{"patch":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Update my own data.","operationId":"updateMe","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyUserPersonalData"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Updating my data was successful."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"}},"summary":"Update me user","tags":["User management"]}}}}
```

## Return effective permissions

> Returns the effective permissions of the user.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EffectivePermissionsResponse":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRoleWithPermissions"},"type":"array"},"userId":{"description":"User ID of the current user","type":"string"}},"required":["userId","roles"],"title":"EffectivePermissionsResponse","type":"object","description":"EffectivePermissionsResponse"},"UserRoleWithPermissions":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"},"permissions":{"description":"The permissions associated with the role, which define what actions the role can perform.","items":{"enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","OPERATIONS_VALIDATION_READ","OPERATIONS_VALIDATION_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","ADMIN_INTER_FACILITY_CONNECTION_MIGRATION","ADMIN_ROUTING_PLAN_ANALYSIS","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE","PRODUCT_READ","PRODUCT_WRITE"],"type":"string"},"type":"array"}},"required":["name"],"title":"UserRoleWithPermissions","type":"object","description":"UserRoleWithPermissions"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users/me/effectivepermissions":{"get":{"deprecated":false,"description":"Returns the effective permissions of the user.","operationId":"getEffectivePermissions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EffectivePermissionsResponse"}}},"description":"The effective permissions of the user."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"}},"summary":"Return effective permissions","tags":["User management"]}}}}
```


# Localization

fulfillmenttools supports localization, enabling data management in multiple languages. This article explains how to change user and fulfillmenttools locales, request specific languages, and handle localized entity fields.

## Supported languages

We currently support 16 languages, including English, Spanish, French, German, and more. The list of supported languages can be retrieved via API:

```http
GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/supportedlocales
```

## Usage

Many entities already support localization. fulfillmenttools automatically applies the target language in responses.

For example, article titles require translations during creation:

```json
"titleLocalized": {
    "en_US": "This is a very nice title",
    "de_DE": "Dies ist ein sehr schöner Titel",
    "fr_FR": "Ce titre est très sympa"
}
```

**Validation rules for localized objects:**

* Must contain at least one entry
* Keys must be valid locale codes (for example, `en_US`) adhering to the ISO 639 language code (for example, `en`) and the ISO 3166-1 country code (for example, `US`).
* Values must have a minimum length of 1

When requested via the REST API, the `title` field is automatically filled with the appropriate translation. For a German user, the response is:

```json
"title": "Dies ist ein sehr schöner Titel",
"titleLocalized": {
    "de_DE": "Dies ist ein sehr schöner Titel",
    "en_US": "This is a very nice title",
    "fr_FR": "Ce titre est très sympa"   
}
```

## Request a specific language

Language selection can be controlled in three ways:

* **User locale**: Defined in the user object and included in the Bearer token.
* **Request locale**: Specified with the `locale` query parameter.
* **Localized field**: The `*Localized` field always contains all translations.

## Fallback language

If the requested language is unavailable, fulfillmenttools applies the following fallback order:

1. Language defined in user settings
2. Default fulfillmenttools language
3. English
4. First available language for the entity
5. Non-localized field value (legacy entities only)

## Change user locale

Refer to the [Users API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/users/search) for details.

To change a user's locale, send a `PATCH` request with the new locale. After updating, refresh the authentication token to apply the change.

```http
PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/users/{userId}
```

```json
{
    "actions": [
        {
            "action": "ModifyUser",
            "locale": "de_DE"
        }
    ],
    "version": 2
}
```

## Change default locale

Refer to the [Configurations API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/locale) for details.

The default locale defines the standard language for fulfillmenttools. Update it with a `PUT` request:

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/locale
```

```json
{
    "locale": "de_DE",
    "version": 42,
    ...
}
```


# Access to fulfillmenttools APIs

There are multiple methods to make API calls with fulfillmenttools. In this article, we'll take you through making your first API calls with [Postman](#postman), [Bruno](#bruno), [Insomnia](#insomnia), [cURL](#curl), and [GraphQL](#graphql-explorer).

{% hint style="info" %}
If you're on a free trial, we suggest following our [free trial guides](https://docs.fulfillmenttools.com/documentation/using-our-free-trial/free-trial-information).
{% endhint %}

{% hint style="success" %}

#### Prerequisites

* fulfillmenttools tenant[^1] and login credentials
  {% endhint %}

If you don't have access to a tenant[^1], you'll need to ask the Administrator in your team to invite you. Once invited, you'll have access to the information below that you'll need to work with our APIs:

* API URL of your tenant[^1]
* API key (also referred to as `AUTHKEY`)
* Username
* Password

## Postman

A comprehensive [Postman](https://www.postman.com/) collection is used and frequently updated with new requests as they appear in the API. To work with the collection, follow the steps below:

{% stepper %}
{% step %}
**Import the fulfillmenttools collection to Postman**

Download the [raw GitHub file](https://raw.githubusercontent.com/fulfillmenttools/fulfillmenttools-api-reference/master/postman/fulfillmenttoolsAPI.postman_collection.json) and add it to the collection section of Postman.

{% hint style="info" %}
This collection are regularly updated. It's recommended to periodically update the local collection to get the latest changes.
{% endhint %}
{% endstep %}

{% step %}
**Create an environment**

Go to the environment section and create a new environment. Add the below to your new environment. Your `projectId` is your tenant name and can be found in the email you received from us, which will resemble `ocff-{projectID}-pre`.

<table><thead><tr><th width="298.89453125">Variable</th><th>Value</th></tr></thead><tbody><tr><td><code>projectId</code></td><td>{the project ID in the email you received}</td></tr><tr><td><code>host</code></td><td><code>https://{{projectId}}.api.fulfillmenttools.com/</code></td></tr></tbody></table>

{% hint style="info" %}
In Postman, the `{{projectId}}` is your full [tenant](https://docs.fulfillmenttools.com/documentation/getting-started/general-concepts#tenant) name.
{% endhint %}
{% endstep %}

{% step %}
**Add credentials to the Postman Vault**

Go to the Postman Vault (bottom right of the Postman screen), and add the below to your Vault. You'll find all the values in the email you received from us (if you've changed the password in Backoffice, use that password instead of the one in the email).

| Variable               | Value                                    |
| ---------------------- | ---------------------------------------- |
| `{projectId}-user`     | {the username in the email you received} |
| `{projectId}-password` | {the password in the email you received} |
| `{projectId}-api-key`  | {the API key in the email you received}  |

{% hint style="info" %}
We use the Postman Vault to store these sensitive variables to avoid syncing them to the Postman Cloud.
{% endhint %}
{% endstep %}

{% step %}
**Make your first API call to get an Auth token**

Go to the fulfillmenttools collection, select `POST Request Auth Token`, ensure your environment is selected, and click **Send**.

You should get a `200` response. If you go back to your environment settings, you'll see that an `authToken` and a `refreshToken` have been automatically created.

{% hint style="info" %}
You'll need to run the `POST Refresh Auth Token` endpoint at least every 60 minutes.
{% endhint %}
{% endstep %}
{% endstepper %}

You're now ready to use all the other calls in the Postman collection. :tada:

For example:

```http
GET https://ocff-{{projectId}}.api.fulfillmenttools.com/api/facilities
```

## Bruno

A comprehensive [Bruno](https://www.usebruno.com/) collection is used and frequently updated with new requests as they appear in the API. To work with the collection, follow the steps below:

{% stepper %}
{% step %}
**Import the fulfillmenttools collection to Bruno**

Download the [raw GitHub file](https://raw.githubusercontent.com/fulfillmenttools/fulfillmenttools-api-reference/master/bruno/fulfillmenttoolsAPI.bruno_collection.json) collection and import it to Bruno.

{% hint style="info" %}
This collection are regularly updated. It's recommended to periodically update the local collection to get the latest changes.
{% endhint %}
{% endstep %}

{% step %}
**Import the environment**

Download the example [environment](https://raw.githubusercontent.com/fulfillmenttools/fulfillmenttools-api-reference/master/bruno/Example-Environment.bruno_environment.json) and import it into Bruno. Update the below to your environment. Your `project_id` is your tenant name and can be found in the email you received from us, which will resemble `ocff-{projectID}-pre`.

<table><thead><tr><th width="298.89453125">Variable</th><th>Value</th></tr></thead><tbody><tr><td><code>host</code></td><td><code>https://{{projectId}}.api.fulfillmenttools.com/</code></td></tr><tr><td><code>project_id</code></td><td>{the project ID in the email you received}</td></tr><tr><td><code>fft_user</code></td><td>{the username in the email you received}</td></tr><tr><td><code>fft_password</code></td><td>{the password in the email you received}</td></tr><tr><td><code>fft_api_key</code></td><td>{the API key in the email you received}</td></tr></tbody></table>

{% hint style="info" %}
In Bruno, the `{{projectId}}` is your full [tenant](https://docs.fulfillmenttools.com/documentation/getting-started/general-concepts#tenant) name.
{% endhint %}
{% endstep %}

{% step %}
**Make your first API call to get an Auth token**

Go to the fulfillmenttools collection, select `POST Request Auth Token`, ensure your environment is selected, and click **Send**.

You should get a `200` response.

{% hint style="info" %}
You'll need to run the `POST Refresh Auth Token` endpoint at least every 60 minutes.
{% endhint %}
{% endstep %}
{% endstepper %}

You're now ready to use all the other calls in the Bruno collection. :tada:

For example:

```http
GET https://ocff-{{projectId}}.api.fulfillmenttools.com/api/facilities
```

## Insomnia

A comprehensive [Insomnia](https://insomnia.rest/) collection is used and frequently updated with new requests as they appear in the API. To work with the collection, follow the steps below:

{% stepper %}
{% step %}
**Import the fulfillmenttools collection to Insomnia**

Download the [raw GitHub file](https://raw.githubusercontent.com/fulfillmenttools/fulfillmenttools-api-reference/master/insomnia/fulfillmenttoolsAPI.insomnia_collection.json) collection and import it to Insomnia.

{% hint style="info" %}
This collection are regularly updated. It's recommended to periodically update the local collection to get the latest changes.
{% endhint %}
{% endstep %}

{% step %}
**Import the environment**

Download the example [environment](https://raw.githubusercontent.com/fulfillmenttools/fulfillmenttools-api-reference/master/insomnia/Example-Environment.insomnia_environment.yml) and import it into Bruno. Update the below to your environment. Your `project_id` is your tenant name and can be found in the email you received from us, which will resemble `ocff-{projectID}-pre`.

<table><thead><tr><th width="298.89453125">Variable</th><th>Value</th></tr></thead><tbody><tr><td><code>host</code></td><td><code>https://{{projectId}}.api.fulfillmenttools.com/</code></td></tr><tr><td><code>project_id</code></td><td>{the project ID in the email you received}</td></tr><tr><td><code>fft_user</code></td><td>{the username in the email you received}</td></tr><tr><td><code>fft_password</code></td><td>{the password in the email you received}</td></tr><tr><td><code>fft_api_key</code></td><td>{the API key in the email you received}</td></tr></tbody></table>

{% hint style="info" %}
In Insomnia, the `{{projectId}}` is your full [tenant](https://docs.fulfillmenttools.com/documentation/getting-started/general-concepts#tenant) name.
{% endhint %}
{% endstep %}

{% step %}
**Make your first API call to get an Auth token**

Go to the fulfillmenttools collection, select `POST Request Auth Token`, ensure your environment is selected, and click **Send**.

You should get a `200` response.

{% hint style="info" %}
You'll need to run the `POST Refresh Auth Token` endpoint at least every 60 minutes.
{% endhint %}
{% endstep %}
{% endstepper %}

You're now ready to use all the other calls in the Insomnia collection. :tada:

For example:

```http
GET https://ocff-{{projectId}}.api.fulfillmenttools.com/api/facilities
```

## cURL

cURL is one command line tool (CLI) you can use to do REST API calls. Here's an example of how it must be used for fulfillmenttools.

{% stepper %}
{% step %}
**Get an authentication token**

Open your preferred CLI and use the below input.

You'll need to add your own `AUTHKEY`, `email`, and `password`.

<pre class="language-bash" data-title="cURL authorization request"><code class="lang-bash"><strong>curl -sSL -X POST 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key={AUTHKEY}' \
</strong>--header 'content-Type: application/json' \
--data-raw '{
<strong>    "email": "{YOUR_EMAIL_ADDRESS}",
</strong><strong>    "password": "{YOUR_PASSWORD}",
</strong>    "returnSecureToken": true
}'
</code></pre>

Be sure to make note of both the `idToken` and `refreshToken` as you'll need both of these.
{% endstep %}

{% step %}
**Make an API call**

You're now ready to use all the other API calls using cURL. For example, the below will create a new facility. You'll need to replace `{projectID}` with your tenant name, and replace `{idToken}` with the authorization token from above.

{% hint style="info" %}
You must send headers for `Authorization` and `Content-Type`. Also replace `https://ocff-{projectId}.api.fulfillmenttools.com/api/facilities` with your specific host and endpoint.
{% endhint %}

<pre class="language-bash" data-title="cURL create facility example"><code class="lang-bash"><strong>curl -sSL -X POST 'https://ocff-{projectId}.api.fulfillmenttools.com/api/facilities' \
</strong><strong>--header 'Authorization: Bearer {IDTOKEN}' \
</strong>--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Nerd Herd Clothing",
  "address": {
    "companyName": "Nerd Herd Clothing",
    "country": "US",
    "postalCode": "81669",
    "city": "München",
    "street": "Lilienstr.",
    "houseNumber": "58"
  },
  "services": [
    {
      "type": "COLLECT"
    }
  ],
  "status": "ONLINE",
  "locationType": "STORE"
}'
</code></pre>

{% endstep %}
{% endstepper %}

{% hint style="info" %}
You'll need to call the `POST Refresh Auth Token` endpoint at least every 60 minutes.
{% endhint %}

## GraphQL Explorer

### fulfillmenttools GraphiQL

The official fulfillmenttools playground, powered by GraphiQL, is hosted under `https://ocff-{projectId}.graphql.fulfillmenttools.com/graphql`. It enables interactive exploration of queries and documentation. Authentication tokens must be entered in the **Headers** tab at the bottom of the page.

![](https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/7qiUfbBntH4HKB17qKzF/image)

### Altair

For in-depth query development on the fulfillmenttools GraphQL API, we recommend [Altair](https://altairgraphql.dev/), available as a browser plugin and a standalone application. We also provide a pre-request script to automatically refresh authentication tokens, similar to our Postman collection.

To start with Altair, enter your tenant's GraphQL URL in the URL bar. Note that using Altair for schema introspection won't include schema directives and lifecycle information from generated GraphQL schemas.

![](https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/KPH8ZC3IeBF54OGTl98W/image)

#### Pre-request script for Altair

The following guide shows how to set up a pre-request script in Altair.

{% stepper %}
{% step %}
**Create a new environment**

First, create a new environment for your tenant:

![](https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/CFPDYfyOGPyYWbWW8h60/image)

Fill the following information in the environment:

```json
{
  "user": "YOUR-USER-EMAIL",
  "password": "YOUR-PASSWORD",
  "host": "https://ocff-{projectId}.graphql.fulfillmenttools.com/graphql",
  "apiKey": "YOUR-API-KEY"
}
```

{% endstep %}

{% step %}
**Add the Pre-request script**

Click on the **Pre-request** tab and add the script below. Ensure you've checked the Enable pre-request script check box.

![](https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/mzPy4sks606woJQC6Gdf/image)

{% code title="Pre-request script to copy" %}

```javascript
const lastTokenCall = await altair.storage.get("lastTokenCall");
const now = new Date();
if (!lastTokenCall || now - (new Date(lastTokenCall)) > 1800000) {
  altair.log("Refreshing token...");
  var user = altair.helpers.getEnvironment('user');
  var apiKey = altair.helpers.getEnvironment("apiKey");
  var escapedPwd = altair.helpers.getEnvironment('password');
  escapedPwd = escapedPwd.replace(/\\/g, '\\\\');
  escapedPwd = escapedPwd.replace(/\'/g, '\\\'');
  escapedPwd = escapedPwd.replace(/\"/g, '\\\"');
  escapedPwd = escapedPwd.replace(/\`/g, '\\\`');
  await altair.storage.set("lastTokenCall", new Date());
  const authUrl = 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=' + apiKey
  const authResult = await fetch(authUrl, {
        "method": "POST",
        "body": JSON.stringify({
          "email": user,
          "password": escapedPwd,
          "returnSecureToken": true
        })
  }).catch((e) => altair.log(e))
  const data = await authResult.json()
  altair.helpers.setEnvironment("authToken", data.idToken, true);
  altair.helpers.setEnvironment("refreshToken", data.refreshToken, true);
}
```

{% endcode %}
{% endstep %}

{% step %}
**Adjust the Authentication header**

Click the **Set Headers** icon in the left-hand navigation.

![](https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/F1EQYiExPlaDW12EsJS1/image)

Then, adjust the authentication header to use the automatically generated token and click **Done**.

![](https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/GQnOS5gdvIZwSspPPJx6/image)

The script will automatically refresh the authentication token when it's older than 30 minutes.
{% endstep %}
{% endstepper %}

[^1]: An instance of fulfillmenttools for each customer. Each tenant works in different environments. For example, there'll be a tenant for pre-production, and one for production.


# Eventing

{% hint style="warning" %}
The fulfillmenttools eventing mechanism doesn't guarantee event ordering. The same event can be emitted multiple times.
{% endhint %}

Eventing notifies external systems about business events, such as an order being routed or a pick job being completed. Events are phrased in the past tense because they describe actions that have already occurred.

Eventing is available for a callback URL, the [Microsoft Azure Service Bus](https://learn.microsoft.com/en-gb/azure/service-bus-messaging/), and [Google Cloud Pub/Sub](https://docs.cloud.google.com/pubsub/docs/overview).

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F21dHoHfqJceCZnmBCOuc%2FEvent%20diagram.png?alt=media&amp;token=b91c5a79-2eca-4b2b-8ecd-c4789676075c" alt=""><figcaption></figcaption></figure>

## Timing

Events are the primary mechanism for decoupling services within a distributed system. The time from publication on the message bus to delivery to a subscription is typically a few milliseconds to several seconds. In worst-case scenarios, such as when backend services are scaling up, this process can take up to 30 seconds.

The following diagram shows the typical timing of events originating from fulfillmenttools to an external system:

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F6rq1ao1kDGs6TSX1hH3A%2FEventing%20timing.png?alt=media&amp;token=1461da38-4030-4b5a-b534-96baea6ebc2c" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
**Avoid event delivery delays**

In a distributed system, it's expected that parts of the system will fail from time to time. However, when you run a service that serves as an endpoint for subscriptions, you must monitor its availability and return codes to ensure events are delivered on time.

Services returning a `200 OK` response are considered error-free.
{% endhint %}

## Receiving events

For all [Available events](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events), subscriptions can be created using the eventing API to receive notifications.

{% hint style="info" %}
For production environments, we strongly recommend using **Google Cloud Pub/Sub** or **Microsoft Azure Service Bus** instead of **Webhook** subscriptions.

Message broker integrations provide improved reliability and resilience because the messaging platform can absorb temporary outages of consumer systems. They also typically achieve lower, more consistent event delivery latency than HTTP-based webhook endpoints.

Webhook subscriptions are best suited for testing, evaluation, or simple integrations, while Pub/Sub and Azure Service Bus are the recommended options for business-critical event processing.
{% endhint %}

{% hint style="success" %}

#### Prerequisites

* Access to your company's tenant (`projectId` and credentials)
* Have an Administrator role
  {% endhint %}

{% hint style="warning" %}

#### Limitations

For any single event, such as `ORDER_CREATED`, a maximum of five subscriptions can be created.
{% endhint %}

In the example below, we'll set up a subscription for the order created event in [Postman](https://docs.fulfillmenttools.com/documentation/getting-started/access-to-fulfillmenttools-apis#postman).

{% stepper %}
{% step %}
**Set up your preferred provider**

Use the tabs below to select the relevant provider instructions needed for setup:

{% tabs %}
{% tab title="Microsoft Azure Service Bus" %}
To publish fulfillmenttools messages to Microsoft Azure Service Bus in a target system, a few settings must be configured in the target system:

1. Register an application in **Microsoft Entra ID** and save the **Application (Client) ID** and **Directory (Tenant) ID**.
2. Create a client secret (in **Certificates & secrets**) for the new application and save its **Value**.
3. Create an Azure Service Bus namespace and save the **namespace name**.
4. Configure **Access control (IAM)**, which stands for Identity and Access Management, for the Service Bus. Assign the **Service Bus Sender** role to the application created in step 1.
5. Create a **Queue** or **Topic** within the namespace.

The following values are then used for the subscription API call in fulfillmenttools:

* **Directory (Tenant) ID** corresponds to `tenantId`.
* **Application (Client) ID** corresponds to `clientId`.
* **Value of application secret** corresponds to `clientSecret`.
* **Namespace name** corresponds to `namespace`.
* **Queue or Topic name** corresponds to `queueOrTopicName`.
  {% endtab %}

{% tab title="Google Cloud Pub/Sub" %}
To publish fulfillmenttools messages to Google Cloud Pub/Sub in a target system, the following must be configured:

1. Define the topic where messages will be published.
2. In the topic's permissions, add the `fulfillmenttools` service account `ocff-event-function@{YOUR-TENANT-NAME}.iam.gserviceaccount.com` as a `principal` with the `Pub/Sub Publisher` role.

The following values are then used for the subscription API call in fulfillmenttools:

* **Google Cloud project id** corresponds to `projectId`.
* **Google Cloud Pub/Sub topic id** corresponds to `topicId`.
  {% endtab %}

{% tab title="Webhook" %}
{% hint style="info" %}
For production environments, we strongly recommend using **Google Cloud Pub/Sub** or **Microsoft Azure Service Bus** instead of **Webhook** subscriptions.
{% endhint %}

Visit [webhook.site](https://webhook.site/) to generate a unique URL for testing and change the response code to simulate failing requests.

The following values are then used for the subscription API call in fulfillmenttools:

**GET url** corresponds to `callbackURL`.
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
**Access the endpoint**

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/subscriptions
```

{% hint style="info" %}
If you're using the [Postman collection](https://docs.fulfillmenttools.com/documentation/getting-started/access-to-fulfillmenttools-apis#postman), you can select the relevant provider for this endpoint.
{% endhint %}
{% endstep %}

{% step %}
**Register the event**

Update the body parameters with the relevant settings you created in step one for your provider.

{% tabs %}
{% tab title="Microsoft Azure Service Bus" %}

<pre class="language-json" data-title="Body"><code class="lang-json">{
    "name": "Order created (Microsoft Azure Service Bus)",
    "event": "ORDER_CREATED",
    "target": {
        "type": "MICROSOFT_AZURE_SERVICE_BUS",
        "tenantId": "tenantId",
<strong>        "clientId": "clientId",
</strong><strong>        "clientSecret": "clientSecret",
</strong><strong>        "namespace": "namespace",
</strong><strong>        "queueOrTopicName": "queueOrTopicName"
</strong>    }
}
</code></pre>

{% endtab %}

{% tab title="Google Cloud Pub/Sub" %}

<pre class="language-json" data-title="Body"><code class="lang-json">{
    "name": "Order created (Google Cloud Pub/Sub)",
    "event": "ORDER_CREATED",
    "target": {
        "type": "GOOGLE_CLOUD_PUB_SUB",
<strong>        "projectId": "projectId",
</strong><strong>        "topicId": "topicId"
</strong>    }
}
</code></pre>

{% endtab %}

{% tab title="Webhook" %}

<pre class="language-json" data-title="Body"><code class="lang-json">{
    "name": "Order created (Webhook)",
    "event": "ORDER_CREATED",
    "target": {
        "type": "WEBHOOK",
<strong>        "callbackUrl": "callbackURL",
</strong>        "headers": [
            {
                "key": "header-key",
                "value": "header-value"
            }
        ]
    }
}
</code></pre>

{% endtab %}
{% endtabs %}

A successful request returns a `201 Created` status, and the subscription becomes active immediately.
{% endstep %}

{% step %}
**Test the notification**

Create a new test order with the following endpoint to trigger the `ORDER_CREATED` event:

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/order
```

A successful request returns a `201 Created` status, and you should receive a notification on your provider service of the order.
{% endstep %}
{% endstepper %}

You can't edit an existing subscription. To make changes, create a new subscription first, then delete the old one. To delete a subscription, use the endpoint below:

```http
DELETE https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/subscriptions/{subscriptionId}
```

{% hint style="info" %}
Deleting a subscription doesn't cancel retries for events already in the retry pipeline.
{% endhint %}

If you rotate credentials, create a new subscription and delete the old one. Our recommended procedure:

1. The receiving endpoint accepts both the old and the new credentials.
2. Create the new subscription.
3. Delete the old subscription.
4. Revoke the old credential only after the retry window has passed.

A point in time at which no event is in a retry loop can't be determined from the outside, so accepting both credentials is the safe option.

If the old and the new subscription are active at the same time and point to the same URL, each business event is delivered once per subscription. This is due to the overlap, not the retry mechanism.

Deleting the old subscription before creating the new one avoids the overlap but can leave a gap with no active subscription.

Pub/Sub delivers at least once, so receivers should deduplicate on the event ID regardless of rotation.

### Example payloads

#### Google Pub/Sub subscription

{% tabs %}
{% tab title="Subscription" %}

```
{
    "name": "Order created (Google Cloud Pub/Sub)",
    "event": "ORDER_CREATED",
    "target": {
        "type": "GOOGLE_CLOUD_PUB_SUB",
        "projectId": "ocff-myproject-prd",
        "topicId": "ext-order-created-v1"
    }
}
```

{% endtab %}

{% tab title="Pub/Sub payload" %}
{% code title="Envelope schema" %}

```
{
    "message": {
      "data": "eyJldmVudCI6Ik9SREVSX0NSRUFURUQiLCJwYXlsb2FkIjp7Im9yZGVyRGF0ZSI6IjIwMjYtMDctMjFUMDc6MDk6MzQuMzU2WiIsImNvbnN1bWVyIjp7ImFkZHJlc3NlcyI6W3sic3RyZWV0IjoiQmFobmhvZnN0cmHDn2UiLCJob3VzZU51bWJlciI6IjE4NiIsInBvc3RhbENvZGUiOiI4MDMzMSIsImNpdHkiOiJNw7xuY2hlbiIsImNvdW50cnkiOiJERSIsInBob25lTnVtYmVycyI6W3sidmFsdWUiOiIrNDkxNjM0MjEzNjM0MSIsImxhYmVsIjoicHJpdmF0ZSIsInR5cGUiOiJNT0JJTEUifV0sImFkZGl0aW9uYWxBZGRyZXNzSW5mbyI6IjEuIEV0YWdlIiwic2FsdXRhdGlvbiI6IkZyYXUiLCJwZXJzb25hbFRpdGxlIjoiIiwiZmlyc3ROYW1lIjoiRWJvbnkiLCJsYXN0TmFtZSI6IkJhdWNoIiwiZW1haWwiOiJicmF1bGlvLmtzaGxlcmluQGJyYWt1c2Nvcndpbi5kZSIsImFkZHJlc3NUeXBlIjoiUE9TVEFMX0FERFJFU1MiLCJjb29yZGluYXRlcyI6eyJsYXQiOjQ4LjEzNzE1NCwibG9uIjoxMS41NzYxMjR9LCJwcm92aW5jZSI6IkRFLUJZIn1dfSwidGVuYW50T3JkZXJJZCI6IlNhbGFkNjc1Iiwic3RhdHVzIjoiT1BFTiIsIm9yZGVyTGluZUl0ZW1zIjpbeyJhcnRpY2xlIjp7InRlbmFudEFydGljbGVJZCI6IjIwMjAyNDkiLCJ0aXRsZSI6IlQtU2hpcnQgXCJBbSBTb25uZW5odXRcIiIsImltYWdlVXJsIjoiaHR0cHM6Ly9kMzU4ZzlpbmphcnI0dS5jbG91ZGZyb250Lm5ldC9yZXMvcHJvZHVjdF8xMDAwLzI0MGVhZGQ4LThmNTAtNDc5ZC1iMGQ4LTc0NDEyYmQ0YTlmOS5qcGciLCJhdHRyaWJ1dGVzIjpbeyJjYXRlZ29yeSI6Im1pc2NlbGxhbmVvdXMiLCJrZXkiOiJCUkFORCIsInZhbHVlIjoiQWRpZGFzIiwidHlwZSI6IlNUUklORyJ9LHsiY2F0ZWdvcnkiOiJkZXNjcmlwdGl2ZSIsInByaW9yaXR5IjoxMDAsImtleSI6IiUlc3VidGl0bGUlJSIsInZhbHVlIjoiTmV1ISIsInR5cGUiOiJTVFJJTkcifSx7ImNhdGVnb3J5IjoiZGVzY3JpcHRpdmUiLCJwcmlvcml0eSI6MjAwLCJrZXkiOiJNaXRnbGllZGVycHJlaXMiLCJ2YWx1ZSI6IjE3LDk2IEVVUiIsInR5cGUiOiJTVFJJTkcifSx7ImNhdGVnb3J5IjoiZGVzY3JpcHRpdmUiLCJwcmlvcml0eSI6MzAwLCJrZXkiOiJTY2huaXR0IiwidmFsdWUiOiJGcmF1ZW4iLCJ0eXBlIjoiU1RSSU5HIn0seyJjYXRlZ29yeSI6ImRlc2NyaXB0aXZlIiwicHJpb3JpdHkiOjQwMCwia2V5IjoiTWF0ZXJpYWwiLCJ2YWx1ZSI6IjEwMCUgQmF1bXdvbGxlIiwidHlwZSI6IlNUUklORyJ9LHsiY2F0ZWdvcnkiOiJkZXNjcmlwdGl2ZSIsInByaW9yaXR5Ijo1MDAsImtleSI6IkFydGlrZWxudW1tZXIiLCJ2YWx1ZSI6IjIwMjAyNDkiLCJ0eXBlIjoiU1RSSU5HIn0seyJjYXRlZ29yeSI6ImRlc2NyaXB0aXZlIiwicHJpb3JpdHkiOjYwMCwia2V5IjoiR3LDtsOfZSIsInZhbHVlIjoiUyIsInR5cGUiOiJTVFJJTkcifSx7ImNhdGVnb3J5IjoiZGVzY3JpcHRpdmUiLCJwcmlvcml0eSI6NzAwLCJrZXkiOiJCZXNjaHJlaWJ1bmciLCJ2YWx1ZSI6IlJvdGVzIFQtU2hpcnQgbWl0IHdlacOfZW4gU3RyZWlmZW4gYW4gZGVuIMOEcm1lbG4sIEJsb2NrZHJ1Y2sgbWl0IFNjaHJpZnR6dWcgYXVmIGRlciBCcnVzdCIsInR5cGUiOiJTVFJJTkcifV19LCJxdWFudGl0eSI6MSwic2Nhbm5hYmxlQ29kZXMiOlsiMjAyMDI0OSJdLCJpZCI6IjAxOWY4MzgyLTJlNDgtNzYyYS05ZjA5LWI5YWIwYjRlNWEwNyJ9LHsiYXJ0aWNsZSI6eyJ0ZW5hbnRBcnRpY2xlSWQiOiIyMDEwNjgxIiwidGl0bGUiOiJTdGVwcGphY2tlIFwiTcO8aGxlbmJhY2hcIiIsImltYWdlVXJsIjoiaHR0cHM6Ly9kMzU4ZzlpbmphcnI0dS5jbG91ZGZyb250Lm5ldC9yZXMvcHJvZHVjdF8xMDAwLzlmY2I3ZTQyLTdjODQtNGFiMC05OTlhLTg2OWVmZTA3N2UwYS5qcGciLCJhdHRyaWJ1dGVzIjpbeyJjYXRlZ29yeSI6ImRlc2NyaXB0aXZlIiwicHJpb3JpdHkiOjEwMCwia2V5IjoiJSVzdWJ0aXRsZSUlIiwidmFsdWUiOiJOZXUhIiwidHlwZSI6IlNUUklORyJ9LHsiY2F0ZWdvcnkiOiJkZXNjcmlwdGl2ZSIsInByaW9yaXR5IjoyMDAsImtleSI6Ikdyw7bDn2UiLCJ2YWx1ZSI6IkwiLCJ0eXBlIjoiU1RSSU5HIn0seyJjYXRlZ29yeSI6ImRlc2NyaXB0aXZlIiwicHJpb3JpdHkiOjMwMCwia2V5IjoiT2JlcnN0b2ZmIiwidmFsdWUiOiIxMDAlIFBvbHllc3RlciIsInR5cGUiOiJTVFJJTkcifSx7ImNhdGVnb3J5IjoiZGVzY3JpcHRpdmUiLCJwcmlvcml0eSI6NDAwLCJrZXkiOiJGdXR0ZXIiLCJ2YWx1ZSI6IjEwMCUgUG9seWVzdGVyIiwidHlwZSI6IlNUUklORyJ9LHsiY2F0ZWdvcnkiOiJkZXNjcmlwdGl2ZSIsInByaW9yaXR5Ijo1MDAsImtleSI6IkbDvGxsdW5nIiwidmFsdWUiOiIxMDAlIFBvbHllc3RlciIsInR5cGUiOiJTVFJJTkcifSx7ImNhdGVnb3J5IjoiZGVzY3JpcHRpdmUiLCJwcmlvcml0eSI6NjAwLCJrZXkiOiJCZXNjaHJlaWJ1bmciLCJ2YWx1ZSI6IkRyZWlmYXJiaWdlIFN0ZXBwamFja2UgbWl0IHZlcnN0YXViYXJlciBLYXB1emUsIFp3ZWkgRWluZ3JpZmZzdGFzY2hlbiwgR2VzdGlja3RlcyBMb2dvIGF1ZiBkZXIgQnJ1c3QiLCJ0eXBlIjoiU1RSSU5HIn0seyJjYXRlZ29yeSI6ImRlc2NyaXB0aXZlIiwicHJpb3JpdHkiOjcwMCwia2V5IjoiQXJ0aWtlbG51bW1lciIsInZhbHVlIjoiMjAxMDY4MSIsInR5cGUiOiJTVFJJTkcifV19LCJxdWFudGl0eSI6MSwic2Nhbm5hYmxlQ29kZXMiOlsiMjAxMDY4MSJdLCJpZCI6IjAxOWY4MzgyLTJlNDktNzc0MS1hOTkyLTJiMWFlYzNkNjQ5ZSJ9LHsiYXJ0aWNsZSI6eyJ0ZW5hbnRBcnRpY2xlSWQiOiI1MDIwMDY0IiwidGl0bGUiOiJXYW5kdGF0dG9vIFN0YWRpb24iLCJpbWFnZVVybCI6Imh0dHBzOi8vZDM1OGc5aW5qYXJyNHUuY2xvdWRmcm9udC5uZXQvcmVzL3Byb2R1Y3RfMTAwMC8zNDNmNDU2OS02NmJiLTRiMGMtYWEyYi0yMDAxMWE1MWI2MjAuanBnIiwiYXR0cmlidXRlcyI6W3siY2F0ZWdvcnkiOiJkZXNjcmlwdGl2ZSIsInByaW9yaXR5IjoxMDAsImtleSI6Ik1hw59lIiwidmFsdWUiOiI3MCB4IDUwIGNtIiwidHlwZSI6IlNUUklORyJ9LHsiY2F0ZWdvcnkiOiJkZXNjcmlwdGl2ZSIsInByaW9yaXR5IjoyMDAsImtleSI6IkJlc2NocmVpYnVuZyIsInZhbHVlIjoiV2FuZHRhdHRvbyBpbiBaaWVnZWx3YW5kLU9wdGlrLCBNaXQgdG9sbGVtIEJsaWNrIGF1ZnMgU3RhZGlvbiIsInR5cGUiOiJTVFJJTkcifSx7ImNhdGVnb3J5IjoiZGVzY3JpcHRpdmUiLCJwcmlvcml0eSI6MzAwLCJrZXkiOiJBbndlbmR1bmciLCJ2YWx1ZSI6IkbDvHIgZGllIEJla2xlYnVuZyBzb2xsdGUgZGllIEZsw6RjaGUgc3RhdWItIHVuZCBmZXRmcmVpIHNlaW4uIEJyaW5nZW4gU2llIGRlbiBBdWZrbGViZXIgaW4gUG9zaXRpb24gdW5kIHJlaWJlbiBTaWUgZGllc2UgZ2xlaWNobcOkw59pZyBtaXQgZGVyIGZsYWNoZW4gSGFuZCBhbiBkZW4gVW50ZXJncnVuZCwgdW0gc2llIHp1IGZpeGllcmVuLiBKZWRlIFN0ZWxsZSBub2NobWFscyBnZXN0IGFuZHLDvGNrZW4uIEZlcnRpZyEgRsO8ciBhdWZ0cmV0ZW5kZSBTY2jDpGRlbiBuYWNoIGRlciBWZXJrbGVidW5nIGF1ZiBkZW0gVW50ZXJncnVuZCBldGMuIGlzdCBlaW5lIEhhZnR1bmcgYXVzZ2VzY2hsb3NzZW4uIiwidHlwZSI6IlNUUklORyJ9LHsiY2F0ZWdvcnkiOiJkZXNjcmlwdGl2ZSIsInByaW9yaXR5Ijo0MDAsImtleSI6IkFydGlrZWxudW1tZXIiLCJ2YWx1ZSI6IjUwMjAwNjQiLCJ0eXBlIjoiU1RSSU5HIn1dfSwicXVhbnRpdHkiOjIsInNjYW5uYWJsZUNvZGVzIjpbIjUwMjAwNjQiXSwiaWQiOiIwMTlmODM4Mi0yZTRhLTcyYTgtYjExMC05ZGNjZjY0YzY4MjgifV0sInBheW1lbnRJbmZvIjp7ImN1cnJlbmN5IjoiRVVSIn0sImRlbGl2ZXJ5UHJlZmVyZW5jZXMiOnsic2hpcHBpbmciOnsic2VydmljZUxldmVsIjoiREVMSVZFUlkifX0sInZlcnNpb24iOjEsInByb2Nlc3NJZCI6IjAxOWY4MzgyLTJlNDctNzUzYS1hMjI3LTc3N2FhYWU3MTljOSIsIndvcmtmbG93SW5mb3JtYXRpb24iOnsiaW5zdGFuY2VSZWYiOiI2YTVmMWIyZTlhMzMxODdjNjliMjNkNDUiLCJub2RlUmVmIjoiMDE5ZjgzODItMmU0Ny03NTNhLWEyMjctNzA4MDA1ODc2YTY2IiwiaXNBdmFpbGFibGUiOnRydWV9LCJsYXN0TW9kaWZpZWQiOiIyMDI2LTA3LTIxVDA3OjA5OjM0LjY3MloiLCJsYXN0QXVkaXQiOnsidHJhY2UiOiJhYzg1ODczYWE1NzQzMzIzNGYxNWQyZWRjOGUzN2FiNCIsImFjdG9yIjp7ImlkIjoiYW5vbnltb3VzIiwiZGV0YWlscyI6eyJ1c2VybmFtZSI6ImFub255bW91cyJ9fSwiZ2xvYmFsQWN0b3IiOnsiaWQiOiJhbm9ueW1vdXMiLCJkZXRhaWxzIjp7InVzZXJuYW1lIjoiYW5vbnltb3VzIn19LCJvcGVyYXRpb24iOnsibmFtZSI6IlBPU1QgL2FwaS9vcmRlcnMiLCJzdGFydCI6IjIwMjYtMDctMjFUMDc6MDk6MzQuNjM0WiJ9LCJjbGllbnQiOnsiYXBpIjoiaHR0cCIsInJhd0luZm8iOiJQb3N0bWFuUnVudGltZS83LjU0LjAifX0sImNyZWF0ZWQiOiIyMDI2LTA3LTIxVDA3OjA5OjM0LjY3MloiLCJzY2hlbWFWZXJzaW9uIjozLCJpZCI6IjAxOWY4MzgyLTJlNDctNzUzYS1hMjI3LTcwODAwNTg3NmE2NiJ9LCJldmVudElkIjoiMDE5ZjgzODItNGRkMS03NDM4LWE3MGYtYWQ5NGJkMGY1ZGY1In0=",
      "messageId": "20696882803541337",
      "publishTime": "2026-07-21T07:09:43.851Z"
    }
}
```

{% endcode %}

Note: We don't set any pub/sub attributes.
{% endtab %}

{% tab title="Data (base64 decode)" %}

```json
{
  "event": "ORDER_CREATED",
  "eventId": "019f8382-4dd1-7438-a70f-ad94bd0f5df5",
  "payload": {
    "orderDate": "2026-07-21T07:09:34.356Z",
    "consumer": {
      "addresses": [
        {
          "street": "Bison Drive",
          "houseNumber": "42",
          "postalCode": "42420",
          "city": "Yellowstone",
          "country": "US",
          "firstName": "Phil",
          "lastName": "Bison",
          "email": "phil.bison@fulfillmenttools.com",
          "addressType": "POSTAL_ADDRESS",
          "coordinates": {
            "lat": 48.137154,
            "lon": 11.576124
          }
        }
      ]
    },
    "tenantOrderId": "SMTP867",
    "status": "OPEN",
    "orderLineItems": [
      {
        "article": {
          "tenantArticleId": "TSHIRT-W-2468",
          "title": "T-shirt",
          "attributes": [
            {
              "category": "shop",
              "value": "3500",
              "key": "valuePerUnit",
              "type": "NUMBER"
            }
          ]
        },
        "quantity": 1,
        "scannableCodes": [
          "4242424242"
        ],
        "id": "019f8382-2e4a-72a8-b110-9dccf64c6828"
      }
    ],
    "paymentInfo": {
      "currency": "EUR"
    },
    "deliveryPreferences": {
      "shipping": {
        "serviceLevel": "DELIVERY"
      }
    },
    "version": 1,
    "processId": "019f8382-2e47-753a-a227-777aaae719c9",
    "workflowInformation": {
      "instanceRef": "6a5f1b2e9a33187c69b23d45",
      "nodeRef": "019f8382-2e47-753a-a227-708005876a66",
      "isAvailable": true
    },
    "lastModified": "2026-07-21T07:09:34.672Z",
    "lastAudit": {
      "trace": "ac85873aa57433234f15d2edc8e37ab4",
      "actor": {
        "id": "anonymous",
        "details": {
          "username": "anonymous"
        }
      },
      "globalActor": {
        "id": "anonymous",
        "details": {
          "username": "anonymous"
        }
      },
      "operation": {
        "name": "POST /api/orders",
        "start": "2026-07-21T07:09:34.634Z"
      },
      "client": {
        "api": "http",
        "rawInfo": "PostmanRuntime/7.54.0"
      }
    },
    "created": "2026-07-21T07:09:34.672Z",
    "schemaVersion": 3,
    "id": "019f8382-2e47-753a-a227-708005876a66"
  }
}
```

{% endtab %}
{% endtabs %}

#### Microsoft Azure subscription

{% tabs %}
{% tab title="Subscription" %}

```
{
    "name": "Order created (Microsoft Azure Service Bus)",
    "event": "ORDER_CREATED",
    "target": {
        "type": "MICROSOFT_AZURE_SERVICE_BUS",
        "tenantId": "<-- REDACTED -->",
        "clientId": "<-- REDACTED -->",
        "clientSecret": "<-- REDACTED -->",
        "namespace": "order-created-test",
        "queueOrTopicName": "order-created-azure-queue"
    }
}
```

{% endtab %}

{% tab title="Event body" %}

```html
{
  "body": "{\"event\":\"ORDER_CREATED\",\"payload\":{\"orderDate\":\"2026-07-21T08:35:48.075Z\",\"consumer\":{\"addresses\":[{\"street\":\"Bison Drive\",\"houseNumber\":\"42\",\"postalCode\":\"42420\",\"city\":\"Yellowstone\",\"country\":\"US\",\"firstName\":\"Phil\",\"lastName\":\"Bison\",\"email\":\"phil.bison@fulfillmenttools.com\",\"addressType\":\"POSTAL_ADDRESS\",\"coordinates\":{\"lat\":50.964788,\"lon\":7.014012}}]},\"tenantOrderId\":\"SMTP867\",\"status\":\"OPEN\",\"orderLineItems\":[{\"article\":{\"tenantArticleId\":\"TSHIRT-W-2468\",\"title\":\"T-shirt"\",\"attributes\":[{\"category\":\"shop\",\"key\":\"valuePerUnit\",\"value\":\"3500\",\"type\":\"NUMBER\"}]},\"quantity\":1,\"scannableCodes\":[\"4242424242\"],\"id\":\"019f8382-2e4a-72a8-b110-9dccf64c6828\"}],\"paymentInfo\":{\"currency\":\"EUR\"},\"deliveryPreferences\":{\"shipping\":{\"serviceLevel\":\"DELIVERY\"}},\"version\":1,\"processId\":\"019f83d1-79d4-75f8-a3bb-eeb207d9220a\",\"workflowInformation\":{\"instanceRef\":\"6a5f2f7b6b292b03ed09f533\",\"nodeRef\":\"019f83d1-79d4-75f8-a3bb-e85dd81f8847\",\"isAvailable\":true},\"lastModified\":\"2026-07-21T08:36:11.410Z\",\"lastAudit\":{\"trace\":\"aa941dda549b237c40a16132149a1525\",\"actor\":{\"id\":\"anonymous\",\"details\":{\"username\":\"anonymous\"}},\"globalActor\":{\"id\":\"anonymous\",\"details\":{\"username\":\"anonymous\"}},\"operation\":{\"name\":\"POST /api/orders\",\"start\":\"2026-07-21T08:36:10.075Z\"},\"client\":{\"api\":\"http\",\"rawInfo\":\"PostmanRuntime/7.54.0\"}},\"created\":\"2026-07-21T08:36:11.410Z\",\"schemaVersion\":3,\"id\":\"019f83d1-79d4-75f8-a3bb-e85dd81f8847\"},\"eventId\":\"019f83d1-7f3f-716c-97e1-cd3933c084c5\"}",
  "message_id": "f369a6a7a92c4b9e90121f4d8eac4a11",
  "correlation_id": null,
  "content_type": null,
  "subject": null,
  "reply_to": null,
  "session_id": null,
  "delivery_count": 0,
  "sequence_number": 1,
  "enqueued_time_utc": "2026-07-21T08:36:15.095000+00:00",
  "expires_at_utc": "2026-08-04T08:36:15.095000+00:00",
  "locked_until_utc": "2026-07-21T08:52:11.322000+00:00",
  "application_properties": {}
}
```

{% endtab %}
{% endtabs %}

#### Webhook subscription

{% tabs %}
{% tab title="Subscription" %}

```json
{
    "name": "Order created (Webhook)",
    "event": "ORDER_CREATED",
    "target": {
        "type": "WEBHOOK",
        "callbackUrl": "callbackURL",
        "headers": [
            {
                "key": "header-key",
                "value": "header-value"
            }
        ]
    }
}
```

{% endtab %}

{% tab title="http payload" %}
{% code title="http headers" %}

```http
content-length	4624
content-type	application/json
header-key	header-value
user-agent	fulfillmenttools-platform (+https://docs.fulfillmenttools.com)
accept-encoding	gzip, deflate
```

{% endcode %}

{% code title="Envelope schema" %}

```
{
  "event": "ORDER_CREATED",
  "eventId": "019f8372-32f6-7032-a417-d3320f7d253d", 
  "payload": {
    ... order created event ...
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Full http event payload" %}

```json
{
  "event": "ORDER_CREATED",
  "eventId": "019f8372-32f6-7032-a417-d3320f7d253d",
  "payload": {
    "orderDate": "2026-07-21T06:51:55.557Z",
    "consumer": {
      "addresses": [
        {
          "street": "Bison Drive",
          "houseNumber": "42",
          "postalCode": "42420",
          "city": "Yellowstone",
          "country": "US",
          "firstName": "Phil",
          "lastName": "Bison",
          "email": "phil.bison@fulfillmenttools.com",
          "addressType": "POSTAL_ADDRESS",
          "coordinates": {
            "lat": 48.137154,
            "lon": 11.576124
          }
        }
      ]
    },
    "tenantOrderId": "SMTP867",
    "status": "OPEN",
    "orderLineItems": [
      {
        "article": {
          "tenantArticleId": "TSHIRT-W-2468",
          "title": "T-shirt",
          "attributes": [
            {
              "category": "shop",
              "value": "3500",
              "key": "valuePerUnit",
              "type": "NUMBER"
            }
          ]
        },
        "quantity": 1,
        "scannableCodes": [
          "4242424242"
        ],
        "id": "019f8372-0907-7105-a5eb-ac1160cf9193"
      },
    ],
    "paymentInfo": {
      "currency": "EUR"
    },
    "deliveryPreferences": {
      "shipping": {
        "serviceLevel": "DELIVERY"
      }
    },
    "version": 1,
    "processId": "019f8372-0904-7775-a683-e6eb6dbafce2",
    "workflowInformation": {
      "instanceRef": "6a5f170c9a33187c69b23d3e",
      "nodeRef": "019f8372-0904-7775-a683-e3fb8ee74d34",
      "isAvailable": true
    },
    "lastModified": "2026-07-21T06:51:56.637Z",
    "lastAudit": {
      "trace": "11e560b6555a605eb5d4d0d0beca8825",
      "actor": {
        "id": "anonymous",
        "details": {
          "username": "anonymous"
        }
      },
      "globalActor": {
        "id": "anonymous",
        "details": {
          "username": "anonymous"
        }
      },
      "operation": {
        "name": "POST /api/orders",
        "start": "2026-07-21T06:51:55.655Z"
      },
      "client": {
        "api": "http",
        "rawInfo": "PostmanRuntime/7.54.0"
      }
    },
    "created": "2026-07-21T06:51:56.637Z",
    "schemaVersion": 3,
    "id": "019f8372-0904-7775-a683-e3fb8ee74d34"
  }
}
```

{% endtab %}
{% endtabs %}

### Contexts

For the `INVENTORY_FACILITY_STOCK_CHANGED` event, it's possible to specify contexts to restrict further when a subscription is triggered.

* If contexts are specified, the subscription is triggered only if all contexts apply
* Available context types are `FACILITY` and `FACILITY_GROUP`
* An event applies if it occurs for a:
  * Facility explicitly listed in the context
  * Facility that belongs to one of the specified facility groups
* If the event is a bulk event containing multiple payloads, the payloads are filtered to include only those relevant to the specified contexts.

```json
"contexts": [
  {
    "type": "FACILITY",
    "values": ["facility-ref-1", "facility-ref-2"]
  },
  {
    "type": "FACILITY_GROUP",
    "values": ["group-ref-1"]
  }
]
```

## Event retries

fulfillmenttools follows the exponential backoff pattern when a configured subscription is unreachable or returns a response code other than `200 OK`. If this happens, fulfillmenttools will automatically initiate a retry. The time between retries increases with each attempt, starting at 20 seconds and increasing until it reaches 600 seconds. This is executed for one hour from the time the event is created.

Redelivery attempts continue at this maximum interval until one of the following occurs:

* The subscription endpoint acknowledges the event by returning a `200 OK` response.
* The event's 7-day retention period has expired, at which point it's permanently dropped and deleted.

{% hint style="info" %}
fulfillmenttools can't guarantee how many retries occur or the interval between them after one hour.
{% endhint %}

See the following diagram that visualizes the approach:

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FVlTJOWIREsvk12420GYn%2FExponential%20backoff%20pattern.png?alt=media&amp;token=163829ea-e781-4725-a0ae-8a79213570c5" alt=""><figcaption><p>Diagram of an exponential backoff pattern for retrying messages, starting with a 20-second delay and increasing to a maximum of 600 seconds.</p></figcaption></figure>

Retries don't create additional events. Retries reuse the original event copy unchanged. This means that retries use the credentials that were valid when the event was created.

{% hint style="warning" %}
fulfillmenttools doesn't monitor the health or availability of subscriber endpoints.
{% endhint %}

{% hint style="info" %}
**Monitoring and alerting**

It's recommended to monitor the subscription endpoint and employ an alerting mechanism to detect failures early, preventing events from being dropped after the retention period expires.
{% endhint %}

## Event flow examples

fulfillmenttools communicates relevant changes through events. The flowcharts below provide a brief overview of a subset of processes and the events they trigger.

A comprehensive overview of all events is available in the [Available events article](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events).

{% hint style="info" %}
The flows below are examples of a standard, successful process in fulfillmenttools. The exact sequence of flows and events can differ depending on the specific configuration of modules and processes.
{% endhint %}

{% hint style="warning" %}
The eventing API doesn't guarantee the order of events.
{% endhint %}

### Order, reservations, and fulfillment

The following diagram depicts the typical events emitted during an exemplary order fulfillment process. This includes order routing, reservations, picking, packing, and handover, as well as a potential return.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fd54omugE8lDA6eGKkXwQ%2FOrder%20fulfilment%20process%20event%20example.png?alt=media&amp;token=51147ee9-94a9-4ae3-9e8f-5a5fd4d03a3c" alt=""><figcaption></figcaption></figure>

### Inbound process

The following diagram depicts the typical events emitted during an exemplary inbound process, from creating a Purchase Order (PO) to receiving goods.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F5Tn43E4vZ5CdIskIcn5I%2FInbound%20process%20events%20example.png?alt=media&amp;token=8f21e504-9fdb-4146-aca4-04bf2d3c8836" alt=""><figcaption></figcaption></figure>

### Stow jobs

The following diagram depicts the typical events emitted during an exemplary stowing process, from creating a `stowJob` to stowing the final items and completing the job.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FOlaomZTG2GO61TsuECr6%2FStow%20jobs%20event%20flow%20example.png?alt=media&amp;token=2f1ba34d-a5d6-4c97-9689-cc77efd80d13" alt=""><figcaption></figcaption></figure>

## Event scopes

An event scope defines which facilities or facility groups are included in an event type. A unique `key` identifies each scope and produces independent events.

{% hint style="info" %}
Event scopes are currently supported for the [`INVENTORY_ARTICLE_AVAILABILITY_CHANGED`](#inventory-article-availability-changed-event) event type only.
{% endhint %}

You can define the scope using `facilityRefs` and `facilityGroupRefs`. This can be:

* **No facilities or facility groups are configured**: The event is emitted including all facilities in the network.
* **`facilityRefs` configured**: The event is emitted, but only the explicitly listed facilities contribute to the event data.
* **`facilityGroupRefs` configured**: The event is emitted, but only facilities that are members of the referenced facility groups contribute to the event data.

Both fields can be combined. The event includes all resolved facilities from `facilityRefs` and `facilityGroupRefs`.

If a facility group is edited, the next event automatically reflects the updated facility group list. If a referenced facility or group is deleted, it's removed from the scope.

{% hint style="info" %}
The speed at which editing or deleting is reflected in the aggregated availability values of emitted events depends on the size of the data in the event. For events with a small data set, the updated scope is usually completed before the next emitted event. For events with large data sets, this updated scope propagates gradually.
{% endhint %}

### Create an event scope

Event scopes are managed via the [event scope configuration API](https://docs.fulfillmenttools.com/documentation/apis/api-reference/event-scopes-configuration). The endpoint supports `CREATE`, `GET`, `SEARCH`, `UPDATE`, and `DELETE` operations.

#### **Validation**

The `key` field is mandatory and must be unique per tenant.

#### Limits

| Constraint                                            | Limit |
| ----------------------------------------------------- | ----- |
| Maximum number of event scopes per tenant             | 10    |
| Maximum number of `facilityRefs` per event scope      | 50    |
| Maximum number of `facilityGroupRefs` per event scope | 5     |

### Subscriptions

Events with an event scope follow the standard subscription model. No scope-specific subscription is required. A single subscription to this event type receives events from all configured scopes. The `configurationScopeKey` field in the payload identifies which scope produced a given event.

For details on creating subscriptions, see the [Receiving events section](#receiving-events).

### Inventory article availability changed event

For the `INVENTORY_ARTICLE_AVAILABILITY_CHANGED` event, event scopes define which facilities contribute to an aggregated stock availability calculation and determine when a corresponding event is emitted. Rather than receiving one stock signal per facility, consumers receive one aggregated signal per configured scope whenever the aggregated values change.

This mechanism enables retailers to model independent fulfillment domains (such as all stores or all online warehouses) and receive separate, aggregated stock signals for each domain.

If an event is triggered and another a change is made before the event is sent, successive updates to the same SKU and scope are absorbed. This means that when the final emit is triggered, all the freshest data is collected and emitted at once.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FDNgix9HMCsqf69dW0GeD%2FEvent%20scope%20absorbing%20changes%20example.png?alt=media&amp;token=98db070a-8722-4950-abe3-9726d3f48a66" alt="" width="375"><figcaption></figcaption></figure>

#### Event payload

The system emits one event per scope when the aggregated `stockAvailability` values for an article change. The event identifies the article by its `tenantArticleId` and includes the current aggregated values.

For a description of the individual `stockAvailability` fields, refer to [Stock availability](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability).

```json
{
    "event": "INVENTORY_ARTICLE_AVAILABILITY_CHANGED",
    "eventId": "019e3b4b-38f0-750a-ad82-d86f2d324eab",
    "payload": {
        "tenantArticleId": "ART-1",
        "configurationScopeKey": "stores",
        "articleAvailability": {
            "total": 1000,
            "stockOnHand": 1000,
            "availableOnStock": 500,
            "availableForPicking": 500
        }
    },
    "emittedAt": "2026-02-24T08:15:00Z"
}
```


# Available events

The list of available events can be queried from the REST API using [/api/supportedevents](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/supportedevents) endpoint. An overview of all events is listed below.

{% hint style="info" %}
To suggest a new event for inclusion in the product, [contact the fulfillmenttools Support team ](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/13/create/47)with the corresponding use case.
{% endhint %}

## Event list

The payload models can be found in our [models article](https://docs.fulfillmenttools.com/documentation/apis/api-reference/models).

{% hint style="info" %}
See the API versioning and lifecycle article for more information in the API lifecycle.
{% endhint %}

*Last generated on 12 November 2026*

<table data-full-width="true"><thead><tr><th width="199.078125">Pillar<select><option value="biwlykIIqTvM" label="Core" color="blue"></option><option value="Cl1Os9gaCe0i" label="Order Management" color="blue"></option><option value="WUsrgQq4kcgl" label="Store Operations" color="blue"></option><option value="zz24vN39GwoP" label="Global Inventory Hub" color="blue"></option><option value="uW0FGD7khb2W" label="Advanced Order Routing" color="blue"></option></select></th><th width="326.5">Event</th><th width="399.7890625">Payload model</th><th width="192.78125">Description</th><th width="108.15234375">API lifecycle<select><option value="agg9zzsZmAi3" label="GA" color="blue"></option><option value="LmgfJKxdBLja" label="ALPHA" color="blue"></option><option value="wesNhJeEvVbH" label="BETA" color="blue"></option></select></th></tr></thead><tbody><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>EXTERNAL_ACTION_EXECUTED</code></td><td><code>ExternalActionExecutedWebHookEvent</code></td><td>An external action was executed.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>FACILITY_CREATED</code></td><td><code>FacilityCreatedWebHookEvent</code></td><td>A facility was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>FACILITY_DELETED</code></td><td><code>FacilityDeletedWebHookEvent</code></td><td>A facility was deleted.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>FACILITY_GROUP_CREATED</code></td><td><code>FacilityGroupCreatedWebHookEvent</code></td><td>A facility group was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>FACILITY_GROUP_DELETED</code></td><td><code>FacilityGroupDeletedWebHookEvent</code></td><td>A facility group was deleted.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>FACILITY_GROUP_UPDATED</code></td><td><code>FacilityGroupUpdatedWebHookEvent</code></td><td>A facility group was updated.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>FACILITY_SUSPENDED</code></td><td><code>FacilitySuspendedWebHookEvent</code></td><td>A facility changed its status to `SUSPENDED`.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>FACILITY_UPDATED</code></td><td><code>FacilityUpdatedWebHookEvent</code></td><td>A facility was updated.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>FACILITY_WENT_OFFLINE</code></td><td><code>FacilityWentOfflineWebHookEvent</code></td><td>A facility changed its status to `OFFLINE`.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>FACILITY_WENT_ONLINE</code></td><td><code>FacilityWentOnlineWebHookEvent</code></td><td>A facility changed its status to `ONLINE`.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>NOTIFICATION_CENTER_CONFIG_UPSERTED</code></td><td><code>NotificationCenterConfigUpsertedWebHookEvent</code></td><td>A notification center configuration was upserted.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>NOTIFICATION_UPSERTED</code></td><td><code>NotificationUpsertedWebHookEvent</code></td><td>A notification was upserted.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>USER_CREATED</code></td><td><code>UserCreatedWebHookEvent</code></td><td>A user was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>USER_DELETED</code></td><td><code>UserDeletedWebHookEvent</code></td><td>A user was deleted.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>USER_UPDATED</code></td><td><code>UserUpdatedWebHookEvent</code></td><td>A user was updated.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="biwlykIIqTvM">Core</span></td><td><code>WORKFLOW_GUARD_APPLIES</code></td><td><code>WorkflowGuardAppliesWebHookEvent</code></td><td>A workflow instance was stopped by a guard.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>EXPIRY_ENTITY_CREATED</code></td><td><code>ExpiryWebHookEvent</code></td><td>An expiry was created. For example, an order was supplied with a configured expiry.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>EXPIRY_ENTITY_EXPIRED</code></td><td><code>ExpiryWebHookEvent</code></td><td>The expiry has expired, meaning, for example, the provided provisioning time and the configured offset were reached. So, the order and corresponding entities (pick jobs, pack jobs, and so on) are canceled.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>EXPIRY_ENTITY_UPDATED</code></td><td><code>ExpiryWebHookEvent</code></td><td>An expiry was updated. There is an additional event when the expiry has expired.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>LOCKED_ORDER_CREATED</code></td><td><code>LockedOrderCreatedWebHookEvent</code></td><td>A locked order was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>ORDER_CANCELLED</code></td><td><code>OrderCancelledWebHookEvent</code></td><td>An order was canceled.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>ORDER_CANCELLED_BY_EXPIRY</code></td><td><code>OrderCancelledByExpiryEvent</code></td><td>An order was canceled by an expiration event (for example, by an exceeded provisioning time).</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>ORDER_CREATED</code></td><td><code>OrderCreatedWebHookEvent</code></td><td>An order was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>ORDER_FORCE_CANCELLED</code></td><td><code>OrderForceCancelledWebHookEvent</code></td><td>An order was force canceled.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>ORDER_MODIFIED</code></td><td><code>OrderModifiedWebHookEvent</code></td><td>An order was modified.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>ORDER_UNLOCKED</code></td><td><code>OrderUnlockedWebHookEvent</code></td><td>An order was unlocked.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>PROCESS_ANONYMIZED</code></td><td><code>ProcessAnonymizedWebHookEvent</code></td><td>A process was anonymized.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="Cl1Os9gaCe0i">Order Management</span></td><td><code>PROCESS_DELETED</code></td><td><code>ProcessDeletedWebHookEvent</code></td><td>A process was deleted.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>HANDOVERJOB_CANCELED</code></td><td><code>HandoverJobWebHookEvent</code></td><td>A handover job was canceled.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>HANDOVERJOB_CREATED</code></td><td><code>HandoverJobWebHookEvent</code></td><td>A handover job was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>HANDOVERJOB_HANDED_OVER</code></td><td><code>HandoverJobWebHookEvent</code></td><td>A handover job was handed over.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>HANDOVERJOB_REVERTED</code></td><td><code>HandoverJobWebHookEvent</code></td><td>A handover job was set to status `OPEN` manually.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>ITEM_RETURN_JOB_CREATED</code></td><td><code>ItemReturnJobWebHookEvent</code></td><td>An item return job was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>ITEM_RETURN_JOB_UPDATED</code></td><td><code>ItemReturnJobWebHookEvent</code></td><td>An item return job was updated.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PACKING_SOURCE_CONTAINER_CREATED_EVENT</code></td><td><code>PackingSourceContainerWebHookEvent</code></td><td>A packing source container was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PACKING_SOURCE_CONTAINER_DELETED_EVENT</code></td><td><code>PackingSourceContainerWebHookEvent</code></td><td>A packing source container was deleted.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PACKING_SOURCE_CONTAINER_UPDATED_EVENT</code></td><td><code>PackingSourceContainerWebHookEvent</code></td><td>A packing source container was updated.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PACKING_TARGET_CONTAINER_CREATED_EVENT</code></td><td><code>PackingTargetContainerWebHookEvent</code></td><td>A packing target container was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PACKING_TARGET_CONTAINER_DELETED_EVENT</code></td><td><code>PackingTargetContainerWebHookEvent</code></td><td>A packing target container was deleted.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PACKING_TARGET_CONTAINER_UPDATED_EVENT</code></td><td><code>PackingTargetContainerWebHookEvent</code></td><td>A packing target container was updated.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PACK_JOB_CANCELED</code></td><td><code>PackJobWebHookEvent</code></td><td>A pack job was canceled.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PACK_JOB_CLOSED</code></td><td><code>PackJobWebHookEvent</code></td><td>A pack job was closed.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PACK_JOB_CREATED</code></td><td><code>PackJobWebHookEvent</code></td><td>A pack job was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PACK_JOB_UPDATED</code></td><td><code>PackJobWebHookEvent</code></td><td>A pack job was updated.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PARCEL_CARRIER_ACKNOWLEDGED</code></td><td><code>ParcelWebHookEvent</code></td><td>The label was created successfully and the label can now be downloaded.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PARCEL_CARRIER_CREATED</code></td><td><code>ParcelWebHookEvent</code></td><td>The parcel has been created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PARCEL_CARRIER_FAILED</code></td><td><code>ParcelWebHookEvent</code></td><td>The label could not be created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PARCEL_CARRIER_REQUESTED</code></td><td><code>ParcelWebHookEvent</code></td><td>A parcel has been set into status PROCESSING. This means that either the carrier has been requested to create a label (integrated carrier) or a parcel has been set to PROCESSING because of manualParcelHandling being active (custom carrier).</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_ABORTED</code></td><td><code>PickjobWebHookEvent</code></td><td>A pick job was aborted.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_CANCELED</code></td><td><code>PickjobWebHookEvent</code></td><td>A pick job was canceled.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_CREATED</code></td><td><code>PickjobWebHookEvent</code></td><td>A pick job was created</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_PICKING_COMMENCED</code></td><td><code>PickjobWebHookEvent</code></td><td>A pick job is being picked.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_PICKING_FINISHED</code></td><td><code>PickjobWebHookEvent</code></td><td>A pick job was finished.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_PICKING_PAUSED</code></td><td><code>PickjobWebHookEvent</code></td><td>A pick job was paused.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_PICK_LINE_PICKED</code></td><td><code>PickJobPickLinePickedWebHookEvent</code></td><td>A pick line of a pick job was picked.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_REROUTED</code></td><td><code>PickjobWebHookEvent</code></td><td>A pick job was rerouted to another facility.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_RESET</code></td><td><code>PickjobWebHookEvent</code></td><td>A pick job was reset.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>SHIPMENT_CREATED</code></td><td><code>ShipmentWebHookEvent</code></td><td>A shipment was created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>SHIPMENT_UPDATED</code></td><td><code>ShipmentWebHookEvent</code></td><td>A shipment was updated.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PARCEL_INFORMATION_CREATED</code></td><td><code>ParcelInformationWebHookEvent</code></td><td>A parcel information was created.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PARCEL_INFORMATION_UPDATED</code></td><td><code>ParcelInformationWebHookEvent</code></td><td>A parcel information was updated.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PARCEL_TRACK_AND_TRACE_STATUS_UPDATED</code></td><td><code>ParcelWebHookEvent</code></td><td>The tracking data of the parcel has been updated.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>REFUND_TRIGGERED</code></td><td><code>RefundTriggeredWebHookEvent</code></td><td>A refund was triggered.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>SERVICE_CONTAINER_CREATED</code></td><td><code>ServiceContainerWebHookEvent</code></td><td>A service container was created.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>SERVICE_CONTAINER_DELETED</code></td><td><code>ServiceContainerWebHookEvent</code></td><td>A service container was deleted.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>SERVICE_CONTAINER_UPDATED</code></td><td><code>ServiceContainerWebHookEvent</code></td><td>A service container was updated.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>SERVICE_JOB_CREATED</code></td><td><code>ServiceJobWebHookEvent</code></td><td>A service job was created.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>SERVICE_JOB_FINISHED</code></td><td><code>ServiceJobWebHookEvent</code></td><td>A service job was finished.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICKING_PICK_JOB_COMPLETE</code></td><td><code>PickjobWebHookEvent</code></td><td>Picking has reached a terminal state (CLOSED, ABORTED, CANCELED) and will not be rerouted automatically. Changes can still be made by users or integrations.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_ALLOWED_VALUES_REQUESTED</code></td><td><code>PickjobWebHookEvent</code></td><td>A pick job was set to waiting for input and is in need of allowed values in the article line items or this event was emitted due to the respective API call.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>PICK_JOB_OPENED</code></td><td><code>PickjobWebHookEvent</code></td><td>A pick job was set to open</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>SHIPPING_INFORMATION_CREATED</code></td><td><code>ShippingInformationWebHookEvent</code></td><td>A shipping information was created.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>SHIPPING_INFORMATION_DELETED</code></td><td><code>ShippingInformationWebHookEvent</code></td><td>A shipping information was deleted.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>SHIPPING_INFORMATION_UPDATED</code></td><td><code>ShippingInformationWebHookEvent</code></td><td>A shipping information was updated.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>TRACKING_INFORMATION_CREATED</code></td><td><code>TrackingInformationWebHookEvent</code></td><td>A tracking information was created.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>TRACKING_INFORMATION_DELETED</code></td><td><code>TrackingInformationWebHookEvent</code></td><td>A tracking information was deleted.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="WUsrgQq4kcgl">Store Operations</span></td><td><code>TRACKING_INFORMATION_UPDATED</code></td><td><code>TrackingInformationWebHookEvent</code></td><td>A tracking information was updated.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_DELIVERY_FINISHED</code></td><td><code>InboundDeliveryFinishedWebHookEvent</code></td><td>A new receipt was finished, and the corresponding inbound process was completed, meaning the amount of items received for each requested line item was reached or exceeded.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_DELIVERY_ON_HOLD</code></td><td><code>InboundDeliveryOnHoldWebHookEvent</code></td><td>An inbound process was set on hold by setting the onHold flag to true. This means the process should be paused for now.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_DELIVERY_RECEIVED</code></td><td><code>InboundDeliveryReceivedWebHookEvent</code></td><td>A new receipt was finished, indicating that new stock was accepted in the facility.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_DELIVERY_RELEASED</code></td><td><code>InboundDeliveryReleasedWebHookEvent</code></td><td>An inbound process was released from onHold status by setting the onHold flag to false. This means the process can be continued.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_FACILITY_STOCK_CHANGED</code></td><td><code>InventoryFacilityStockChangedWebHookEvent</code></td><td>The aggregated stock availability of one product (identified by its tenantArticleId) in a specific facility (identified by the facilityRef) has changed. This can, for example, mean changes in the total stock, the reserved amount or some other factors.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_STOCKS_CREATED</code></td><td><code>InventoryStockBulkWebHookEvent</code></td><td>Stocks were created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_STOCKS_DELETED</code></td><td><code>InventoryStockBulkWebHookEvent</code></td><td>Stocks were deleted.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_STOCKS_LOCATION_CHANGED</code></td><td><code>InventoryStockBulkWebHookEvent</code></td><td>Storage locations of stocks changed.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_STOCKS_VALUE_CHANGED</code></td><td><code>InventoryStockBulkWebHookEvent</code></td><td>Value of stocks has changed, including creation and deletion of stocks.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>LISTINGS_CREATED</code></td><td><code>ListingBulkWebHookEvent</code></td><td>Listings were created</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>LISTINGS_DELETED</code></td><td><code>ListingBulkWebHookEvent</code></td><td>Listings were deleted</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>LISTINGS_INFORMATION_CHANGED</code></td><td><code>ListingBulkWebHookEvent</code></td><td>Information in listings changed in one of the fields attributes, price, title, titleLocalized, weight, scannableCodes, tags, measurementUnitKey, currency, legal, customAttributes.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>LISTINGS_STATUS_CHANGED</code></td><td><code>ListingBulkWebHookEvent</code></td><td>Status of listings changed.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>LISTINGS_STOCK_CONFIGURATIONS_CHANGED</code></td><td><code>ListingBulkWebHookEvent</code></td><td>The information how stockProperties and stockAvailableUntil should be configured for stocks belonging to listings changed.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>STORAGE_LOCATIONS_CREATED</code></td><td><code>StorageLocationsWebHookEvent</code></td><td>Storage locations were created.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>STORAGE_LOCATIONS_DELETED</code></td><td><code>StorageLocationsWebHookEvent</code></td><td>Storage locations were deleted</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>STORAGE_LOCATIONS_INFORMATION_CHANGED</code></td><td><code>StorageLocationsWebHookEvent</code></td><td>Information in storage locations changed in at least one of the following fields: type, traits, traitConfig</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_ARTICLE_AVAILABILITY_CHANGED</code></td><td><code>InventoryArticleAvailabilityChangedWebHookEvent</code></td><td>The aggregated stock availability of one product (identified by its tenantArticleId) across a configured scope of facilities has changed. The scope is defined by an event scope configuration.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_CATEGORIES_CREATED</code></td><td><code>InventoryCategoriesWebHookEvent</code></td><td>Inventory categories were created.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_CATEGORIES_DELETED</code></td><td><code>InventoryCategoriesWebHookEvent</code></td><td>Inventory categories were deleted.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_CATEGORIES_INFORMATION_CHANGED</code></td><td><code>InventoryCategoriesWebHookEvent</code></td><td>Information in inventory categories changed.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>ZONE_CREATED</code></td><td><code>ZoneWebHookEvent</code></td><td>A zone was created</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>ZONE_DELETED</code></td><td><code>ZoneWebHookEvent</code></td><td>A zone was deleted</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_PROCESS_PURCHASE_ORDER_CANCELED</code></td><td><code>PurchaseOrderWebHookEvent</code></td><td>A purchase order was canceled.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_PROCESS_PURCHASE_ORDER_CREATED</code></td><td><code>PurchaseOrderWebHookEvent</code></td><td>A purchase order was created.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_PROCESS_PURCHASE_ORDER_DELETED</code></td><td><code>PurchaseOrderWebHookEvent</code></td><td>A purchase order was deleted.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_PROCESS_PURCHASE_ORDER_LINE_ITEMS_CHANGED</code></td><td><code>PurchaseOrderWebHookEvent</code></td><td>The requested items of a purchase order changed, which can include changes in tenantArticleIds, values, units, and stock properties.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_PROCESS_PURCHASE_ORDER_REQUESTED_DATE_CHANGED</code></td><td><code>PurchaseOrderWebHookEvent</code></td><td>The requested date of a purchase order changed.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_PROCESS_RECEIPT_CREATED</code></td><td><code>InboundProcessReceiptBulkWebHookEvent</code></td><td>A new receipt was created.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_PROCESS_RECEIPT_LINE_ITEM_CHANGED</code></td><td><code>InboundProcessReceiptBulkWebHookEvent</code></td><td>Changes were made to the receivedItems of a receipt. This could mean that some of the requested items were accepted.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INBOUND_PROCESS_RECEIPT_STARTED</code></td><td><code>InboundProcessReceiptBulkWebHookEvent</code></td><td>A receipt was set to status `IN_PROGRESS`.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED</code></td><td><code>StockAvailabilityThresholdTransitionedWebHookEvent</code></td><td>One or more stock availability thresholds transitioned (turned on or off) for a product in a facility.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED_BULK</code></td><td><code>StockAvailabilityThresholdTransitionedBulkWebHookEvent</code></td><td>Bulk variant of INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED: delivers multiple stock availability threshold transitions (turned on or off) as one event with an array payload.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_PICKED_FROM_FAULTY_STOCK</code></td><td><code>InventoryPickingOutcomeWebHookEvent</code></td><td>Triggered when inventory picking results in an outcome caused by faulty or problematic stock, for example, when the picked quantity is lower than requested (short pick), the stock could not be located, or there is insufficient stock available to fulfill the pick.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_RESERVATIONS_CREATED</code></td><td><code>ReservationsBulkWebHookEvent</code></td><td>Reservation created.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>INVENTORY_RESERVATIONS_DELETED</code></td><td><code>ReservationsBulkWebHookEvent</code></td><td>Reservations were deleted. More information on the reason for the deletion can be found in the `routingPlan` events.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>STOW_JOB_CANCELED</code></td><td><code>StowJobWebHookEvent</code></td><td>A stow job was canceled</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>STOW_JOB_CLOSED</code></td><td><code>StowJobWebHookEvent</code></td><td>A stow job was closed.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>STOW_JOB_COMMENCED</code></td><td><code>StowJobWebHookEvent</code></td><td>A stow job was started or resumed.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>STOW_JOB_CREATED</code></td><td><code>StowJobWebHookEvent</code></td><td>A stow job was created.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>STOW_JOB_LINE_ITEMS_STOWED</code></td><td><code>StowJobWebHookEvent</code></td><td>Stow job line items have been put on their target location or have been discarded.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>STOW_JOB_OPENED</code></td><td><code>StowJobWebHookEvent</code></td><td>A stow job was opened.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="zz24vN39GwoP">Global Inventory Hub</span></td><td><code>STOW_JOB_PAUSED</code></td><td><code>StowJobWebHookEvent</code></td><td>A stow job was paused.</td><td><span data-option="LmgfJKxdBLja">ALPHA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>FACILITY_CAPACITY_FULLY_BOOKED</code></td><td><code>FacilityCapacityFullyBookedWebHookEvent</code></td><td>All picking slots of a facility within its capacity planning timeframe are fully booked.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>ROUTING_PLAN_CANCELLED</code></td><td><code>WebHookEvent with RoutingPlan as payload</code></td><td>A routing plan was canceled.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>ROUTING_PLAN_FALLBACK</code></td><td><code>RoutingPlanFallbackRoutingWebHookEvent</code></td><td>A routing plan was routed to its fallback facility.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>ROUTING_PLAN_NOT_ROUTABLE</code></td><td><code>RoutingPlanNotRoutableWebHookEvent</code></td><td>An order could not be routed. The routing plan that was used is attached.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>ROUTING_PLAN_REROUTEPLAN_CREATED</code></td><td><code>RoutingPlanRerouteCreatedWebHookEvent</code></td><td>A reroute plan was created for a routing plan.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>ROUTING_PLAN_ROUTED</code></td><td><code>RoutingPlanRoutedWebHookEvent</code></td><td>A routing plan was successfully routed.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>ROUTING_PLAN_SPLITTED</code></td><td><code>RoutingPlanSplittedWebHookEvent</code></td><td>A routing plan was split into multiple parts.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>ROUTING_PLAN_WAITING</code></td><td><code>RoutingPlanWaitingWebHookEvent</code></td><td>A routing plan is waiting for external events in order to be successfully routed.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>TIME_TRIGGERED_REROUTE_FAILED</code></td><td><code>TimeTriggeredRerouteFailedWebHookEvent</code></td><td>A time triggered reroute attempt failed or turned out to be redundant.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>TIME_TRIGGERED_REROUTE_LIMIT_REACHED</code></td><td><code>TimeTriggeredRerouteLimitReachedWebHookEvent</code></td><td>The configured attempt threshold for time triggered reroutes was reached, so the routing plan of the pick job will not be rerouted by time trigger anymore.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>UPCOMING_TIME_TRIGGERED_REROUTE</code></td><td><code>UpcomingTimeTriggeredRerouteWebHookEvent</code></td><td>A time triggered reroute is imminent.</td><td><span data-option="agg9zzsZmAi3">GA</span></td></tr><tr><td><span data-option="uW0FGD7khb2W">Advanced Order Routing</span></td><td><code>ROUTING_PLAN_FAILED_REROUTE</code></td><td><code>RoutingPlanFailedRerouteWebHookEvent</code></td><td>A failed reroute occurred.</td><td><span data-option="wesNhJeEvVbH">BETA</span></td></tr></tbody></table>

## Event export

The system logs all events and makes them available in a daily export. The daily event files are saved in a [Google Cloud Storage](https://cloud.google.com/storage/docs) bucket. This enables users to leverage data from their fulfillment process for additional processing and analytics.

{% hint style="info" %}
This functionality isn't activated by default. To enable it, contact us using our contact form.
{% endhint %}

For more information, see the [Event export](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/event-export) article for more information.


# Event export

The system logs all [fulfillmenttools events](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events) and makes them available in a daily export. The daily event files are saved in a [Google Cloud Storage](https://cloud.google.com/storage/docs) bucket, enabling users to leverage data from their fulfillment process for additional processing and analytics.

{% hint style="info" %}
Event export functionality isn't activated by default. Use the [contact form](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11/create/39) to ask us to enable it for you.
{% endhint %}

## Accessing the bucket

[Google offers multiple client libraries](https://cloud.google.com/storage/docs/reference/libraries) for accessing Google Cloud Storage buckets, and you can also use the [Google Cloud Storage API](https://cloud.google.com/storage/docs/apis) directly. Another alternative is to use the [gcloud CLI](https://cloud.google.com/sdk/docs/install) from the Google Cloud SDK.

Accessing the bucket requires a [Google service account](https://cloud.google.com/docs/authentication#service-accounts). Upon request, fulfillmenttools provides a service account key for authentication. This service account grants access only to this specific bucket. It can't be used to access the fulfillmenttools API or its client applications.

The service account key will be a file named `{YOUR_TENANT_NAME}-{KEY_ID}.json`. This file contains a JSON representation of the service account.

{% hint style="info" %}
This file contains the service account key and allows access to the bucket, so make sure to store it securely. See the [official Google documentation](https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys?_ga=2.192306863.-481233758.1659361152) for further information.
{% endhint %}

## File and folder structure

The bucket is named `{YOUR_TENANT_NAME}-{TIER}-public-events-export-bucket` and is only accessible by authorized accounts.

For each day, the system creates a folder in the bucket with the pattern `YYYY-MM-DD` that contains the events for that day.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/roI2mVP3IA8DM7gg5UH5/Bildschirmfoto%202024-02-06%20um%2009.11.16.png" alt="Screenshot of a Google Cloud Storage bucket showing folders named by date."><figcaption><p>Bucket folder structure</p></figcaption></figure>

Each folder contains one or more gzipped files. Each of these files contains multiple lines, each corresponding to an event in fulfillmenttools.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/CQmw3IzrHv8BiTBQLzTu/Bildschirmfoto%202024-02-06%20um%2009.13.24.png" alt=""><figcaption><p>Files inside folder</p></figcaption></figure>

Each line of a file is a JSON object containing metadata fields (`id`, `eventName`, `created`) and the event `payload`.

```json
{
  "id": "b0a0e08e-d7d0-4694-ad6c-bbf47b3fc1c6",
  "eventName": "order-created_event-v1",
  "payload": {
    ...  // Event
  },
  "created": "2024-02-01T09:20:39.411067+00:00"
}
```

## Retention

The system stores data in the buckets for 90 days. After this period, the data is automatically deleted.

## gcloud CLI example

The following example demonstrates how to copy files from a Google Cloud Storage bucket using the [Google Cloud CLI.](https://docs.cloud.google.com/sdk/docs/initializing)

{% hint style="info" %}
Check the official [Google documentation about gsutil](https://cloud.google.com/storage/docs/gsutil) for further details.
{% endhint %}

### Activate the service account

The service account email ID is located in the `client_email` field of the provided key file. Use this ID to activate the service account:

```sh
$ gcloud auth activate-service-account {SERVICE_ACCOUNT_EMAIL_ID} --key-file={PATH_TO_KEY_FILE}
```

The command `gcloud auth list` lists all credentialed accounts and shows the active one. The `gcloud config list` command can be used to check the current configuration.

### List files in the bucket

The following commands list the contents of the bucket:

```sh
# List all date folders in the bucket
$ gcloud storage ls gs://{YOUR_TENANT_NAME}-{TIER}-public-events-export-bucket

gs://ocff-mytenant-pre-public-events-export-bucket/2024-01-16/
gs://ocff-mytenant-pre-public-events-export-bucket/2024-01-17/
gs://ocff-mytenant-pre-public-events-export-bucket/2024-01-18/
gs://ocff-mytenant-pre-public-events-export-bucket/2024-01-19/
...

# List all files for a specific date
$ gcloud storage ls gs://{YOUR_TENANT_NAME}-{TIER}-public-events-export-bucket/2024-02-01

gs://ocff-mytenant-pre-public-events-export-bucket/2024-02-01/000000000000.json.gz
gs://ocff-mytenant-pre-public-events-export-bucket/2024-02-01/000000000001.json.gz
```

### Download the whole bucket

Individual files or the entire bucket can be downloaded to a local folder:

```sh
$ gcloud storage cp gs://{YOUR_TENANT_NAME}-{TIER}-public-events-export-bucket
```


# Notification center

The notification center keeps users informed about relevant events within fulfillmenttools. It allows configuring email or client notifications for specific events on the network and facility level.

The following events are available:

* `PICK_JOB_CREATED`: A pick job was created in a facility.
* `UPCOMING_TIME_TRIGGERED_REROUTE`: An order will soon be re-routed.
  * Note: This event is only available for facility notifications.
* `ROUTING_PLAN_NOT_ROUTABLE`: An order couldn't be assigned to a facility.
* `ROUTING_PLAN_WAITING`: A routing plan is waiting for external events to be routed.
* `ORDER_MODIFIED`: An order was edited.
* `LOCKED_ORDER_CREATED`: An order was created with a locked status. The corresponding operative job will be released once the order is unlocked.
* `ORDER_UNLOCKED`: An order was unlocked.
* `ORDER_CANCELLED`, `ORDER_FORCE_CANCELLED`, `ORDER_CANCELLED_BY_EXPIRY`: An order was canceled.
* `INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED`: a configured stock threshold transitioned to `ON`.

## Notification channels

The notification center supports two types of notification channels:

1. **Email channel**

When this channel type is configured, one or more email addresses can be added as recipients.\
Whenever a triggering event occurs, all configured recipients receive an email notification containing relevant event details.

2. **Client channel**

When this channel type is configured, a database entry is created each time a triggering event occurs. External clients can retrieve and display these entries via the [notification API](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/notification-center/notification-center-endpoints).

## Configuration

Notifications can be configured either on the network or facility level:

* **Network-level configuration:** Notifications are received globally for all applicable facilities.
* **Facility-level configuration:** Notifications are received only for specific facilities (for example, for orders routed to that facility).

A [channel](#notification-channels) must be defined to set up a notification.

A [channel](#notification-channels) defines the source (event) and, if applicable, the target (receiver) of the notification.

We recommend defining separate channels for different receiver groups or facilities.

{% hint style="warning" %}
**Quotas may be imposed on this in the future**

fulfillmenttools reserves the right to impose a quota per customer on this feature in the future.
{% endhint %}

## Create a notification configuration

To create a notification on the network level, you'll need to use the Global notification endpoints.

To create a notification on the facility level, you'll need to use the Facility notification endpoints.

### Examples

#### Network notification for routing plan not routable

In the below example, we'll create a notification that sends an email to a user if a routing plan is not routable across the entire network.

{% tabs %}
{% tab title="Endpoint" %}

```http
PUT https://ocff-{projectId}.api.fulfillmenttools.com/api/configurations/notifications
```

{% endtab %}

{% tab title="Request body" %}

```json
{
  "channels": [
    {
      "enabled": true,
      "events": [
        "ROUTING_PLAN_NOT_ROUTABLE"
      ],
      "receiver": [
        {
          "email": "user@example.com", // you can enter as many email addresses as you like here
          "language": "en_US"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "version": 1
}
```

{% endtab %}

{% tab title="Response body" %}

```json
{
    "version": 1,
    "channels": [
        {
            "enabled": true,
            "events": [
                "ROUTING_PLAN_NOT_ROUTABLE"
            ],
            "receiver": [
                {
                    "email": "user@example.com",
                    "language": "en_US"
                }
            ],
            "type": "EMAIL",
            "id": "019c0e39-9d56-76eb-9596-2dfc321dad6c"
        }
    ],
    "created": "2026-01-30T09:26:22.835Z",
    "lastModified": "2026-01-30T09:26:22.835Z"
}
```

{% endtab %}
{% endtabs %}

{% hint style="warning" %}
A scheduled `CRON_JOB` in the tenant is responsible for triggering the dispatch of emails. Depending on the configured interval of this job, a delay may occur between the actual event time and when the email is sent.
{% endhint %}

#### Facility notification for pick job creation

In the below example, we'll create a notification that sends a notification to Backoffice when a pick job is created.

{% tabs %}
{% tab title="Endpoint" %}

```http
PUT https://ocff-{projectId}.api.fulfillmenttools.com/api/facilities/{facilityRef}/configurations/notifications
```

{% endtab %}

{% tab title="Request body" %}

```json
{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "type": "CLIENT"
    }
  ]
}
```

{% endtab %}

{% tab title="Response body" %}

<pre class="language-json"><code class="lang-json">{
    "version": 1,
    "channels": [
        {
            "enabled": true,
            "events": [
                "PICK_JOB_CREATED"
            ],
            "type": "CLIENT",
<strong>            "id": "019c0f45-8292-76bc-98c4-9b1e4b3e961b"
</strong>        }
    ],
    "configId": "notification-center",
    "created": "2026-01-30T09:26:22.835Z",
    "lastModified": "2026-01-30T14:18:59.607Z"
}
</code></pre>

You can then use the `id` to
{% endtab %}
{% endtabs %}


# Notification center endpoints

## Network-level configurations

## Get notification config

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Returns the notification center configuration.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to configure the notification center.","name":"Notification center configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NotificationCenterConfig":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannel"},{"$ref":"#/components/schemas/ClientNotificationChannel"}]},"maxItems":100,"type":"array"},"created":{"format":"date-time","type":"string"},"lastModified":{"format":"date-time","type":"string"},"version":{"type":"number"}},"required":["version","created","lastModified","channels"],"title":"NotificationCenterConfig","type":"object","description":"NotificationCenterConfig"},"EmailNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","id","receiver"],"title":"EmailNotificationChannel","type":"object","description":"EmailNotificationChannel"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type","id"],"title":"ClientNotificationChannel","type":"object","description":"ClientNotificationChannel"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/notifications":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Returns the notification center configuration.","operationId":"getNotificationCenterConfig","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCenterConfig"}}},"description":"The notification center configuration was successfully returned."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get notification config","tags":["Notification center configuration"]}}}}
```

## Update notification config

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Update the notification center configuration.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to configure the notification center.","name":"Notification center configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NotificationCenterConfigForUpdate":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannelForCreation"},{"$ref":"#/components/schemas/ClientNotificationChannelForCreation"}]},"maxItems":100,"type":"array"},"version":{"type":"number"}},"required":["channels","version"],"title":"NotificationCenterConfigForUpdate","type":"object","description":"NotificationCenterConfigForUpdate"},"EmailNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","receiver"],"title":"EmailNotificationChannelForCreation","type":"object","description":"EmailNotificationChannelForCreation"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type"],"title":"ClientNotificationChannelForCreation","type":"object","description":"ClientNotificationChannelForCreation"},"NotificationCenterConfigForCreation":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannelForCreation"},{"$ref":"#/components/schemas/ClientNotificationChannelForCreation"}]},"maxItems":100,"type":"array"}},"required":["channels"],"title":"NotificationCenterConfigForCreation","type":"object","description":"NotificationCenterConfigForCreation"},"NotificationCenterConfig":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannel"},{"$ref":"#/components/schemas/ClientNotificationChannel"}]},"maxItems":100,"type":"array"},"created":{"format":"date-time","type":"string"},"lastModified":{"format":"date-time","type":"string"},"version":{"type":"number"}},"required":["version","created","lastModified","channels"],"title":"NotificationCenterConfig","type":"object","description":"NotificationCenterConfig"},"EmailNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","id","receiver"],"title":"EmailNotificationChannel","type":"object","description":"EmailNotificationChannel"},"ClientNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type","id"],"title":"ClientNotificationChannel","type":"object","description":"ClientNotificationChannel"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/notifications":{"put":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Update the notification center configuration.","operationId":"upsertNotificationCenterConfig","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/NotificationCenterConfigForUpdate"},{"allOf":[{"$ref":"#/components/schemas/NotificationCenterConfigForCreation"}],"not":{"required":["version"]},"type":"object"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCenterConfig"}}},"description":"Notification center configuration was successfully updated."},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCenterConfig"}}},"description":"Notification center configuration was successfully created."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."}},"summary":"Update notification config","tags":["Notification center configuration"]}}}}
```

## Call notification action

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Executes an action to manipulate the notification center configuration.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to configure the notification center.","name":"Notification center configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AddChannelAction":{"properties":{"channel":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannelForCreation"},{"$ref":"#/components/schemas/ClientNotificationChannelForCreation"}]},"name":{"enum":["ADD_CHANNEL"],"type":"string"},"version":{"type":"number"}},"required":["name","channel","version"],"title":"AddChannelAction","type":"object","description":"AddChannelAction"},"EmailNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","receiver"],"title":"EmailNotificationChannelForCreation","type":"object","description":"EmailNotificationChannelForCreation"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type"],"title":"ClientNotificationChannelForCreation","type":"object","description":"ClientNotificationChannelForCreation"},"UpdateChannelByIdAction":{"properties":{"channel":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannel"},{"$ref":"#/components/schemas/ClientNotificationChannel"}]},"name":{"enum":["UPDATE_CHANNEL"],"type":"string"},"version":{"type":"number"}},"required":["name","channel","version"],"title":"UpdateChannelByIdAction","type":"object","description":"UpdateChannelByIdAction"},"EmailNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","id","receiver"],"title":"EmailNotificationChannel","type":"object","description":"EmailNotificationChannel"},"ClientNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type","id"],"title":"ClientNotificationChannel","type":"object","description":"ClientNotificationChannel"},"NotificationCenterConfig":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannel"},{"$ref":"#/components/schemas/ClientNotificationChannel"}]},"maxItems":100,"type":"array"},"created":{"format":"date-time","type":"string"},"lastModified":{"format":"date-time","type":"string"},"version":{"type":"number"}},"required":["version","created","lastModified","channels"],"title":"NotificationCenterConfig","type":"object","description":"NotificationCenterConfig"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/notifications/actions":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Executes an action to manipulate the notification center configuration.","operationId":"executeNotificationCenterConfigAction","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AddChannelAction"},{"$ref":"#/components/schemas/UpdateChannelByIdAction"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCenterConfig"}}},"description":"Notification center configuration action was successfully executed."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."}},"summary":"Call notification action","tags":["Notification center configuration"]}}}}
```

## Delete notification channel

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Delete the notification channel.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to configure the notification center.","name":"Notification center configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/notifications/channels/{channelId}":{"delete":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Delete the notification channel.","operationId":"deleteNotificationCenterConfigChannel","parameters":[{"in":"path","name":"channelId","required":true,"schema":{"type":"string"}},{"in":"query","name":"version","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Notification center config channel was successfully deleted."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."}},"summary":"Delete notification channel","tags":["Notification center configuration"]}}}}
```

## Facility-level configurations

## Get facility notification config

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Returns the notification center facility configuration.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to configure the notification center.","name":"Notification center configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NotificationCenterConfig":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannel"},{"$ref":"#/components/schemas/ClientNotificationChannel"}]},"maxItems":100,"type":"array"},"created":{"format":"date-time","type":"string"},"lastModified":{"format":"date-time","type":"string"},"version":{"type":"number"}},"required":["version","created","lastModified","channels"],"title":"NotificationCenterConfig","type":"object","description":"NotificationCenterConfig"},"EmailNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","id","receiver"],"title":"EmailNotificationChannel","type":"object","description":"EmailNotificationChannel"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type","id"],"title":"ClientNotificationChannel","type":"object","description":"ClientNotificationChannel"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityRef}/configurations/notifications":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Returns the notification center facility configuration.","operationId":"getNotificationCenterFacilityConfig","parameters":[{"in":"path","name":"facilityRef","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCenterConfig"}}},"description":"The notification center facility configuration was successfully returned."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get facility notification config","tags":["Notification center configuration"]}}}}
```

## Call facility notification action

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Executes an action to manipulate the notification center facility configuration.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to configure the notification center.","name":"Notification center configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AddChannelAction":{"properties":{"channel":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannelForCreation"},{"$ref":"#/components/schemas/ClientNotificationChannelForCreation"}]},"name":{"enum":["ADD_CHANNEL"],"type":"string"},"version":{"type":"number"}},"required":["name","channel","version"],"title":"AddChannelAction","type":"object","description":"AddChannelAction"},"EmailNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","receiver"],"title":"EmailNotificationChannelForCreation","type":"object","description":"EmailNotificationChannelForCreation"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type"],"title":"ClientNotificationChannelForCreation","type":"object","description":"ClientNotificationChannelForCreation"},"UpdateChannelByIdAction":{"properties":{"channel":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannel"},{"$ref":"#/components/schemas/ClientNotificationChannel"}]},"name":{"enum":["UPDATE_CHANNEL"],"type":"string"},"version":{"type":"number"}},"required":["name","channel","version"],"title":"UpdateChannelByIdAction","type":"object","description":"UpdateChannelByIdAction"},"EmailNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","id","receiver"],"title":"EmailNotificationChannel","type":"object","description":"EmailNotificationChannel"},"ClientNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type","id"],"title":"ClientNotificationChannel","type":"object","description":"ClientNotificationChannel"},"NotificationCenterConfig":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannel"},{"$ref":"#/components/schemas/ClientNotificationChannel"}]},"maxItems":100,"type":"array"},"created":{"format":"date-time","type":"string"},"lastModified":{"format":"date-time","type":"string"},"version":{"type":"number"}},"required":["version","created","lastModified","channels"],"title":"NotificationCenterConfig","type":"object","description":"NotificationCenterConfig"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityRef}/configurations/notifications/actions":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Executes an action to manipulate the notification center facility configuration.","operationId":"executeNotificationCenterFacilityConfigAction","parameters":[{"in":"path","name":"facilityRef","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AddChannelAction"},{"$ref":"#/components/schemas/UpdateChannelByIdAction"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCenterConfig"}}},"description":"Notification center facility configuration action was successfully executed."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."}},"summary":"Call facility notification action","tags":["Notification center configuration"]}}}}
```

## Update facility notification config

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Update the notification center facility configuration.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to configure the notification center.","name":"Notification center configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NotificationCenterConfigForUpdate":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannelForCreation"},{"$ref":"#/components/schemas/ClientNotificationChannelForCreation"}]},"maxItems":100,"type":"array"},"version":{"type":"number"}},"required":["channels","version"],"title":"NotificationCenterConfigForUpdate","type":"object","description":"NotificationCenterConfigForUpdate"},"EmailNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","receiver"],"title":"EmailNotificationChannelForCreation","type":"object","description":"EmailNotificationChannelForCreation"},"EmailReceiver":{"properties":{"email":{"format":"email","type":"string"},"language":{"$ref":"#/components/schemas/SupportedLocale"}},"required":["email","language"],"title":"EmailReceiver","type":"object","description":"EmailReceiver"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"ClientNotificationChannelForCreation":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type"],"title":"ClientNotificationChannelForCreation","type":"object","description":"ClientNotificationChannelForCreation"},"NotificationCenterConfigForCreation":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannelForCreation"},{"$ref":"#/components/schemas/ClientNotificationChannelForCreation"}]},"maxItems":100,"type":"array"}},"required":["channels"],"title":"NotificationCenterConfigForCreation","type":"object","description":"NotificationCenterConfigForCreation"},"NotificationCenterConfig":{"properties":{"channels":{"items":{"oneOf":[{"$ref":"#/components/schemas/EmailNotificationChannel"},{"$ref":"#/components/schemas/ClientNotificationChannel"}]},"maxItems":100,"type":"array"},"created":{"format":"date-time","type":"string"},"lastModified":{"format":"date-time","type":"string"},"version":{"type":"number"}},"required":["version","created","lastModified","channels"],"title":"NotificationCenterConfig","type":"object","description":"NotificationCenterConfig"},"EmailNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"receiver":{"items":{"$ref":"#/components/schemas/EmailReceiver"},"maxItems":200,"type":"array","uniqueItems":true},"type":{"enum":["EMAIL"],"type":"string"}},"required":["enabled","events","type","id","receiver"],"title":"EmailNotificationChannel","type":"object","description":"EmailNotificationChannel"},"ClientNotificationChannel":{"properties":{"enabled":{"type":"boolean"},"events":{"description":"Supported events for triggering external notifications: PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE, INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED, ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED, ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED, ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.","items":{"enum":["PICK_JOB_CREATED","UPCOMING_TIME_TRIGGERED_REROUTE","INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED","ROUTING_PLAN_NOT_ROUTABLE","ROUTING_PLAN_WAITING","ORDER_MODIFIED","ORDER_UNLOCKED","LOCKED_ORDER_CREATED","ORDER_FORCE_CANCELLED","ORDER_CANCELLED_BY_EXPIRY","ORDER_CANCELLED"],"type":"string"},"maxItems":50,"type":"array","uniqueItems":true},"id":{"type":"string"},"type":{"enum":["CLIENT"],"type":"string"}},"required":["enabled","events","type","id"],"title":"ClientNotificationChannel","type":"object","description":"ClientNotificationChannel"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityRef}/configurations/notifications":{"put":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Update the notification center facility configuration.","operationId":"upsertNotificationCenterFacilityConfig","parameters":[{"in":"path","name":"facilityRef","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/NotificationCenterConfigForUpdate"},{"allOf":[{"$ref":"#/components/schemas/NotificationCenterConfigForCreation"}],"not":{"required":["version"]},"type":"object"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCenterConfig"}}},"description":"Notification center facility configuration was successfully updated."},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationCenterConfig"}}},"description":"Notification center facility configuration was successfully created."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."}},"summary":"Update facility notification config","tags":["Notification center configuration"]}}}}
```

## Delete facility notification channel

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Delete the notification facility channel.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to configure the notification center.","name":"Notification center configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityRef}/configurations/notifications/channels/{channelId}":{"delete":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Delete the notification facility channel.","operationId":"deleteNotificationCenterFacilityConfigChannel","parameters":[{"in":"path","name":"facilityRef","required":true,"schema":{"type":"string"}},{"in":"path","name":"channelId","required":true,"schema":{"type":"string"}},{"in":"query","name":"version","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Notification center facility config channel was successfully deleted."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."}},"summary":"Delete facility notification channel","tags":["Notification center configuration"]}}}}
```


# Facilities

Facilities represent various locations that form part of the fulfillment network. These locations fulfill distinct roles in ensuring the smooth movement of goods, both inbound and outbound.

Managed facilities are fulfillment locations operated and controlled within the network. The defining characteristic of these facilities is that the complete operational fulfillment process, including picking, packing, shipping, and related tasks, is managed internally or by a partner.

Suppliers are external entities within the supply chain that provide products to the network. These can include manufacturers, publishers, wholesalers, and distributors, among others.

For fulfillmenttools, everything is attached to a facility. Without one, a consumer[^1] could never receive their order.

{% hint style="success" %}
At least one facility must be created within fulfillmenttools to work.
{% endhint %}

## Facility types

There are two primary types of facilities: [managed facilities](#managed-facilities) and [supplier facilities](#supplier-facilities).

The differentiation between managed and supplier facilities is fundamental for the efficient configuration of any fulfillment network, ensuring that each facility type is leveraged appropriately within the broader order management processes.

| Attribute                     | Managed facilities                    | Supplier facilities                         |
| ----------------------------- | ------------------------------------- | ------------------------------------------- |
| Fulfillment operations        | Managed within the network            | Managed externally by supplier              |
| Inventory role                | Storage, order fulfillment, transfers | Source of inventory                         |
| Carrier and logistics control | Full visibility and control           | Limited or no control                       |
| End customer interaction      | Direct fulfillment or pickup possible | Typically not interacting with end customer |
| Example entities              | Distribution centers, retail stores   | Manufacturers, publishers, wholesalers      |

In the facilities endpoints, these are the `type` of either `MANAGED_FACILITY` or `SUPPLIER`. Depending on which `type` you're using, will determine which fields are required to input.

### Managed facilities <a href="#managed-facilities" id="managed-facilities"></a>

Managed facilities represent stores, warehouses, or other locations where orders can be fulfilled. They are fulfillment locations that are directly operated and controlled within the network. The defining characteristic of these facilities is that the complete operational fulfillment process, including picking, packing, shipping, and related tasks, is managed internally or by a partner.

Managed facilities represent stores, warehouses, or other locations where orders can be fulfilled. The configuration made for a facility can have an influence on the routing decision as well as on the data displayed in the apps and clients

**Key attributes of managed facilities:**

* **Physical location and capabilities**: Comprehensive information regarding each facility’s address, working hours, fulfillment capacity, and handling capabilities is maintained within the system.
* [**Carrier integrations**](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/carrier-management): Managed facilities are integrated with specific shipping carriers. fulfillmenttools tracks available carriers as well as their respective pickup times and schedules.
* **Fulfillment focus**: Typically, managed facilities handle **direct-to-consumer** deliveries. Orders are picked, packed, and shipped directly to the end customer. In certain cases, customers may also have the option to collect their orders directly from these facilities.
* [**Interfacility transfers**:](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/interfacility-transfer) In addition to serving customers, managed facilities support **i**nterfacility transfers, enabling the efficient movement of stock between different managed locations.

A facility has both an external and an internal name. The external name is, for example, used as the sender address on a shipping label and should feature the company name itself. The internal name can be used to differentiate between different facilities.

#### **Status**

A facility can have one of three statuses with different implications for views and routing:

* Online
  * The facility is considered for order routing
  * The facility is accessible in Backoffice
* Suspended
  * The facility is not considered for order routing
  * The facility is accessible in Backoffice
* Offline
  * The facility is not considered for order routing
  * The facility is not accessible in Backoffice

If a facility is no longer used for order fulfillment, it's recommended to set its status to **Suspended**. As a consequence, no new orders are assigned to this facility. After all operational processes have been completed (and no more returns are expected for this facility), the facility can be set to **Offline**. This should be done only if there is no longer any operational need to access the facility.

#### **Location type**

A managed facility can have a location type of `store`, `warehouse`, or `external`. These can then be used to define routing rules.

#### **Service type**

A managed facility can be of service type `shipping`, `pickup`, or both. The service type has an impact on the routing decision and on the views and settings in the [Store Operations app](https://docs.fulfillmenttools.com/documentation/apps/store-operations-app).

<table><thead><tr><th width="159">Service type</th><th>Store Operations app</th><th>Routing decision impact</th></tr></thead><tbody><tr><td>Click-and-collect (<code>pickup</code>)</td><td><ul><li>Click-and-collect handover section is shown</li></ul></td><td>Facilities aren't considered in routing decisions, as the decision of which facility the consumer wants to pick up her click-and-collect order from has already been made in the webshop.</td></tr><tr><td>Ship-from-Store (<code>shipping</code>)</td><td><ul><li>Label section is shown</li><li>Ship-from-store handover section is shown</li><li>Switch is shown offering to order a label or pick another task when reaching end of picking</li></ul></td><td>Only facilities of type <code>shipping</code> are considered when routing a ship-from-store order.</td></tr></tbody></table>

#### Fulfillment day and time

Fulfillment times are the days and time on which fulfillment is performed in the facility. They can but do not have to be equal to the opening times of a facility. Fulfillment times can be configured for each day individually. Fulfillment times can also be configured within the [network overview settings](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/settings) for multiple facilities.

Fulfillment times are considered within fulfillmenttools, for example, when a [target time](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking/pick-job-target-time) is generated or when a [time-triggered reroute](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/reroute#rerouting-rerouteincaseofinactivity-time-triggeredreroute) takes place.

{% hint style="info" %}
In case fulfillment times are not configured, there is a fallback on tenant level in place. By default, fulfillment times are set to: Monday-Saturday, from 09:00 to 17:00.
{% endhint %}

#### Fulfillment capacity <a href="#facilities-fulfillmentcapacity" id="facilities-fulfillmentcapacity"></a>

The fulfillment capacity can be defined for each time slot within the facility settings. It reflects the number of orders, respectively pick jobs, that can be fulfilled in the time slot. When an order is routed to a facility with capacity information, the capacity value is reduced by the order for the [next free capacity slot](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/ratings#ratings-nextfreecapacity-2). To ensure that fulfillment capacities are considered within the routing, the capacity [fence](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/fences) or [rating](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/ratings) need to be activated.

[See the Pick job target time article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking/pick-job-target-time) for more information on how the target time of an order is calculated considering capacities.

#### **Fulfillment closing times**

Fulfillment closing times are certain days where no fulfillment at all takes place such as Sundays or holidays. Fulfillment closing days can also be configured within the [network overview settings](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/settings#fulfillment-times-for-multiple-facilities) for multiple facilities.

{% hint style="warning" %}
If a bulk update on fulfillment times and closing days is saved, already submitted times are overwritten.
{% endhint %}

#### Average fulfillment duration (fulfillment buffer) <a href="#facilities-averagefulfillmentduration" id="facilities-averagefulfillmentduration"></a>

Average fulfillment duration is a lead time or buffer time which represents the time it takes for an order to be ready for handover to the shipping provider or to the customer. This corresponds to the time from the creation of the pick job to the completion of the handover. It is used to check whether a successful completion of the order can be ensured in a facility.

{% hint style="info" %}
This buffer time can be defined on facility level via [facility REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/facilities/-facilityId-) and in [Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/facility). Furthermore, an admin can define a tenant-wide default fallback via the [fulfillment process buffer REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/configurations/fulfillmentprocessbuffer), which is initially set to 240 minutes.
{% endhint %}

#### Carrier

Users can assign different carriers to a facility. With this information a [fence](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/fences) can be implemented where orders which need to be shipped by a chosen carrier are routed to a facility where this carrier is active. Carriers that are enabled on tenant level must also be enabled for the facilities in which the carrier is available.

#### Short pick

A short pick describes the case when an order could not be completely picked. This can happen when some ordered items were too low in stock or out of stock. By enabling the config, stock for an item in a facility is set to zero, if nothing or not enough could be picked for that item.

{% hint style="warning" %}
We strongly advise users to simultaneously activate the `confirmationOnShortPick` in the [picking configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking#picking-configuration). Otherwise systems cannot differentiate between cases where the user tried to pick an item and failed due to no available stock or cases where the pick job was rerouted before the user even tried to pick all ordered items.
{% endhint %}

{% hint style="info" %}
This setting can be defined in the facility section of [Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/settings) or via [facility stock configuration REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/facilities/-facilityId-/configurations/stock).
{% endhint %}

#### Storage principles

Storage principles for stock properties (such as expiry date) can be defined for each facility.

The unmixed storage principle means that the same item with different properties (for example, expiry date) must not be stored on the same storage location. Enabling unmixed storage has the following effects:

* If a user tries to stow the same items with different properties on the same storage location, a user warning is shown.
* Storage location recommendations are only locations where the unmixed storage principle is met.

The unmixed storage configuration should be deactivated if stock properties are not relevant while stowing or relocating items.

{% hint style="info" %}
This setting can be defined in the facility section of [Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/settings) or via [facility inventory configuration API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/facilities/-facilityId-/configurations/inventory).
{% endhint %}

### Supplier facilities <a href="#supplier-facilities" id="supplier-facilities"></a>

Suppliers are external entities within the supply chain that provide products to the network. These might include manufacturers, publishers, wholesalers, and distributors, among others.

In contrast to managed facilities, the operational responsibility at supplier locations lies entirely outside the network's control. A supplier may operate multiple physical locations, but these individual sites are typically not known to the fulfillment network. Consequently, the supplier facility information, such as addresses, working hours, capacity limits, or specific shipping carrier integrations aren't maintained for supplier facilities.

**Key attributes of suppliers:**

* **External fulfillment operations**: Unlike managed facilities, the operational fulfillment processes at supplier locations are outside the direct control of the network. Tasks such as picking, packing, and shipping are managed by the suppliers themselves, following their own processes and schedules.
* **Supply chain role**: Suppliers primarily act as the upstream source of inventory, supplying goods to be stocked within managed facilities or shipped directly depending on the fulfillment strategy.

#### Implication on routing decisions

This lack of visibility has important implications for certain standard [routing rules](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/routing-strategy). Since key data points about supplier facilities are unavailable, some rules can only consider the supplier part of the supply chain to a limited extent when dealing with supplier facilities. For example:

* The **geo distance rating** does not factor in transport routes originating from suppliers, as their exact locations might not be known.
* The **country fence** rule does not take into account the geographical location of supplier facilities.

These constraints should be considered when configuring routing strategies, especially when suppliers play a significant role in the overall fulfillment flow.

#### Supplier facility data

Supplier facility data is limited to a few key attributes due to the reasons mentioned above. These attributes are interpreted similarly to those of managed facilities:

<table><thead><tr><th>Field</th><th>Type<select><option value="notHR1UnsV6J" label="string" color="blue"></option><option value="bwlrbrUXvPkP" label="enum" color="blue"></option><option value="kavqY0hl9M1v" label="object" color="blue"></option><option value="dseU2XdLmWRb" label="array" color="blue"></option></select></th><th>Information</th><th>Required<select><option value="Nu7LGraVf5xE" label="Yes" color="blue"></option><option value="YghRrqUAeGRI" label="No" color="blue"></option></select></th></tr></thead><tbody><tr><td><code>name</code></td><td><span data-option="notHR1UnsV6J">string</span></td><td>A descriptive name of the supplier facility to identify it.</td><td><span data-option="Nu7LGraVf5xE">Yes</span></td></tr><tr><td><code>status</code></td><td><span data-option="bwlrbrUXvPkP">enum</span></td><td>The status of the supplier facility. See the <a href="#facility-status">Facility status section</a> for enum options and their definitions.</td><td><span data-option="Nu7LGraVf5xE">Yes</span></td></tr><tr><td><code>tenantFacilityId</code></td><td><span data-option="notHR1UnsV6J">string</span></td><td>An identifier that often serves as a foreign key corresponding to an ID in an external system. See the <a href="https://docs.fulfillmenttools.com/documentation/apis/api-reference#uniform-resource-name-pattern-urn-in-path-parameters">URN pattern parameters section</a> for more details.</td><td><span data-option="YghRrqUAeGRI">No</span></td></tr><tr><td><code>address</code></td><td><span data-option="kavqY0hl9M1v">object</span></td><td>The address of the supplier facility.</td><td><span data-option="YghRrqUAeGRI">No</span></td></tr><tr><td><code>customAttributes</code></td><td><span data-option="kavqY0hl9M1v">object</span></td><td>Store any relevant data to the entity you want (within reason) if our current properties don't fit your needs. See the <a href="https://docs.fulfillmenttools.com/documentation/getting-started/custom-attributes">custom attributes article</a> for more details.</td><td><span data-option="YghRrqUAeGRI">No</span></td></tr><tr><td><code>tags</code></td><td><span data-option="dseU2XdLmWRb">array</span></td><td>Map individual processes and customize entities. See the <a href="https://docs.fulfillmenttools.com/documentation/getting-started/tags">tags article</a> for more details.</td><td><span data-option="YghRrqUAeGRI">No</span></td></tr></tbody></table>

{% hint style="info" %}
Supplier facilities can also have [listings](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing) assigned to them.

But [facility carrier connections](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/carrier-management) and [facility custom service connections](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/custom-services) can't be applied for supplier facilities.
{% endhint %}

## Create a managed facility

{% hint style="info" %}
You can also create [facilities in Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/facilities).
{% endhint %}

{% stepper %}
{% step %}
**Make the `POST` request to create a facility**

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://ocff-{PROJECT_ID}.fulfillmenttools.com/api/facilities
```

{% endtab %}

{% tab title="Request" %}

```json
{
  "name": "Nerd Herd Clothing",
  "type": "MANAGED_FACILITY",
  "address": {
    "companyName": "Nerd Herd Clothing Ltd",
    "country": "US",
    "postalCode": "42420",
    "city": "Los Angeles",
    "street": "Bison Drive",
    "houseNumber": "42"
  },
    "services": [
        {
            "type": "SHIP_FROM_STORE"
        }
    ],
    "status": "ONLINE",
    "locationType": "STORE"
}
```

{% hint style="info" %}
The fields `services` and `locationType` are not required, but it's highly recommended to include at least the `services` section so the store can receive orders.
{% endhint %}
{% endtab %}

{% tab title="Response" %}
If the request is successful, you'll receive a `201 CREATED` response with a body like this:

```json
{
  "name": "Nerd Herd Clothing",
  "type": "MANAGED_FACILITY",
  "address": {
    "companyName": "Nerd Herd Clothing Ltd",
    "country": "US",
    "postalCode": "42420",
    "city": "Los Angeles",
    "street": "Bison Drive",
    "houseNumber": "42"
  },
    "services": [
        {
            "type": "SHIP_FROM_STORE"
        }
    ],
    "status": "ONLINE",
    "locationType": "STORE",
    "fulfillmentProcessBuffer": 240,
    "capacityEnabled": false,
    "created": "2023-08-22T14:39:27.014Z",
    "lastModified": "2023-08-22T14:39:27.014Z",
    "version": 1,
    "id": "{YOUR_FACILITY_ID}"
}
```

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
**Add precise latitude and longitude**

Each facility needs valid geo coordinates (latitude and longitude) for use in the routing engine. If coordinates are missing in the `address` object, the system will attempt to resolve them based on the provided address (city center).

To provide precise coordinates, include `resolvedCoordinates` inside the `address` object, for example:

{% code title="address-with-coordinates.json" %}

```json
{
    // Facility object
    ...
    "address": {
        ...
        "resolvedCoordinates": {
            "lat": 50.937531,
            "lon": 6.960279
        }
    }
}
```

{% endcode %}

City center approach geo data is based on [opendatasoft](https://public.opendatasoft.com/explore/dataset/geonames-postal-code/information/) under the [CC BY 4.0 license](https://creativecommons.org/licenses/by/4.0/).
{% endstep %}
{% endstepper %}

## Create a supplier facility

{% hint style="info" %}
You can also create [facilities in Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/facilities).
{% endhint %}

To create a supplier facility, make the `POST` request below:

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://ocff-{PROJECT_ID}.fulfillmenttools.com/api/facilities
```

{% endtab %}

{% tab title="Request" %}

```json
{
  "name": "Nerd Herd Distribution",
  "type": "SUPPLIER",
  "status": "ONLINE"
}
```

{% endtab %}

{% tab title="Response" %}

```json
{
    "type": "SUPPLIER",
    "name": "Nerd Herd Distribution",
    "status": "ONLINE",
    "version": 1,
    "lastModified": "2026-07-10T12:26:46.790Z",
    "id": "{YOUR_FACILITY_ID}",
    "created": "2026-07-10T12:26:46.790Z"
}
```

{% endtab %}
{% endtabs %}

## Edit a facility

Once created, you can edit a supplier or managed facility using the below endpoint.

{% tabs %}
{% tab title="Endpoint" %}

```http
PUT https://ocff-{PROJECT_ID}.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}
```

{% endtab %}

{% tab title="Request" %}

```json
{
  "name": "Nerd Herd Clothing",
  "type": "MANAGED_FACILITY",
  "address": {
    "companyName": "Nerd Herd Clothing Ltd",
    "country": "US",
    "postalCode": "42420",
    "city": "Los Angeles",
    "street": "Bison Drive",
    "houseNumber": "42"
  },
    "services": [
        {
            "type": "SHIP_FROM_STORE"
        }
    ],
    "status": "ONLINE",
    "locationType": "STORE",
    "version": 1
}
```

{% hint style="info" %}
Ensure you include the version number.
{% endhint %}
{% endtab %}

{% tab title="Response" %}

```json
{
    "id": "{YOUR_FACILITY_ID}",
    "version": 2,
    "created": "2026-07-09T11:49:16.147Z",
    "lastModified": "2026-11-12T07:07:04.989Z",
    "name": "Nerd Herd Clothing",
    "type": "MANAGED_FACILITY",
    "status": "ONLINE",
    "address": {
        "city": "Los Angeles",
        "companyName": "Nerd Herd Clothing Ltd",
        "country": "US",
        "houseNumber": "42",
        "postalCode": "42420",
        "resolvedCoordinates": {
            "lat": 34.0549076,
            "lon": -118.242643
        },
        "resolvedTimeZone": {
            "offsetInSeconds": -18000,
            "timeZoneId": "America/New_York",
            "timeZoneName": "Eastern Standard Time",
            "source": "BACKEND_GENERATED"
        },
        "street": "Bison Drive"
    },
    "fulfillmentProcessBuffer": 240,
    "locationType": "STORE",
    "services": [
        {
            "type": "SHIP_FROM_STORE"
        }
    ]
}
```

{% endtab %}
{% endtabs %}

The `PUT` request replaces all existing facility information with the update.

You can also edit some details in Backoffice in both the [Network](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/facilities) and [Facility](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/facility) views if you have the necessary permissions.

[^1]: The end user is making the purchase, whether online or offline.


# Facility endpoints

## The Facility object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"}}}}
```

## GET /api/facilities/{facilityId}

> Get facility

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"},"Supplier":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/SupplierForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddress"}},"type":"object","xml":{"name":"Supplier"},"title":"Supplier","description":"Supplier"},"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}":{"get":{"description":"","operationId":"getFacility","parameters":[{"description":"ID of facility you want to get. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ManagedFacility"},{"$ref":"#/components/schemas/Supplier"}]}}},"description":"Facility was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"Get facility","tags":["Facilities"]}}}}
```

## POST /api/facilities

> Create facility

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"},"Supplier":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/SupplierForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddress"}},"type":"object","xml":{"name":"Supplier"},"title":"Supplier","description":"Supplier"},"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities":{"post":{"description":"","operationId":"addFacility","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ManagedFacilityForCreation"},{"$ref":"#/components/schemas/SupplierForCreation"}]}}},"description":"Representation that describes the facility","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ManagedFacility"},{"$ref":"#/components/schemas/Supplier"}]}}},"description":"The facility was successfully created. The Location header contains the URL of the facility."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create facility","tags":["Facilities"]}}}}
```

## PATCH /api/facilities/{facilityId}

> Update facility

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityPatchActions":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated; works only on managed facilities. Prefer to use ManagedFacilityForModification / SupplierForModification for full compatibility.","properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyFacility"},"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","actions"],"type":"object","xml":{"name":"FacilityPatchActions"},"title":"FacilityPatchActions","deprecated":true},"ModifyFacility":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyFacility', because you want to modify a facility","enum":["ModifyFacility"],"type":"string"},"address":{"$ref":"#/components/schemas/ModifyFacilityAddress"},"capacityEnabled":{"type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"fulfillmentProcessBuffer":{"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"properties":{"type":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"}},"required":["type"],"type":"object"},"type":"array"},"status":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyFacility"},"title":"ModifyFacility","description":"ModifyFacility"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"ModifyFacilityAddress":{"allOf":[{"$ref":"#/components/schemas/ModifyAddress"},{"type":"object"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object"},"type":"array"}},"type":"object"}],"title":"ModifyFacilityAddress","description":"ModifyFacilityAddress"},"ModifyAddress":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"street":{"pattern":"^.+$","type":"string"}},"type":"object","title":"ModifyAddress","description":"ModifyAddress"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ManagedFacilityForModification":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"description":"Indicates that configured capacity limits for picking times are considered","nullable":true,"type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"nullable":true,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"nullable":true,"type":"array"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"nullable":true,"type":"array"},"contact":{"allOf":[{"$ref":"#/components/schemas/FacilityContact"}],"nullable":true,"type":"object"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"fulfillmentProcessBuffer":{"description":"Duration in minutes until an order is processed","minimum":0,"nullable":true,"type":"integer"},"locationType":{"allOf":[{"$ref":"#/components/schemas/FacilityLocationType"}],"nullable":true,"type":"string"},"name":{"type":"string"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"nullable":true,"type":"array"},"pickingTimes":{"allOf":[{"$ref":"#/components/schemas/PickingTimes"}],"nullable":true,"type":"object"},"scanningRule":{"allOf":[{"$ref":"#/components/schemas/ScanningRuleConfiguration"}],"nullable":true,"type":"object"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"nullable":true,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","nullable":true,"type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"nullable":true,"type":"array"}},"required":["type","version"],"type":"object","xml":{"name":"ManagedFacilityForModification"},"title":"ManagedFacilityForModification","description":"ManagedFacilityForModification"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"SupplierForModification":{"additionalProperties":false,"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"}],"nullable":true,"type":"object"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","nullable":true,"type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"nullable":true,"type":"array"}},"required":["type","version"],"type":"object","title":"SupplierForModification","description":"SupplierForModification"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"Supplier":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/SupplierForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddress"}},"type":"object","xml":{"name":"Supplier"},"title":"Supplier","description":"Supplier"},"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}":{"patch":{"description":"","operationId":"patchFacility","parameters":[{"description":"ID of facility you want to patch. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/FacilityPatchActions"},{"$ref":"#/components/schemas/ManagedFacilityForModification"},{"$ref":"#/components/schemas/SupplierForModification"}]}}},"description":"Patch set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ManagedFacility"},{"$ref":"#/components/schemas/Supplier"}]}}},"description":"Facility was found & patch-set has been applied. The patched facility is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility version conflict"}},"summary":"Update facility","tags":["Facilities"]}}}}
```

## PUT /api/facilities/{facilityId}

> Update facility

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ManagedFacilityForReplacement":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"name":{"type":"string"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"discriminator":{"propertyName":"type"},"required":["version","type","status","name","address","locationType","fulfillmentProcessBuffer","capacityEnabled"],"type":"object","xml":{"name":"ManagedFacilityForReplacement"},"title":"ManagedFacilityForReplacement","description":"ManagedFacilityForReplacement"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"SupplierForReplacement":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"},"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["version","name","status","type"],"type":"object","discriminator":{"propertyName":"type"},"xml":{"name":"SupplierForReplacement"},"title":"SupplierForReplacement","description":"SupplierForReplacement"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"Supplier":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/SupplierForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddress"}},"type":"object","xml":{"name":"Supplier"},"title":"Supplier","description":"Supplier"},"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}":{"put":{"operationId":"replaceFacility","parameters":[{"description":"ID of facility you want to replace. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ManagedFacilityForReplacement"},{"$ref":"#/components/schemas/SupplierForReplacement"}],"discriminator":{"propertyName":"type","mapping":{"MANAGED_FACILITY":"#/components/schemas/ManagedFacilityForReplacement","SUPPLIER":"#/components/schemas/SupplierForReplacement"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ManagedFacility"},{"$ref":"#/components/schemas/Supplier"}]}}},"description":"Facility was replaced. The replaced facility is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility version conflict"}},"summary":"Update facility","tags":["Facilities"]}}}}
```

## DELETE /api/facilities/{facilityId}

> Delete facility

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}":{"delete":{"description":"","operationId":"deleteFacility","parameters":[{"description":"ID of facility you want to delete. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"cascading deletion without pre condition check","in":"query","name":"forceDeletion","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"Facility was found & you were allowed to delete it."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"Delete facility","tags":["Facilities"]}}}}
```

## GET /api/facilities

> List facilities

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityOrderBy":{"description":"Attribute to order a facility list","enum":["NAME","CREATED","POSTAL_CODE_ASC"],"type":"string","xml":{"name":"FacilityOrderBy"},"title":"FacilityOrderBy"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"StrippedFacilities":{"properties":{"facilities":{"items":{"anyOf":[{"$ref":"#/components/schemas/StrippedManagedFacility"},{"$ref":"#/components/schemas/Supplier"}]},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedFacilities","description":"StrippedFacilities"},"StrippedManagedFacility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/Address"},{"properties":{"id":{"type":"string"},"name":{"description":"name of the facility","type":"string"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType"}},"required":["id","status","type"],"type":"object"}],"title":"StrippedManagedFacility","description":"StrippedManagedFacility"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"Supplier":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/SupplierForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddress"}},"type":"object","xml":{"name":"Supplier"},"title":"Supplier","description":"Supplier"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities":{"get":{"description":"","operationId":"getAllFacilities","parameters":[{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"Reference to the status you want to get the corresponding facilities","explode":true,"in":"query","name":"status","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"number of facilities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"query facilities with the given tenantFacilityId","in":"query","name":"tenantFacilityId","required":false,"schema":{"type":"string"}},{"description":"query facilities orderBy","in":"query","name":"orderBy","required":false,"schema":{"$ref":"#/components/schemas/FacilityOrderBy"}},{"description":"Filters the facilities by type","explode":true,"in":"query","name":"type","required":false,"schema":{"items":{"$ref":"#/components/schemas/FacilityType"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrippedFacilities"}}},"description":"Facilities are found."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List facilities","tags":["Facilities"]}}}}
```

## List facilities (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for Facility

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilitySearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/FacilitySearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/FacilitySort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"FacilitySearchPayload","type":"object","description":"FacilitySearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"FacilitySearchQuery":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressFilter"}],"description":"Nested search by address"},"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/FacilitySearchQuery"},"maxItems":500,"type":"array"},"contact":{"allOf":[{"$ref":"#/components/schemas/FacilityContactFilter"}],"description":"Nested search by contact"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityGroupIds":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Filter facilities by facility group membership"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"locationType":{"allOf":[{"$ref":"#/components/schemas/FacilityLocationTypeEnumFilter"}],"description":"Search by locationType"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/FacilitySearchQuery"},"maxItems":500,"type":"array"},"referenced":{"allOf":[{"$ref":"#/components/schemas/FacilityReferenceFilter"}],"description":"References to other entities"},"services":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesListFilter"}],"description":"Nested list search by services"},"status":{"allOf":[{"$ref":"#/components/schemas/FacilityStatusEnumFilter"}],"description":"Search by status"},"tenantFacilityId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantFacilityId"},"type":{"allOf":[{"$ref":"#/components/schemas/FacilityTypeEnumFilter"}],"description":"Search by type"},"tags":{"allOf":[{"$ref":"#/components/schemas/FacilityTagsListFilter"}],"description":"Nested list search by tags"}},"title":"FacilitySearchQuery","type":"object","description":"FacilitySearchQuery"},"FacilityAddressFilter":{"properties":{"city":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"emailAddresses":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesListFilter"}],"description":"Nested list search by emailAddresses"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"FacilityAddressFilter","type":"object","description":"FacilityAddressFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"FacilityAddressEmailAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityAddressEmailAddressesListFilter","type":"object","description":"FacilityAddressEmailAddressesListFilter"},"FacilityAddressEmailAddressesFilter":{"properties":{"recipient":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recipient"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityAddressEmailAddressesFilter","type":"object","description":"FacilityAddressEmailAddressesFilter"},"FacilityContactFilter":{"properties":{"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"}},"title":"FacilityContactFilter","type":"object","description":"FacilityContactFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"FacilityLocationTypeEnumFilter":{"properties":{"eq":{"description":"Search by locationType","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"},"in":{"description":"Search by locationType","items":{"enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by locationType","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"}},"title":"FacilityLocationTypeEnumFilter","type":"object","description":"FacilityLocationTypeEnumFilter"},"FacilityReferenceFilter":{"properties":{"facilityCarrierConnection":{"allOf":[{"$ref":"#/components/schemas/FacilityFacilityCarrierConnectionFilter"}],"description":"The referenced entity"}},"title":"FacilityReferenceFilter","type":"object","description":"FacilityReferenceFilter"},"FacilityFacilityCarrierConnectionFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Filter facilities by configured carrier key"}},"title":"FacilityFacilityCarrierConnectionFilter","type":"object","description":"FacilityFacilityCarrierConnectionFilter"},"FacilityServicesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityServicesListFilter","type":"object","description":"FacilityServicesListFilter"},"FacilityServicesFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFacilityServiceTypeEnumFilter"}],"description":"Search by type"}},"title":"FacilityServicesFilter","type":"object","description":"FacilityServicesFilter"},"FacilityServicesFacilityServiceTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"}},"title":"FacilityServicesFacilityServiceTypeEnumFilter","type":"object","description":"FacilityServicesFacilityServiceTypeEnumFilter"},"FacilityStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"}},"title":"FacilityStatusEnumFilter","type":"object","description":"FacilityStatusEnumFilter"},"FacilityTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"}},"title":"FacilityTypeEnumFilter","type":"object","description":"FacilityTypeEnumFilter"},"FacilityTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityTagsListFilter","type":"object","description":"FacilityTagsListFilter"},"FacilityTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityTagsFilter","type":"object","description":"FacilityTagsFilter"},"FacilitySort":{"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressSort"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"id":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"locationType":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"services":{"$ref":"#/components/schemas/FacilityServicesSort"},"status":{"enum":["ASC","DESC"],"type":"string"},"tenantFacilityId":{"enum":["ASC","DESC"],"type":"string"},"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilitySort","type":"object","description":"FacilitySort"},"FacilityAddressSort":{"properties":{"city":{"enum":["ASC","DESC"],"type":"string"},"country":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityAddressSort","type":"object","description":"FacilityAddressSort"},"FacilityServicesSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityServicesSort","type":"object","description":"FacilityServicesSort"},"FacilityPaginatedResult":{"properties":{"facilities":{"items":{"oneOf":[{"$ref":"#/components/schemas/ManagedFacility"},{"$ref":"#/components/schemas/Supplier"}]},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","facilities"],"title":"FacilityPaginatedResult","type":"object","description":"FacilityPaginatedResult"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"},"Supplier":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/SupplierForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddress"}},"type":"object","xml":{"name":"Supplier"},"title":"Supplier","description":"Supplier"},"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for Facility","operationId":"searchFacility","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilitySearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List facilities (search)","tags":["Facilities"]}}}}
```


# Facility groups

Facility groups can be used to mark individual facilities as belonging to a specific group. A facility can be part of several facility groups.

Facilities can be assigned to a group by:

1. Creating a facility group via [API](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/facility-groups/facility-group-endpoints)
2. Referencing the ID of the facilities in the respective facility group
3. Creating a facility group in Backoffice

Facility groups can be used, for example, to define [sales prices](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes#sales-price-with-currency) for certain facility groups.

## Create a facility group

To create a facility group, send a `POST` request to the following endpoint with a JSON body.

```http
POST https://ocff-{PROJECT_ID}.api.fulfillmenttools.com/api/facilitygroups
```

The `tenantFacilityGroupId` is the internal ID that you can use to reference the facility group. This follows the [URN pattern](https://docs.fulfillmenttools.com/documentation/apis/api-reference#uniform-resource-name-pattern-urn-in-path-parameters).

The `facilityRefs` are the `id` of each facility you want to include in the facility group.

The `nameLocalized` will be displayed in the clients.

```json
{
  "tenantFacilityGroupId": "US_WC",
  "facilityRefs": [
    "871c1620-3757-4242-9a8d-5d20b81cadde_96358521",
    "bc6fd1f7-cbbf-41da-938d-01a68d90a926_0001a6c5",
    "bc6fd1f7-cbbf-41da-938d-01a68d90a926_003fcc05"
  ],
  "nameLocalized": {
    "de_DE": "US Westen",
    "en_US": "US West Coast"
  }
}
```

A successful request returns a `201 Created` response with the created facility group object in the body:

```json
{
    "version": 1,
    "nameLocalized": {
        "de_DE": "US Westen",
        "en_US": "US West Coast"
    },
    "tenantFacilityGroupId": "US_WC",
    "facilityRefs": [
        "871c1620-3757-4242-9a8d-5d20b81cadde_96358521",
        "bc6fd1f7-cbbf-41da-938d-01a68d90a926_0001a6c5",
        "bc6fd1f7-cbbf-41da-938d-01a68d90a926_003fcc05"
    ],
    "lastModified": "2025-04-29T12:26:15.844Z",
    "id": "26c594fc-d26a-4bad-a930-dda610c85678",
    "created": "2025-04-29T12:26:15.844Z",
    "name": "US West Coast"
}
```


# Facility group endpoints

## The FacilityGroup object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"}}}}
```

## Create facility group

> Creates a new facility group.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facility groups combine one or multiple facilities into logical groups.","name":"Facility groups"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityGroupForCreation":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized"],"title":"FacilityGroupForCreation","type":"object","description":"FacilityGroupForCreation"},"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilitygroups":{"post":{"deprecated":false,"description":"Creates a new facility group.","operationId":"addFacilityGroup","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroupForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroup"}}},"description":"The facility group was successfully created."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create facility group","tags":["Facility groups"]}}}}
```

## List facility groups

> Get all facility groups with pagination.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facility groups combine one or multiple facilities into logical groups.","name":"Facility groups"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityGroups":{"properties":{"facilityGroups":{"description":"Array of facility groups","items":{"$ref":"#/components/schemas/FacilityGroup"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"number"}},"title":"FacilityGroups","type":"object","description":"FacilityGroups"},"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilitygroups":{"get":{"deprecated":false,"description":"Get all facility groups with pagination.","operationId":"getAllFacilityGroups","parameters":[{"in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"in":"query","name":"tenantFacilityGroupId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroups"}}},"description":"The facility groups that were found based on the given filters."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List facility groups","tags":["Facility groups"]}}}}
```

## Delete facility group

> Delete facility group by id.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facility groups combine one or multiple facilities into logical groups.","name":"Facility groups"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilitygroups/{facilityGroupId}":{"delete":{"deprecated":false,"description":"Delete facility group by id.","operationId":"deleteFacilityGroup","parameters":[{"in":"path","name":"facilityGroupId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Facility group was found and deleted."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Delete facility group","tags":["Facility groups"]}}}}
```

## Get facility group

> Get facility group by id.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facility groups combine one or multiple facilities into logical groups.","name":"Facility groups"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilitygroups/{facilityGroupId}":{"get":{"deprecated":false,"description":"Get facility group by id.","operationId":"getFacilityGroup","parameters":[{"in":"path","name":"facilityGroupId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroup"}}},"description":"Facility group was found. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get facility group","tags":["Facility groups"]}}}}
```

## Call facility group action

> Perform action on a facility group. Supported actions are defined in the request body.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facility groups combine one or multiple facilities into logical groups.","name":"Facility groups"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AddFacilitiesToGroupActionParameter":{"properties":{"facilitiesToAdd":{"description":"Array of facility references to add to the group. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"maxItems":200,"minItems":1,"type":"array"},"name":{"description":"The name of the action","enum":["ADD_FACILITIES_TO_GROUP"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"number"}},"required":["name","facilitiesToAdd"],"title":"AddFacilitiesToGroupActionParameter","type":"object","description":"AddFacilitiesToGroupActionParameter"},"AddFacilitiesToGroupVersionlessActionParameter":{"properties":{"facilitiesToAdd":{"description":"Array of facility references to add to the group. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"maxItems":200,"minItems":1,"type":"array"},"name":{"description":"The name of the action","enum":["VERSIONLESS_ADD_FACILITIES_TO_GROUP"],"type":"string"}},"required":["name","facilitiesToAdd"],"title":"AddFacilitiesToGroupVersionlessActionParameter","type":"object","description":"AddFacilitiesToGroupVersionlessActionParameter"},"RemoveFacilitiesFromGroupActionParameter":{"properties":{"facilitiesToRemove":{"description":"Array of facility references to remove from the group","items":{"type":"string"},"maxItems":200,"minItems":1,"type":"array"},"name":{"description":"The name of the action","enum":["REMOVE_FACILITIES_FROM_GROUP"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"number"}},"required":["facilitiesToRemove","name","version"],"title":"RemoveFacilitiesFromGroupActionParameter","type":"object","description":"RemoveFacilitiesFromGroupActionParameter"},"RemoveFacilitiesFromGroupVersionlessActionParameter":{"properties":{"facilitiesToRemove":{"description":"Array of facility references to remove from the group","items":{"type":"string"},"maxItems":200,"minItems":1,"type":"array"},"name":{"description":"The name of the action","enum":["VERSIONLESS_REMOVE_FACILITIES_FROM_GROUP"],"type":"string"}},"required":["facilitiesToRemove","name"],"title":"RemoveFacilitiesFromGroupVersionlessActionParameter","type":"object","description":"RemoveFacilitiesFromGroupVersionlessActionParameter"},"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilitygroups/{facilityGroupId}/actions":{"post":{"deprecated":false,"description":"Perform action on a facility group. Supported actions are defined in the request body.","operationId":"facilityGroupAction","parameters":[{"in":"path","name":"facilityGroupId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AddFacilitiesToGroupActionParameter"},{"$ref":"#/components/schemas/AddFacilitiesToGroupVersionlessActionParameter"},{"$ref":"#/components/schemas/RemoveFacilitiesFromGroupActionParameter"},{"$ref":"#/components/schemas/RemoveFacilitiesFromGroupVersionlessActionParameter"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroup"}}},"description":"Updated facility group in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Call facility group action","tags":["Facility groups"]}}}}
```

## List facility groups (search)

> Search for FacilityGroup

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facility groups combine one or multiple facilities into logical groups.","name":"Facility groups"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityGroupSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/FacilityGroupSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/FacilityGroupSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"FacilityGroupSearchPayload","type":"object","description":"FacilityGroupSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"FacilityGroupSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/FacilityGroupSearchQuery"},"maxItems":500,"type":"array"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/LocalizedStringSearchFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/FacilityGroupSearchQuery"},"maxItems":500,"type":"array"},"tenantFacilityGroupId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantFacilityGroupId"}},"title":"FacilityGroupSearchQuery","type":"object","description":"FacilityGroupSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"LocalizedStringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"},"FacilityGroupSort":{"properties":{"facilityCount":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantFacilityGroupId":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityGroupSort","type":"object","description":"FacilityGroupSort"},"FacilityGroupPaginatedResult":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/FacilityGroup"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","facilityGroups"],"title":"FacilityGroupPaginatedResult","type":"object","description":"FacilityGroupPaginatedResult"},"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilitygroups/search":{"post":{"deprecated":false,"description":"Search for FacilityGroup","operationId":"searchFacilityGroup","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroupSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroupPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List facility groups (search)","tags":["Facility groups"]}}}}
```

## Update facility group

> Replace facility group by id. All updatable fields will be replaced with the values from the request. Fields that are not included in the request will be removed from the entity.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facility groups combine one or multiple facilities into logical groups.","name":"Facility groups"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityGroupForUpdate":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","type":"number"}},"required":["version"],"title":"FacilityGroupForUpdate","type":"object","description":"FacilityGroupForUpdate"},"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilitygroups/{facilityGroupId}":{"patch":{"deprecated":false,"description":"Replace facility group by id. All updatable fields will be replaced with the values from the request. Fields that are not included in the request will be removed from the entity.","operationId":"replaceFacilityGroup","parameters":[{"in":"path","name":"facilityGroupId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroupForUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroup"}}},"description":"Facility group was replaced. The replaced facility group is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."}},"summary":"Update facility group","tags":["Facility groups"]}}}}
```


# Prices and facility discounts

You can define different types of prices in fulfillmenttools. A shop price can be defined in the [attributes](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes) of the listing or the order. A sales price can be defined in the listing attributes of the selling facility's listing. And the purchase price is the result of a sales price to another facility.

Let's say we have a product called a Nerd Herd t-shirt. If a consumer buys it online from our website, they'll see the [shop price](#shop-price). If our Nerd Herd Clothing Los Angeles store buys it from the supplier, they'll see the [purchase price](#purchase-price) based on the [sales price](#sales-price) from the supplier.

| Facility           | Sales price set on the listing | Purchase price for the LA store with a 10% facility discount | Shop price for consumer set on the listing |
| ------------------ | ------------------------------ | ------------------------------------------------------------ | ------------------------------------------ |
| Nerd Herd supplier | €30                            | €27                                                          | €35                                        |

For the above to take effect, we'd need the following on our t-shirt listing, plus a facility discount set and a facility connection between our supplier and our LA store.

{% tabs %}
{% tab title="T-shirt listing code sample" %}

```json
{
    "listings": [
        {
            "tenantArticleId": "TSHIRT-W-2468",
            "title": "T-shirt",
            "decimalPlaces": 2,
            "attributes": [
                {
                    "category": "salesPrice",
                    "value": "3000",
                    "key": "valuePerUnit",
                    "type": "NUMBER"
                },
                {
                    "category": "salesPrice",
                    "value": "EUR",
                    "key": "currency",
                    "type": "CURRENCY"
                },
                {
                    "category": "shop",
                    "value": "3500",
                    "key": "valuePerUnit",
                    "type": "NUMBER"
                },
                {
                    "category": "shop",
                    "value": "EUR",
                    "key": "currency",
                    "type": "CURRENCY"
                }
            ]
        }
    ]
}
```

{% endtab %}

{% tab title="Facility discount code sample" %}

```json
{
    "context": [
        {
        "type": "FACILITY",
        "values": [
            "{YOUR_FACILITY_ID}"
            ]
        }
    ],
    "discount": {
        "type": "RELATIVE",
        "values": [
            {
                "value": 10
            }
        ]    
    },
    "priority": 20,
    "type": "SALES_PRICE"
}
```

{% endtab %}

{% tab title="Facility connection code sample" %}

```json
{
    "type": "MANAGED_FACILITY",
    "target": {
        "facilityRef": "{YOUR_FACILITY_ID}",
        "type": "MANAGED_FACILITY"
    },
    "fallbackTransitTime": {
        "maxTransitDays": 2,
        "minTransitDays": 1
    },
    "fallbackCost": {
        "value": 500,
        "currency": "EUR",
        "decimalPlaces": 2
    },
    "carrierKey": "DHL_V2",
    "carrierName": "MyDhl",
    "context": [],
    "nonDeliveryDays": [],
    "packagingUnitsByContexts": []
}
```

{% endtab %}
{% endtabs %}

## Shop price

The price at which items are sold to consumers is called the shop price. It can be stored at the listing level within the attributes or sent in the order's [article attributes](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes). Typically, only [managed facilities](https://docs.fulfillmenttools.com/documentation/getting-started/facilities#managed-facilities) will have a shop price configured.

The shop price is displayed in the Backoffice [facility inventory detail view](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory) in the **Article details** section.

{% hint style="info" %}
More information on adding shop prices to a listing can be found in the [Article attributes article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes#shop-price-with-currency).
{% endhint %}

## Sales price

The sales price is the amount at which items are sold to other facilities in the network and is always stored by the facility selling the articles. The sales price can be stored at the listing level in the listing attributes. It can be configured for all facility types, although primarily [supplier facilities](https://docs.fulfillmenttools.com/documentation/getting-started/facilities#supplier-facilities) will configure a sales price.

The sales price is displayed in the **Sales price** section of the Backoffice facility [inventory detail view](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory#sales-prices) and is visible in the selling facility's view. You can also add a sales price in Backoffice for the selling facility.

{% hint style="info" %}
More information on adding sales prices to a listing can be found in the [Article attributes article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes#sales-price-with-currency).
{% endhint %}

### Facility discounts

Facility discounts determine the value by which the [sales price](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes#category-sales-price) of the facility's listings is reduced for a specific group. It's configured on the facility that supplies the listing to other facilities.

The amount of the discount can be defined as a relative or absolute value. Discounts can be defined for a facility, a [group of facilities](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/facility-groups), or a [category](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/categories) (group of articles).

The scope of application can be extended or narrowed using the `AND`, `OR`, and `NOT` operators.

The contexts set in the discount (for example, facility groups) are matched with the corresponding context of the [listing attributes](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes#category-sales-price). If all contexts match, the discount is applied to the item's [sales price](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes#category-sales-price).

The priority defines the order in which the discounts should be applied.

Facility discounts can be viewed, created, and edited via the [Facility discounts API](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/prices/facility-discounts-endpoints).

#### **Example** <a href="#example" id="example"></a>

Let's say we have a supplier facility called Nerd Herd Distribution, and it has 3 different facility discounts set.

| Discount | Scope of discount                      | Priority |
| -------- | -------------------------------------- | -------- |
| 10%      | Nerd Herd Clothing Los Angeles store   | 10       |
| 15%      | T-shirt category                       | 50       |
| €5       | US West Coast Nerd Herd facility group | 100      |

If the Nerd Herd Clothing Los Angeles store (which is also part of the US West Coast facility group) purchases a t-shirt from Nerd Herd Distribution, it will receive a 10% discount. This is because the facility discount takes priority over both the category and facility group discounts.

If the Nerd Herd Clothing New York store purchases a t-shirt from our Nerd Herd supplier, it'll receive a 15% discount. This is because the category discount is the only discount that applies to that store.

#### Create facility discount

To add a discount to an existing facility, perform the following `POST` request with a JSON body similar to the example provided. This example applies a discount of 5 euros to articles that don't belong to the `shoes` or `trousers` categories and that belong to a facility group (`YOUR_FACILTY_GROUP_ID`).

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://ocff-{PROJECT_ID}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/discounts
```

{% endtab %}

{% tab title="Request" %}

```json
{
    "context": [
        {
            "operator": "NOT",           
            "type": "CATEGORY",
            "values": [
                "shoes",
                "trousers"
            ]
        },
        {
        "operator": "AND",
        "type": "FACILITY_GROUP",
        "values": [
            "YOUR_FACILITY_GROUP_ID"
            ]
        }
    ],
    "discount": {
        "type": "ABSOLUTE",
        "values": [
            {
                "value": 500,
                "currency": "EUR",
                "decimalPlaces": 2
            }
        ]    
    },
    "priority": 20,
    "type": "SALES_PRICE"
}
```

{% endtab %}
{% endtabs %}

## Purchase price

The purchase price is the amount at which items are acquired from other facilities within the network. It isn't stored specifically in fulfillmenttools but depends on the facility from which an article is sourced.

The **Purchase price** section appears within the Backoffice facility [inventory detail view](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory#purchase-prices) of the purchasing facility. Only prices pertinent to the purchasing facility are displayed.

{% hint style="warning" %}
The purchase price will only be displayed if there is a [facility connection](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/complex-routing-with-combinatorics/network-model/facility-connection) between the selling and the purchasing facilities.
{% endhint %}

### Discounted purchase price

Discounts can be applied to the purchase price of an article and are defined by the selling facility in the sales price. The selling facility can decide to set a discount for specific:

* Purchasing [facilities](https://docs.fulfillmenttools.com/documentation/getting-started/facilities)
* Purchasing [facility groups](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/facility-groups)
* Article [categories](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/categories)

This is done as part of the [facility discounts](#facility-discounts).


# Facility discounts endpoints

## The FacilityDiscount object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"FacilityDiscount":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/FacilityDiscountForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsolute"}]},"facilityRef":{"description":"The id of the facility the discount belongs to. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"id":{"description":"The id of the supplier discount. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["facilityRef","discount","priority","type","id"],"title":"FacilityDiscount","description":"FacilityDiscount"},"FacilityDiscountForCreation":{"additionalProperties":false,"properties":{"context":{"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","items":{"$ref":"#/components/schemas/FacilityDiscountContext","maxLength":2000,"minItems":0},"type":"array"},"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"priority":{"description":"The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.","type":"integer"},"type":{"$ref":"#/components/schemas/FacilityDiscountPriceType"}},"required":["discount","priority","type"],"title":"FacilityDiscountForCreation","description":"FacilityDiscountForCreation"},"FacilityDiscountContext":{"additionalProperties":false,"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/FacilityDiscountContextTypes"},"values":{"description":"The values of the context. This is used to determine the conditions  under which the discount can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityDiscountPriceType":{"description":"Determines the price type this discount can be applied to.","enum":["SALES_PRICE"],"type":"string","title":"FacilityDiscountPriceType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityDiscountAbsolute":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsolute","description":"FacilityDiscountAbsolute"}}}}
```

## POST /api/facilities/{facilityRef}/discounts

> Create facility discount

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityDiscountForCreation":{"additionalProperties":false,"properties":{"context":{"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","items":{"$ref":"#/components/schemas/FacilityDiscountContext","maxLength":2000,"minItems":0},"type":"array"},"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"priority":{"description":"The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.","type":"integer"},"type":{"$ref":"#/components/schemas/FacilityDiscountPriceType"}},"required":["discount","priority","type"],"title":"FacilityDiscountForCreation","description":"FacilityDiscountForCreation"},"FacilityDiscountContext":{"additionalProperties":false,"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/FacilityDiscountContextTypes"},"values":{"description":"The values of the context. This is used to determine the conditions  under which the discount can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityDiscountPriceType":{"description":"Determines the price type this discount can be applied to.","enum":["SALES_PRICE"],"type":"string","title":"FacilityDiscountPriceType"},"FacilityDiscount":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/FacilityDiscountForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsolute"}]},"facilityRef":{"description":"The id of the facility the discount belongs to. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"id":{"description":"The id of the supplier discount. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["facilityRef","discount","priority","type","id"],"title":"FacilityDiscount","description":"FacilityDiscount"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityDiscountAbsolute":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsolute","description":"FacilityDiscountAbsolute"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityRef}/discounts":{"post":{"description":"","operationId":"addDiscountToFacility","parameters":[{"description":"ID of the facility you want to add the discount to. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityRef","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityDiscountForCreation"}}},"description":"Representation that describes the discount","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityDiscount"}}},"description":"The discount was successfully created. The Location header contains the URL of the discount."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"Create facility discount","tags":["Facilities"]}}}}
```

## GET /api/facilities/{facilityRef}/discounts

> List facility discounts

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityDiscountPaginatedResult":{"additionalProperties":false,"properties":{"items":{"description":"The list of discounts that match the search criteria. The list might be empty if no discounts match the search criteria.","items":{"$ref":"#/components/schemas/FacilityDiscount"},"type":"array"},"total":{"description":"The total number of discounts that match the search criteria. This number is not limited by the page size.","format":"int64","type":"integer"}},"required":["items","total"],"title":"FacilityDiscountPaginatedResult","description":"FacilityDiscountPaginatedResult"},"FacilityDiscount":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/FacilityDiscountForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsolute"}]},"facilityRef":{"description":"The id of the facility the discount belongs to. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"id":{"description":"The id of the supplier discount. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["facilityRef","discount","priority","type","id"],"title":"FacilityDiscount","description":"FacilityDiscount"},"FacilityDiscountForCreation":{"additionalProperties":false,"properties":{"context":{"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","items":{"$ref":"#/components/schemas/FacilityDiscountContext","maxLength":2000,"minItems":0},"type":"array"},"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"priority":{"description":"The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.","type":"integer"},"type":{"$ref":"#/components/schemas/FacilityDiscountPriceType"}},"required":["discount","priority","type"],"title":"FacilityDiscountForCreation","description":"FacilityDiscountForCreation"},"FacilityDiscountContext":{"additionalProperties":false,"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/FacilityDiscountContextTypes"},"values":{"description":"The values of the context. This is used to determine the conditions  under which the discount can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityDiscountPriceType":{"description":"Determines the price type this discount can be applied to.","enum":["SALES_PRICE"],"type":"string","title":"FacilityDiscountPriceType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityDiscountAbsolute":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsolute","description":"FacilityDiscountAbsolute"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityRef}/discounts":{"get":{"description":"","operationId":"getDiscountsForFacility","parameters":[{"description":"ID of the facility you want to get the discounts for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityRef","required":true,"schema":{"type":"string"}},{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of facilities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FacilityDiscountPaginatedResult"}}}},"description":"The discounts were successfully retrieved. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"List facility discounts","tags":["Facilities"]}}}}
```

## GET /api/facilities/{facilityRef}/discounts/{facilityDiscountRef}

> Get facility discount

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityDiscount":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/FacilityDiscountForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsolute"}]},"facilityRef":{"description":"The id of the facility the discount belongs to. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"id":{"description":"The id of the supplier discount. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["facilityRef","discount","priority","type","id"],"title":"FacilityDiscount","description":"FacilityDiscount"},"FacilityDiscountForCreation":{"additionalProperties":false,"properties":{"context":{"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","items":{"$ref":"#/components/schemas/FacilityDiscountContext","maxLength":2000,"minItems":0},"type":"array"},"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"priority":{"description":"The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.","type":"integer"},"type":{"$ref":"#/components/schemas/FacilityDiscountPriceType"}},"required":["discount","priority","type"],"title":"FacilityDiscountForCreation","description":"FacilityDiscountForCreation"},"FacilityDiscountContext":{"additionalProperties":false,"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/FacilityDiscountContextTypes"},"values":{"description":"The values of the context. This is used to determine the conditions  under which the discount can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityDiscountPriceType":{"description":"Determines the price type this discount can be applied to.","enum":["SALES_PRICE"],"type":"string","title":"FacilityDiscountPriceType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityDiscountAbsolute":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsolute","description":"FacilityDiscountAbsolute"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityRef}/discounts/{facilityDiscountRef}":{"get":{"description":"","operationId":"getDiscountForFacility","parameters":[{"description":"ID of the facility you want to get the discount for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityRef","required":true,"schema":{"type":"string"}},{"description":"ID of the discount you want to get","in":"path","name":"facilityDiscountRef","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityDiscount"}}},"description":"The discount was successfully retrieved. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility or discount not found"}},"summary":"Get facility discount","tags":["Facilities"]}}}}
```

## DELETE /api/facilities/{facilityRef}/discounts/{facilityDiscountRef}

> Delete facility discount

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityRef}/discounts/{facilityDiscountRef}":{"delete":{"description":"","operationId":"deleteDiscountForFacility","parameters":[{"description":"ID of the facility you want to delete the discount from. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityRef","required":true,"schema":{"type":"string"}},{"description":"ID of the discount you want to delete","in":"path","name":"facilityDiscountRef","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The discount was successfully deleted. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility or discount not found"}},"summary":"Delete facility discount","tags":["Facilities"]}}}}
```

## PATCH /api/facilities/{facilityRef}/discounts/{facilityDiscountRef}

> Update facility discount

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityDiscountForUpdate":{"additionalProperties":false,"properties":{"context":{"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","items":{"$ref":"#/components/schemas/FacilityDiscountContext","maxLength":2000,"minItems":0},"type":"array"},"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"priority":{"description":"The priority of the discount. Discounts with the lowest priority value are applied first. Must be greater than 0 and smaller than 1000.","type":"integer"},"type":{"$ref":"#/components/schemas/FacilityDiscountPriceType"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"title":"FacilityDiscountForUpdate","description":"FacilityDiscountForUpdate"},"FacilityDiscountContext":{"additionalProperties":false,"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/FacilityDiscountContextTypes"},"values":{"description":"The values of the context. This is used to determine the conditions  under which the discount can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"FacilityDiscountContextTypes":{"description":"The context type of the discount. This is used to determine the conditions  under which the discount can be applied.","enum":["FACILITY","FACILITY_GROUP","CATEGORY"],"type":"string","title":"FacilityDiscountContextTypes"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityDiscountPriceType":{"description":"Determines the price type this discount can be applied to.","enum":["SALES_PRICE"],"type":"string","title":"FacilityDiscountPriceType"},"FacilityDiscount":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/FacilityDiscountForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsolute"}]},"facilityRef":{"description":"The id of the facility the discount belongs to. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"id":{"description":"The id of the supplier discount. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["facilityRef","discount","priority","type","id"],"title":"FacilityDiscount","description":"FacilityDiscount"},"FacilityDiscountForCreation":{"additionalProperties":false,"properties":{"context":{"description":"The context of the discount. This is used to determine the conditions  under which the discount can be applied.","items":{"$ref":"#/components/schemas/FacilityDiscountContext","maxLength":2000,"minItems":0},"type":"array"},"discount":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"priority":{"description":"The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.","type":"integer"},"type":{"$ref":"#/components/schemas/FacilityDiscountPriceType"}},"required":["discount","priority","type"],"title":"FacilityDiscountForCreation","description":"FacilityDiscountForCreation"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityDiscountAbsolute":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsolute","description":"FacilityDiscountAbsolute"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityRef}/discounts/{facilityDiscountRef}":{"patch":{"description":"","operationId":"updateDiscountForFacility","parameters":[{"description":"ID of the facility you want to update the discount for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityRef","required":true,"schema":{"type":"string"}},{"description":"ID of the discount you want to update","in":"path","name":"facilityDiscountRef","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityDiscountForUpdate"}}},"description":"Representation that describes the discount","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityDiscount"}}},"description":"The discount was successfully updated. The result is in the body."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility or discount not found"}},"summary":"Update facility discount","tags":["Facilities"]}}}}
```


# Search

Searchable fulfillmenttools entities have a dedicated search endpoint located at `POST /api/{ENTITY-NAME}/search`. Each fulfillmenttools entity defines which of its fields are queryable. You can:

* Search string and number fields with the operators `eq`, `notEq`, `in`, and `notIn`. The search value for `eq` and `notEq` must be a string, while the value for `in` and `notIn` must be an array of strings.
* Search array-of-string fields with the `contains` operator.
* Search number and date fields with the operators `gt` (>), `gte` (>=), `lt` (<), and `lte` (<=).
* Search all `customAttributes`. However, to optimize performance, it's recommended to store search-relevant keys in a dedicated property (for example, `searchTerms`) and minimize nesting depth.

## Fields with default query limits

Some entities, particularly those representing historical data, include default filters in queries. These default search fields limit the amount of data returned, which improves performance and relevance.

For example, operational entities such as orders typically return only recently created records by default, as older data is often not relevant for current operations.

These default values can be overridden if needed. However, expanding filters requires caution, especially when querying large datasets, to avoid performance issues.

## Search function limitations

The search functionality has the following restrictions due to database constraints and performance considerations. These limitations ensure stability and efficiency when handling queries.

1. **No periods (`.`) in custom search field names:** Field names containing periods can cause conflicts with internal database structures and indexing mechanisms. To prevent issues, periods aren't allowed in custom search field names.
2. **No custom search fields starting with a dollar sign (`$`):** Field names beginning with a dollar sign conflict with database operators, which use this syntax for system commands. To avoid ambiguity, such field names aren't permitted.
3. **Cross-entity search via `referenced` filter is limited to top-level queries:** Cross-entity searches using the `referenced` filter can only be applied at the top level of a query. Nesting them within `AND` or `OR` conditions is not supported due to query optimization constraints.

## Search execution time limit

Each search request must complete within a 30-second time limit. If execution exceeds this limit, fulfillmenttools aborts the search and returns a `BadRequest` response. Long runtimes can result from a combination of query complexity and the volume of entities searched. When encountering timeouts, reduce the complexity (for example, simplify nested conditions, narrow filters, avoid overly broad `customAttribute` queries), narrow the size of the dataset (for example, by providing a time range or restricting the search to a specific facility), or contact the support team for guidance.

## Example API calls

### Searching for exact equal matches

Example: Search for stocks in a facility with `facilityRef` `d083f631-9f4c-463b-85d4-9414fb19239f`.

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/stocks/search
```

```json
{
    "query": {
        "facilityRef": {
            "eq": "d083f631-9f4c-463b-85d4-9414fb19239f"
        }
    }
}
```

### Searching with `gt`, `gte`, `lt`, and `lte` operators

Example: Search for storage locations with a `created` date before October 2, 2024.

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/storagelocations/search
```

```json
{
    "query": {
        "created": {
            "lt": "2024-10-02T14:43:21.257Z"
        }
    }
}
```

### Sorting search results

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/{ENTITY-NAME}/search
```

```json
{
    "sort": [
        {
            "<attribute_to_sort_by>": "ASC"
        }
    ],
    "query": {
      ...
    }
}
```

### Adding a search result total count

{% hint style="warning" %}
Requesting the total count can significantly increase the response time of the request.
{% endhint %}

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/{ENTITY-NAME}/search
```

```json
{
    "options": {
        "withTotal": true
    },
    "query": {
      ...
    }
}
```

{% hint style="info" %}
The `withTotal` option can't be used in combination with `after` for pagination. This restriction exists because the total count may change while paginating, which could lead to inconsistent results.
{% endhint %}

### Searching for several fields with `and` or `or`

Example: Search for stocks that have a `facilityRef` of `d083f631-9f4c-463b-85d4-9414fb19239f` and are also placed on either location `6779689d-4852-4fcf-b13b-78f5ce4954d8` or `3b8be595-6a00-40cf-be09-12195e44eb99`.

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/stocks/search
```

```json
{
    "query": {
        "and": [
            {
                "facilityRef": {
                    "eq": "d083f631-9f4c-463b-85d4-9414fb19239f"
                }
            }, {
                "locationRef": {
                    "in": [
                        "6779689d-4852-4fcf-b13b-78f5ce4954d8",
                        "3b8be595-6a00-40cf-be09-12195e44eb99"
                    ]
                }
            }
        ]
    }
}
```

### Searching for nested fields

Example: Search for `inboundProcesses` that reference a `purchaseOrder` with the `id` `678ujnuzb67vg8h8oji`.

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/inboundprocesses/search
```

```json
{
    "query": {
        "purchaseOrder": {
            "id": {
                "eq": "678ujnuzb67vg8h8oji"
            }
        }
    }
}
```

### Searching custom attributes

{% hint style="info" %}
See the [Custom attributes article](https://docs.fulfillmenttools.com/documentation/getting-started/custom-attributes#using-custom-attributes) for more information on searching for custom attributes in Backoffice.
{% endhint %}

Example: Search for `customAttributes` of `suppliesOnlineCustomers` that's attributed to facilities.

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/facilities/search
```

```json
{
    "query": {
        "customAttributes": {
            "suppliesOnlineCustomers": {
                "eq": true
            }
        }
    }
}
```


# Search endpoints

## List roles (search)

> Search for Role

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RoleSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/RoleSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/RoleSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"RoleSearchPayload","type":"object","description":"RoleSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"RoleSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/RoleSearchQuery"},"maxItems":500,"type":"array"},"description":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by description"},"displayName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by displayName"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/RoleSearchQuery"},"maxItems":500,"type":"array"}},"title":"RoleSearchQuery","type":"object","description":"RoleSearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"RoleSort":{"properties":{"displayName":{"enum":["ASC","DESC"],"type":"string"}},"title":"RoleSort","type":"object","description":"RoleSort"},"RolePaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","roles"],"title":"RolePaginatedResult","type":"object","description":"RolePaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Role":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contextLimitations":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"contexts":{"deprecated":true,"description":"Deprecated: Use context instead.","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":100,"type":"array"},"created":{"description":"The date when the role was created.","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the role, which can be used to store additional information.","type":"object"},"description":{"description":"The description of the role, which provides more details about its purpose.","maxLength":100,"type":"string"},"displayName":{"description":"The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).","maxLength":50,"type":"string"},"lastModified":{"description":"The date when the role was last modified.","format":"date-time","type":"string"},"name":{"description":"The name of the role, which must be unique and is used to identify the role.","maxLength":20,"minLength":3,"type":"string"},"permissions":{"description":"The permissions associated with the role, which define what actions the role can perform.","items":{"enum":["USER_READ","USERS_READ","USER_WRITE","USER_MODIFY","CURRENT_USER_READ","CURRENT_USER_MODIFY","ROLE_READ","ROLE_WRITE","FACILITY_READ","FACILITY_WRITE","FACILITY_CREATE","FACILITY_DELETE","FACILITY_GROUP_READ","FACILITY_GROUP_WRITE","ORDER_READ","ORDER_WRITE","ORDER_FORCE_CANCEL","ORDER_UNLOCK","ORDER_CANCEL","ORDER_DELIVERY_PROMISE_WRITE","ORDER_CONSUMER_WRITE","ORDER_CUSTOM_ATTRIBUTES_WRITE","ORDER_LINEITEM_WRITE","ORDER_TOTAL_READ","LINE_ITEM_PRICING_READ","LINE_ITEM_QUANTITY_INCREASE","LINE_ITEM_ADD","LINE_ITEM_QUANTITY_DECREASE","LINE_ITEM_DELETE","SIMULATION_ORDER_READ","SIMULATION_ORDER_WRITE","AUDIT_READ","NOTIFICATION_READ","NOTIFICATION_WRITE","EXPIRIES_READ","EXPIRIES_WRITE","CONFIG_READ","CONFIG_WRITE","ROUTING_CONFIG_READ","ROUTING_CONFIG_WRITE","PROMISES_CONFIG_READ","PROMISES_CONFIG_WRITE","OIDC_PROVIDERS_CONFIG_READ","OIDC_PROVIDERS_CONFIG_WRITE","LOCALE_WRITE","CARRIER_READ","CARRIER_WRITE","RETURN_WRITE","RETURN_READ","ROUTING_READ","ROUTING_WRITE","PARCEL_READ","PARCEL_WRITE","SHIPMENT_READ","SHIPMENT_WRITE","HANDOVERJOB_READ","HANDOVERJOB_WRITE","PICKJOB_READ","PICKJOB_WRITE","PICKJOB_REROUTE","REMOTE_CONFIG_READ","REMOTE_CONFIG_WRITE","PICKRUN_READ","PICKRUN_WRITE","LOADUNITTYPE_READ","LOADUNITTYPE_WRITE","LOADUNIT_READ","LOADUNIT_WRITE","MEASUREMENTUNIT_READ","MEASUREMENTUNIT_WRITE","EVENT_READ","SUBSCRIPTION_READ","SUBSCRIPTION_WRITE","SUBSTITUTE_READ","SUBSTITUTE_WRITE","PROCESS_READ","PROCESS_WRITE","PROCESS_REROUTE","EXTERNAL_ACTIONS_READ","EXTERNAL_ACTIONS_WRITE","PROCESS_LOG_READ","OPERATIVE_PROCESS_READ","OPERATIVE_PROCESS_WRITE","OPERATIONS_VALIDATION_READ","OPERATIONS_VALIDATION_WRITE","DELIVERYNOTE_WRITE","PACKJOB_READ","PACKJOB_WRITE","PACKINGCONTAINER_TYPE_WRITE","PACKING_SOURCE_CONTAINER_READ","PACKING_SOURCE_CONTAINER_WRITE","RESTOW_ITEM_READ","RESTOW_ITEM_WRITE","TAG_READ","TAG_WRITE","STOCK_READ","STOCK_WRITE","EXTERNAL_STOCK_CHANGE_REASONS_READ","EXTERNAL_STOCK_CHANGE_REASONS_WRITE","STORAGE_LOCATION_READ","STORAGE_LOCATION_WRITE","STOW_JOB_READ","STOW_JOB_OPERATIVE_WRITE","STOW_JOB_FULL_WRITE","NOTIFICATION_CENTER_CONFIG_READ","NOTIFICATION_CENTER_CONFIG_WRITE","DOMS_TOOLKIT_READ","DOMS_TOOLKIT_WRITE","ANALYTICS_DASHBOARD_READ","DOCUMENT_SET_READ","DOCUMENT_SET_WRITE","INBOUND_PROCESS_READ","INBOUND_PROCESS_WRITE","ADMIN_DATA_RESET","ADMIN_MODULES_READ","ADMIN_MODULES_WRITE","ADMIN_INTER_FACILITY_CONNECTION_MIGRATION","ADMIN_ROUTING_PLAN_ANALYSIS","TENANT_CONNECTOR_CONFIG_READ","CUSTOM_SERVICE_WRITE","CUSTOM_SERVICE_READ","VALIDATIONS_READ","SERVICE_JOB_READ","SERVICE_JOB_WRITE","LINKED_SERVICE_JOBS_READ","LINKED_SERVICE_JOBS_WRITE","OPERATION_STATISTICS_READ","DOMS_STATISTICS_READ","AVAILABILITY_CHANNEL_READ","AVAILABILITY_CHANNEL_WRITE","HANDOVER_CONTAINER_READ","HANDOVER_CONTAINER_WRITE","STACKS_READ","STACKS_WRITE","CATEGORY_READ","CATEGORY_WRITE","PERMISSION_READ","KPI_READ","AI_ASSISTANT_ACCESS","RESERVATION_WRITE","RESERVATION_READ","FILTER_ENTITY_READ","BRAND_READ","WORKFLOW_DEFINITION_READ","WORKFLOW_DEFINITION_WRITE","LOOKUP_RECORD_READ","LOOKUP_RECORD_WRITE","ORDER_RECORD_READ","ORDER_RECORD_WRITE","PACKAGING_UNITS_READ","PACKAGING_UNITS_WRITE","EXPORT_READ","EXPORT_WRITE","STOCK_AVAILABILITIES_READ","LISTING_READ","LISTING_WRITE","LISTING_DELETE","PURCHASE_PRICE_READ","ZONE_READ","ZONE_WRITE","SAFETY_STOCK_READ","SAFETY_STOCK_WRITE","AVAILABILITY_THRESHOLDS_READ","AVAILABILITY_THRESHOLDS_WRITE","PICKUP_SERVICE_READ","PICKUP_SERVICE_WRITE","PRODUCT_READ","PRODUCT_WRITE"],"type":"string"},"maxItems":500,"type":"array"},"version":{"description":"The version of the role.","type":"number"}},"required":["name","permissions","version","created","lastModified"],"title":"Role","type":"object","description":"Role"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/roles/search":{"post":{"deprecated":false,"description":"Search for Role","operationId":"searchRole","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolePaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List roles (search)","tags":["User management"]}}}}
```

## List users (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for User

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints that enable the administration of user accounts, including creation, updating, read, and deletion of user accounts.","name":"User management"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/UserSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/UserSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"UserSearchPayload","type":"object","description":"UserSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"UserSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/UserSearchQuery"},"maxItems":500,"type":"array"},"assignedFacilities":{"allOf":[{"$ref":"#/components/schemas/UserAssignedFacilitiesListFilter"}],"description":"Nested list search by assignedFacilities"},"assignedRoles":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesListFilter"}],"description":"Nested list search by assignedRoles"},"auth":{"allOf":[{"$ref":"#/components/schemas/UserAuthFilter"}],"description":"Nested search by auth"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsFilter"}],"description":"Nested search by customClaims"},"facilityLimitations":{"allOf":[{"$ref":"#/components/schemas/StringListExistsFilter"}],"description":"Search by facilityLimitations"},"firstname":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstname"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"lastname":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastname"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/UserSearchQuery"},"maxItems":500,"type":"array"},"username":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by username"}},"title":"UserSearchQuery","type":"object","description":"UserSearchQuery"},"UserAssignedFacilitiesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedFacilitiesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedFacilitiesListFilter","type":"object","description":"UserAssignedFacilitiesListFilter"},"UserAssignedFacilitiesFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"}},"title":"UserAssignedFacilitiesFilter","type":"object","description":"UserAssignedFacilitiesFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"UserAssignedRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesListFilter","type":"object","description":"UserAssignedRolesListFilter"},"UserAssignedRolesFilter":{"properties":{"context":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextListFilter"}],"description":"Nested list search by context"},"contextLimitations":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsListFilter"}],"deprecated":true,"description":"Deprecated: Use context field instead"},"ref":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ref"}},"title":"UserAssignedRolesFilter","type":"object","description":"UserAssignedRolesFilter"},"UserAssignedRolesContextListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextListFilter","type":"object","description":"UserAssignedRolesContextListFilter"},"UserAssignedRolesContextFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextFilter","type":"object","description":"UserAssignedRolesContextFilter"},"UserAssignedRolesContextContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextContextTypesEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"UserAssignedRolesContextLimitationsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserAssignedRolesContextLimitationsListFilter","type":"object","description":"UserAssignedRolesContextLimitationsListFilter"},"UserAssignedRolesContextLimitationsFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAssignedRolesContextLimitationsContextTypesEnumFilter"}],"description":"Search by type"},"values":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by values"}},"title":"UserAssignedRolesContextLimitationsFilter","type":"object","description":"UserAssignedRolesContextLimitationsFilter"},"UserAssignedRolesContextLimitationsContextTypesEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"}},"title":"UserAssignedRolesContextLimitationsContextTypesEnumFilter","type":"object","description":"UserAssignedRolesContextLimitationsContextTypesEnumFilter"},"UserAuthFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/UserAuthAuthenticationProviderTypeEnumFilter"}],"description":"Search by type"}},"title":"UserAuthFilter","type":"object","description":"UserAuthFilter"},"UserAuthAuthenticationProviderTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"type":"string"}},"title":"UserAuthAuthenticationProviderTypeEnumFilter","type":"object","description":"UserAuthAuthenticationProviderTypeEnumFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"UserCustomClaimsFilter":{"properties":{"roles":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesListFilter"}],"description":"Nested list search by roles"}},"title":"UserCustomClaimsFilter","type":"object","description":"UserCustomClaimsFilter"},"UserCustomClaimsRolesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"UserCustomClaimsRolesListFilter","type":"object","description":"UserCustomClaimsRolesListFilter"},"UserCustomClaimsRolesFilter":{"properties":{"facilities":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilities"},"name":{"allOf":[{"$ref":"#/components/schemas/UserCustomClaimsRolesUserRoleNamesEnumFilter"}],"description":"Search by name"}},"title":"UserCustomClaimsRolesFilter","type":"object","description":"UserCustomClaimsRolesFilter"},"UserCustomClaimsRolesUserRoleNamesEnumFilter":{"properties":{"eq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"in":{"description":"Search by name","items":{"enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by name","enum":["FULFILLER","SUPERVISOR","ADMINISTRATOR"],"type":"string"}},"title":"UserCustomClaimsRolesUserRoleNamesEnumFilter","type":"object","description":"UserCustomClaimsRolesUserRoleNamesEnumFilter"},"StringListExistsFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"},"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"StringListExistsFilter","type":"object","description":"StringListExistsFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"UserSort":{"properties":{"assignedRoles":{"$ref":"#/components/schemas/UserAssignedRolesSort"},"authenticationProvider":{"$ref":"#/components/schemas/UserAuthenticationProviderSort"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"firstname":{"enum":["ASC","DESC"],"type":"string"},"lastLogin":{"enum":["ASC","DESC"],"type":"string"},"lastname":{"enum":["ASC","DESC"],"type":"string"},"username":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserSort","type":"object","description":"UserSort"},"UserAssignedRolesSort":{"properties":{"ref":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserAssignedRolesSort","type":"object","description":"UserAssignedRolesSort"},"UserAuthenticationProviderSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"UserAuthenticationProviderSort","type":"object","description":"UserAuthenticationProviderSort"},"UserPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"},"users":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"required":["pageInfo","users"],"title":"UserPaginatedResult","type":"object","description":"UserPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"User":{"properties":{"assignedFacilities":{"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead","items":{"$ref":"#/components/schemas/UserAssignedFacility"},"type":"array"},"assignedRoles":{"description":"The assigned roles of a user","items":{"$ref":"#/components/schemas/AssignedRoles"},"type":"array"},"authenticationProvider":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProvider"}],"description":"The authentication provider of the user"},"authenticationProviderType":{"$ref":"#/components/schemas/SupportedLocale"},"created":{"description":"Creation date of the user","format":"date-time","type":"string"},"customAttributes":{"description":"The custom attributes of the user","nullable":true,"type":"object"},"customClaims":{"allOf":[{"$ref":"#/components/schemas/CustomClaims"}],"deprecated":true,"description":"Deprecated: Find all relevant information in assignedRoles instead"},"email":{"description":"The email of the user","type":"string"},"facilityLimitations":{"description":"Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted","items":{"type":"string"},"type":"array"},"firstname":{"description":"The first name of the user","type":"string"},"id":{"description":"The id of the user","type":"string"},"lastLogin":{"description":"The last login timestamp of the user","format":"date-time","type":"string"},"lastModified":{"description":"Last modification date of the user","format":"date-time","type":"string"},"lastname":{"description":"The last name of the user","type":"string"},"locale":{"$ref":"#/components/schemas/SupportedLocale"},"username":{"description":"The username of the user","type":"string"},"version":{"description":"Version of the user","type":"number"}},"required":["firstname","lastname","username","id","authenticationProvider","version","assignedRoles"],"title":"User","type":"object","description":"User"},"UserAssignedFacility":{"properties":{"assignedZones":{"description":"The assigned zones of the user","items":{"$ref":"#/components/schemas/UserAssignedZone"},"type":"array"},"facilityRef":{"description":"The id of the assigned facility","type":"string"},"id":{"description":"The id of the assigned facility","type":"string"}},"required":["facilityRef","id"],"title":"UserAssignedFacility","type":"object","description":"UserAssignedFacility"},"UserAssignedZone":{"properties":{"zoneRef":{"description":"The id of the assigned zone","type":"string"}},"required":["zoneRef"],"title":"UserAssignedZone","type":"object","description":"UserAssignedZone"},"AssignedRoles":{"properties":{"context":{"description":"The context limitations of the assigned role","items":{"$ref":"#/components/schemas/ContextLimitation"},"maxItems":50,"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations of the assigned role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"ref":{"description":"The id of the assigned role","type":"string"}},"required":["ref"],"title":"AssignedRoles","type":"object","description":"AssignedRoles"},"ContextLimitation":{"properties":{"type":{"description":"The type of the context limitation.","enum":["FACILITY","FACILITY_GROUP","ROLE","USER_ROLE","ZONE"],"type":"string"},"values":{"description":"An array defining the values the user is allowed to access — if the entire context object is omitted, no access restrictions apply, whereas an empty array explicitly grants no access (i.e., maximum restriction).","items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["type","values"],"title":"ContextLimitation","type":"object","description":"ContextLimitation"},"AuthenticationProvider":{"properties":{"id":{"description":"The id of the authentication provider","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AuthenticationProviderTypeEnum"}],"description":"The type of the authentication provider"}},"required":["type"],"title":"AuthenticationProvider","type":"object","description":"AuthenticationProvider"},"AuthenticationProviderTypeEnum":{"description":"The type of the authentication provider","enum":["EMAIL_PASSWORD","OIDC","SUPPORT_ACCESS"],"title":"AuthenticationProviderTypeEnum","type":"string"},"SupportedLocale":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)","enum":["de_DE","en_US","pl_PL","ru_RU","nl_NL","fr_FR","it_IT","nb_NO","es_ES","cs_CZ","sk_SK","pt_PT","sl_SI","ro_RO","bg_BG","hr_HR","hu_HU","tr_TR"],"type":"string","title":"SupportedLocale"},"CustomClaims":{"properties":{"roles":{"description":"The roles of the user","items":{"$ref":"#/components/schemas/UserRole"},"type":"array"}},"required":["roles"],"title":"CustomClaims","type":"object","description":"CustomClaims"},"UserRole":{"properties":{"context":{"description":"An array of context objects, each defining a type and its allowed values — if a type is omitted, access for that type is unrestricted; if included, access is limited to the specified values, and each type must appear at most once.","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"contextLimitations":{"deprecated":true,"description":"The context limitations for this role (deprecated)","items":{"$ref":"#/components/schemas/ContextLimitation"},"type":"array"},"facilities":{"deprecated":true,"description":"Facility limitations are now defined in the context with type FACILITY","items":{"type":"string"},"maxItems":23,"type":"array"},"name":{"description":"The name of the role","type":"string"}},"required":["name"],"title":"UserRole","type":"object","description":"UserRole"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/users/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for User","operationId":"searchUser","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List users (search)","tags":["User management"]}}}}
```

## List zones (search)

> Search for Zone

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ZoneSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/ZoneSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/ZoneSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"ZoneSearchPayload","type":"object","description":"ZoneSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"ZoneSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ZoneSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ZoneSearchQuery"},"maxItems":500,"type":"array"}},"title":"ZoneSearchQuery","type":"object","description":"ZoneSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"ZoneSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ZoneSort","type":"object","description":"ZoneSort"},"ZonePaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"},"zones":{"items":{"$ref":"#/components/schemas/Zone"},"type":"array"}},"required":["pageInfo","zones"],"title":"ZonePaginatedResult","type":"object","description":"ZonePaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Zone":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"description":"The id of this zone","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["name","score","version","id","facilityRef"],"title":"Zone","type":"object","description":"Zone"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/zones/search":{"post":{"deprecated":false,"description":"Search for Zone","operationId":"searchZone","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZonePaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List zones (search)","tags":["Storage locations"]}}}}
```

## List stocks (search)

> Search for Stock

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StockSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/StockSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/StockSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"StockSearchPayload","type":"object","description":"StockSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"StockSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StockSearchQuery"},"maxItems":500,"type":"array"},"availableUntil":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by availableUntil"},"conditions":{"allOf":[{"$ref":"#/components/schemas/StockConditionEnumListFilter"}],"description":"Search by conditions"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"locationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by locationRef"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StockSearchQuery"},"maxItems":500,"type":"array"},"properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/DateFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by properties","type":"object"},"receiptDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by receiptDate"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"tenantFacilityId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"tenantFacilityId is handled like facilityRef filter, if you want to search by both you should wrap that filter in an \"or\" filter"},"tenantStockId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantStockId"},"traits":{"allOf":[{"$ref":"#/components/schemas/StockStorageLocationTraitEnumListFilter"}],"description":"Search by traits"},"value":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by value"}},"title":"StockSearchQuery","type":"object","description":"StockSearchQuery"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StockConditionEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StockConditionEnumFilter"}],"description":"Search by conditions"}},"title":"StockConditionEnumListFilter","type":"object","description":"StockConditionEnumListFilter"},"StockConditionEnumFilter":{"properties":{"eq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"},"in":{"description":"Search by conditions","items":{"enum":["DEFECTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"}},"title":"StockConditionEnumFilter","type":"object","description":"StockConditionEnumFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StockStorageLocationTraitEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StockStorageLocationTraitEnumFilter"}],"description":"Search by traits"}},"title":"StockStorageLocationTraitEnumListFilter","type":"object","description":"StockStorageLocationTraitEnumListFilter"},"StockStorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StockStorageLocationTraitEnumFilter","type":"object","description":"StockStorageLocationTraitEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StockSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"locationName":{"enum":["ASC","DESC"],"type":"string"},"tenantArticleId":{"enum":["ASC","DESC"],"type":"string"},"value":{"enum":["ASC","DESC"],"type":"string"}},"title":"StockSort","type":"object","description":"StockSort"},"StockPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"stocks":{"items":{"$ref":"#/components/schemas/Stock"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","stocks"],"title":"StockPaginatedResult","type":"object","description":"StockPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stocks/search":{"post":{"deprecated":false,"description":"Search for Stock","operationId":"searchStock","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List stocks (search)","tags":["Stock"]}}}}
```

## List parcels (search)

> Search for Parcel

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read shipments and parcels.","name":"Shipments"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ParcelSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/ParcelSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/ParcelSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"ParcelSearchPayload","type":"object","description":"ParcelSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"ParcelSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ParcelSearchQuery"},"maxItems":500,"type":"array"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoice":{"allOf":[{"$ref":"#/components/schemas/ParcelInvoiceFilter"}],"description":"Nested search by invoice"},"items":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsListFilter"}],"description":"Nested list search by items"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ParcelSearchQuery"},"maxItems":500,"type":"array"},"recipient":{"allOf":[{"$ref":"#/components/schemas/ParcelRecipientFilter"}],"description":"Nested search by recipient"},"result":{"allOf":[{"$ref":"#/components/schemas/ParcelResultFilter"}],"description":"Nested search by result"},"shipmentRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shipmentRef"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/ParcelStatusEnumFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"ParcelSearchQuery","type":"object","description":"ParcelSearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"ParcelInvoiceFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by companyName"},"email":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastName"}},"title":"ParcelInvoiceFilter","type":"object","description":"ParcelInvoiceFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"ParcelItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ParcelItemsListFilter","type":"object","description":"ParcelItemsListFilter"},"ParcelItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ParcelItemsArticleFilter"}],"description":"Nested search by article"}},"title":"ParcelItemsFilter","type":"object","description":"ParcelItemsFilter"},"ParcelItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"ParcelItemsArticleFilter","type":"object","description":"ParcelItemsArticleFilter"},"ParcelRecipientFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by companyName"},"email":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastName"}},"title":"ParcelRecipientFilter","type":"object","description":"ParcelRecipientFilter"},"ParcelResultFilter":{"properties":{"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierTrackingNumber"}},"title":"ParcelResultFilter","type":"object","description":"ParcelResultFilter"},"ParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ParcelStatusEnumFilter","type":"object","description":"ParcelStatusEnumFilter"},"ParcelSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ParcelSort","type":"object","description":"ParcelSort"},"ParcelPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","parcels"],"title":"ParcelPaginatedResult","type":"object","description":"ParcelPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Parcel":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/BaseOperationalContainer"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierInformation":{"$ref":"#/components/schemas/ParcelCarrierInformation"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"Reference to the carrier this parcel should be send by","type":"string"},"customAttributes":{"description":"Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"customProductValue":{"description":"Set this value if you want to overwrite the calculated product value of the parcel. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"dimensions":{"$ref":"#/components/schemas/ParcelDimensions"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"facilityRef":{"type":"string"},"id":{"description":"The id of this parcel. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"items":{"items":{"$ref":"#/components/schemas/ParcelItem"},"type":"array"},"loadUnitRefs":{"description":"Reference to array of load unit Refs","items":{"type":"string"},"type":"array"},"operativeProcessRef":{"type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickUpInformation":{"$ref":"#/components/schemas/ParcelPickUpInformation"},"postalCharges":{"$ref":"#/components/schemas/ParcelPostalCharge"},"processRef":{"type":"string"},"productValue":{"description":"Monetary value of all goods in this parcel. Needed for sending cross border packages (customs) To be interpreted as money in the currency given under paymentInformation.currency. This field uses the smallest denomination, e.g. Euro Cents. So a value of 1250 represents 12,50€.","type":"number"},"productValueCurrency":{"$ref":"#/components/schemas/ProductValueCurrency"},"productValueType":{"$ref":"#/components/schemas/ProductValueType"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"result":{"$ref":"#/components/schemas/ParcelResult"},"returnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"sender":{"$ref":"#/components/schemas/FacilityAddress"},"services":{"$ref":"#/components/schemas/ParcelServices"},"shipmentRef":{"description":"The id of this shipment this parcel has been created for.","type":"string"},"shortId":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tenantParcelId":{"description":"Tenant specific parcel id, needs to be unique for non obsolete or canceled parcel","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","carrierRef","processRef","sender","recipient","loadUnitRefs","workflowInformation"],"type":"object"}],"type":"object","title":"Parcel","description":"Parcel"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"BaseOperationalContainer":{"properties":{"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object","title":"BaseOperationalContainer","description":"BaseOperationalContainer"},"ParcelCarrierInformation":{"additionalProperties":false,"description":"Carrier specific information about the parcel for the label creation","properties":{"shippingContainerNumber":{"description":"Specific shipping container number for the parcel","type":"string"}},"type":"object","title":"ParcelCarrierInformation"},"ParcelDimensions":{"additionalProperties":false,"nullable":true,"properties":{"customWeight":{"type":"number"},"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"ParcelDimensions","description":"ParcelDimensions"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ParcelItem":{"allOf":[{"$ref":"#/components/schemas/LineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/ParcelItemArticle"},"countryOfManufacture":{"deprecated":true,"description":"Deprecated - use article.attribute.countryOfManufacture instead","type":"string"},"description":{"deprecated":true,"description":"Description - article.title will be used instead - of the given item/items","type":"string"},"hsCode":{"deprecated":true,"description":"Deprecated - use article.attribute.hsCode instead","maxLength":50,"type":"string"},"id":{"description":"The id of this parcelItem.","type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"parcelItemValue":{"allOf":[{"$ref":"#/components/schemas/ParcelItemValue"}],"deprecated":true,"description":"Deprecated - use article.attribute.pricePerUnit and article.attribute.currency instead"},"quantity":{"description":"amount of the given items","minimum":1,"type":"integer"},"weightInGram":{"deprecated":true,"description":"Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram","type":"integer"}},"required":["id","quantity"],"type":"object"}],"type":"object","xml":{"name":"ParcelItem"},"title":"ParcelItem","description":"ParcelItem"},"LineItem":{"properties":{"article":{"description":"Information about the lineItem","type":"object"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id"],"title":"LineItem","type":"object","description":"LineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"ParcelItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"type":"object","xml":{"name":"ParcelItemArticle"},"title":"ParcelItemArticle","description":"ParcelItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"ParcelItemValue":{"description":"deprecated, use MandatoryShippingArticleAttribute.attributes.pricePerUnit instead","nullable":true,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"},"type":{"$ref":"#/components/schemas/ProductValueType"},"value":{"description":"Monetary Value of a single item in the given currency","type":"number"}},"required":["value","currency"],"type":"object","title":"ParcelItemValue"},"ProductValueType":{"enum":["INSURANCE","CUSTOMS","SHOP_PRICE"],"type":"string","title":"ProductValueType","description":"ProductValueType"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"ParcelPickUpInformation":{"additionalProperties":false,"nullable":true,"properties":{"endTime":{"description":"needs to be after start time","format":"date-time","type":"string"},"startTime":{"description":"needs to be before end time","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object","xml":{"name":"ParcelItemForCreation"},"title":"ParcelPickUpInformation","description":"ParcelPickUpInformation"},"ParcelPostalCharge":{"properties":{"currency":{"description":"Currency of the given value","type":"string"},"value":{"description":"Monetary Value in the given currency","type":"number"}},"required":["currency","value"],"type":"object","title":"ParcelPostalCharge","description":"ParcelPostalCharge"},"ProductValueCurrency":{"additionalProperties":false,"properties":{"currency":{"description":"Currency of the given value","type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","type":"integer"}},"required":["currency"],"type":"object","title":"ProductValueCurrency","description":"ProductValueCurrency"},"ParcelResult":{"description":"Within this object you can find the result of the request after it has been processed (status = DONE or FAILED)","properties":{"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierTrackingNumber":{"type":"string"},"carrierTrackingStatus":{"oneOf":[{"$ref":"#/components/schemas/TrackingStatus"},{"$ref":"#/components/schemas/DhlTrackingStatus"}]},"customsDocumentId":{"description":"The customs document id","type":"string"},"customsDocumentUrl":{"description":"The original customs document URL","type":"string"},"errors":{"additionalProperties":false,"description":"temporary field to show errors during parcel creation, will be removed in the future. used to create summary in error case","properties":{"labelError":{"type":"string"},"returnLabelError":{"type":"string"}},"type":"object"},"labelUrl":{"description":"The URL where you can download the label relative to the path of this resource","type":"string"},"masterTrackingNumber":{"description":"The masterTrackingNumber is the first tracking number which was created for a shipment provided by the carrier. Sometimes carriers also have a separated number range for that.","type":"string"},"masterTrackingUrl":{"description":"The URL to track this master tracking number","type":"string"},"proxyId":{"description":"The ID of the corresponding job at the CEP proxy (if used)","type":"string"},"returnLabelId":{"description":"The original return label id","type":"string"},"returnLabelUrl":{"description":"The original return label URL","type":"string"},"returnMasterTrackingNumber":{"description":"The returnMasterTrackingNumber is the first tracking number for the return which was created for a shipment provided by the carrier. Sometimes carriers also have a separated number range for that.","type":"string"},"returnMasterTrackingUrl":{"description":"The URL to track this return master tracking number","type":"string"},"returnTrackingUrl":{"description":"The URL to track the return of this parcel","type":"string"},"sendLabelUrl":{"description":"The original send label URL","type":"string"},"summary":{"description":"Summary of the result of the request in a human readable form.","type":"string"},"trackingStatus":{"$ref":"#/components/schemas/TrackingStatus"},"trackingUrl":{"description":"The URL to track this parcel","type":"string"}},"required":["summary"],"type":"object","title":"ParcelResult"},"TrackingStatus":{"description":"The state of the KEP","enum":["registered","picked_up","delivered","not_delivered","transit","exception","out_for_delivery","destroyed","unknown","canceled","awaits_pickup_by_receiver","delayed","notification"],"title":"TrackingStatus","type":"string"},"DhlTrackingStatus":{"additionalProperties":false,"description":"Native trackingStatus provided by carrier","properties":{"description":{"description":"Description of the status","type":"string"},"location":{"$ref":"#/components/schemas/DhlTrackingLocation"},"remark":{"description":"Remark of the status","type":"string"},"status":{"description":"Status of the parcel as provided by carrier","type":"string"},"statusCode":{"description":"Status code of the parcel as provided by carrier","type":"string"},"statusDetailed":{"description":"Second status description","type":"string"},"timestamp":{"description":"Timestamp this status was set by the carrier","format":"date-time","type":"string"}},"required":["status"],"title":"DhlTrackingStatus","type":"object"},"DhlTrackingLocation":{"additionalProperties":false,"description":"Location information provided by DHL","properties":{"address":{"properties":{"addressLocality":{"type":"string"}},"type":"object"}},"type":"object","title":"DhlTrackingLocation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelServices":{"additionalProperties":false,"nullable":true,"properties":{"additionalTransportInsurance":{"description":"Additional insurance for the parcel by the carrier","type":"boolean"},"adultSignature":{"description":"Signature from some adult","type":"boolean"},"bulkyGoods":{"type":"boolean"},"customerSignature":{"description":"Signature from the ordering customer needed","type":"boolean"},"handoverToRecipientOnly":{"description":"Handover person on delivery can only be the given customer","type":"boolean"},"identityAgeCheck18":{"description":"Minimum age the receiving person has to have (18 years)","type":"boolean"},"identityCheckCompany":{"description":"Identity check that can be done by a person of receiving company","type":"boolean"},"identityCheckPrivate":{"description":"Identity check that can be done by the receiving person","type":"boolean"},"noNeighborDelivery":{"description":"Forbid delivery to neighbors, only allow delivery to the given address","type":"boolean"},"saturdayDelivery":{"description":"Saturday Delivery","type":"boolean"},"signature":{"description":"Signature from anyone needed","type":"boolean"}},"type":"object","title":"ParcelServices","description":"ParcelServices"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/parcels/search":{"post":{"deprecated":false,"description":"Search for Parcel","operationId":"searchParcel","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List parcels (search)","tags":["Shipments"]}}}}
```

## List listings (search)

> Search for Listing

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read facility listings.","name":"Listings"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ListingSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/ListingSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/ListingSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"ListingSearchPayload","type":"object","description":"ListingSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"ListingSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ListingSearchQuery"},"maxItems":500,"type":"array"},"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/ListingAvailabilityTimeframeFilter"}],"description":"Nested search by availabilityTimeframe"},"categoryRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by categoryRefs"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"measurementUnitKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by measurementUnitKey"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ListingSearchQuery"},"maxItems":500,"type":"array"},"outOfStockBehaviour":{"allOf":[{"$ref":"#/components/schemas/ListingOutOfStockBehaviourEnumFilter"}],"description":"Search by outOfStockBehaviour"},"price":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by price"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"status":{"allOf":[{"$ref":"#/components/schemas/ListingStatusEnumEnumFilter"}],"description":"Search by status"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"weight":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by weight"},"tags":{"allOf":[{"$ref":"#/components/schemas/ListingTagsListFilter"}],"description":"Nested list search by tags"}},"title":"ListingSearchQuery","type":"object","description":"ListingSearchQuery"},"ListingAvailabilityTimeframeFilter":{"properties":{"start":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by start"}},"title":"ListingAvailabilityTimeframeFilter","type":"object","description":"ListingAvailabilityTimeframeFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"ListingOutOfStockBehaviourEnumFilter":{"properties":{"eq":{"description":"Search by outOfStockBehaviour","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"in":{"description":"Search by outOfStockBehaviour","items":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by outOfStockBehaviour","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"}},"title":"ListingOutOfStockBehaviourEnumFilter","type":"object","description":"ListingOutOfStockBehaviourEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"ListingStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"}},"title":"ListingStatusEnumEnumFilter","type":"object","description":"ListingStatusEnumEnumFilter"},"ListingTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ListingTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ListingTagsListFilter","type":"object","description":"ListingTagsListFilter"},"ListingTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ListingTagsFilter","type":"object","description":"ListingTagsFilter"},"ListingSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"tenantArticleId":{"enum":["ASC","DESC"],"type":"string"}},"title":"ListingSort","type":"object","description":"ListingSort"},"ListingPaginatedResult":{"properties":{"listings":{"items":{"$ref":"#/components/schemas/Listing"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","listings"],"title":"ListingPaginatedResult","type":"object","description":"ListingPaginatedResult"},"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"maxItems":50,"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"RecordableAttributeValidation":{"properties":{"allowedValues":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidationsAllowedValue"},"maxItems":60,"minItems":0,"type":"array"},"key":{"description":"Key of this value to validate against operation validations","minLength":1,"nullable":true,"type":"string"},"type":{"enum":["EXACT_MATCH"],"type":"string"}},"required":["type","allowedValues"],"title":"RecordableAttributeValidation","type":"object","description":"RecordableAttributeValidation"},"RecordableAttributeValidationsAllowedValue":{"properties":{"type":{"enum":["STRING"],"type":"string"}},"required":["type"],"title":"RecordableAttributeValidationsAllowedValue","type":"object","description":"RecordableAttributeValidationsAllowedValue"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/listings/search":{"post":{"deprecated":false,"description":"Search for Listing","operationId":"searchListing","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List listings (search)","tags":["Listings"]}}}}
```

## List shipments (search)

> Search for Shipment

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read shipments and parcels.","name":"Shipments"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ShipmentSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/ShipmentSearchQueryWrapper"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/ShipmentSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"ShipmentSearchPayload","type":"object","description":"ShipmentSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"ShipmentSearchQueryWrapper":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by created"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"parcels":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsListFilter"}],"description":"Nested list search by parcels"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by pickJobRef"},"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"required":["created"],"title":"ShipmentSearchQueryWrapper","type":"object","description":"ShipmentSearchQueryWrapper"},"ShipmentSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ShipmentSearchQuery"},"maxItems":500,"type":"array"},"parcels":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsListFilter"}],"description":"Nested list search by parcels"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by pickJobRef"},"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"}},"title":"ShipmentSearchQuery","type":"object","description":"ShipmentSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"ShipmentParcelsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ShipmentParcelsListFilter","type":"object","description":"ShipmentParcelsListFilter"},"ShipmentParcelsFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ShipmentParcelsParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ShipmentParcelsFilter","type":"object","description":"ShipmentParcelsFilter"},"ShipmentParcelsParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ShipmentParcelsParcelStatusEnumFilter","type":"object","description":"ShipmentParcelsParcelStatusEnumFilter"},"ShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ShipmentStatusEnumFilter","type":"object","description":"ShipmentStatusEnumFilter"},"ShipmentSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"ShipmentSort","type":"object","description":"ShipmentSort"},"ShipmentPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"shipments":{"items":{"$ref":"#/components/schemas/Shipment"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","shipments"],"title":"ShipmentPaginatedResult","type":"object","description":"ShipmentPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Shipment":{"allOf":[{"$ref":"#/components/schemas/ShipmentForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"default":false,"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"carrierKey":{"type":"string"},"hasActiveCarrier":{"default":true,"description":"Indicates if there is an active carrier configuration to fulfill this shipment","type":"boolean"},"id":{"description":"The id of this Shipment. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItem"},"type":"array"},"parcels":{"items":{"$ref":"#/components/schemas/StrippedParcel"},"type":"array"},"status":{"$ref":"#/components/schemas/ShipmentStatus"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","hasActiveCarrier","workflowInformation"],"type":"object"}],"title":"Shipment","description":"Shipment"},"ShipmentForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label","type":"string"},"carrierRef":{"description":"The reference to the carrier for which the shipment is assigned to","type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the shipment. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"facilityRef":{"description":"The reference to the facility which the shipment is assigned to.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickJobRef":{"description":"The id of the facility reference.","type":"string"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"sourceAddress":{"$ref":"#/components/schemas/FacilityAddress"},"targetAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"},"tenantOrderId":{"description":"Reference to the order in the tenant system.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["facilityRef","targetTime","orderDate"],"type":"object","xml":{"name":"Shipment"},"title":"ShipmentForCreation","description":"ShipmentForCreation"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ShipmentLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/ShipmentLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ShipmentLineItemForCreation","description":"ShipmentLineItemForCreation"},"ShipmentLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"ShipmentLineItemArticle"},"title":"ShipmentLineItemArticle","description":"ShipmentLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"RecordableAttributeValidation":{"properties":{"allowedValues":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidationsAllowedValue"},"maxItems":60,"minItems":0,"type":"array"},"key":{"description":"Key of this value to validate against operation validations","minLength":1,"nullable":true,"type":"string"},"type":{"enum":["EXACT_MATCH"],"type":"string"}},"required":["type","allowedValues"],"title":"RecordableAttributeValidation","type":"object","description":"RecordableAttributeValidation"},"RecordableAttributeValidationsAllowedValue":{"properties":{"type":{"enum":["STRING"],"type":"string"}},"required":["type"],"title":"RecordableAttributeValidationsAllowedValue","type":"object","description":"RecordableAttributeValidationsAllowedValue"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ShipmentLineItem":{"allOf":[{"$ref":"#/components/schemas/ShipmentLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"}},"required":["id"],"type":"object"}],"title":"ShipmentLineItem","description":"ShipmentLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"StrippedParcel":{"properties":{"carrierRef":{"description":"The reference to the carrier for which the parcel is assigned to","type":"string"},"carrierTrackingNumber":{"type":"string"},"parcelRef":{"type":"string"},"status":{"$ref":"#/components/schemas/ParcelStatus"}},"required":["parcelRef","carrierRef","status"],"type":"object","title":"StrippedParcel","description":"StrippedParcel"},"ParcelStatus":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string","title":"ParcelStatus","description":"ParcelStatus"},"ShipmentStatus":{"description":"Every newly created shipment is in state INITIAL. When the parcel labels should be requested the state changes to REQUEST and as soon as all parcel labels are successfully requested the state changes to CONFIRMED. The state COMPLETED is set in the end or the process","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string","title":"ShipmentStatus"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/shipments/search":{"post":{"deprecated":false,"description":"Search for Shipment","operationId":"searchShipment","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List shipments (search)","tags":["Shipments"]}}}}
```

## List pack jobs (search)

> Search for PackJob

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to facilitate the packing process.","name":"Packing"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackJobSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/PackJobSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/PackJobSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"PackJobSearchPayload","type":"object","description":"PackJobSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"PackJobSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/PackJobSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoice":{"allOf":[{"$ref":"#/components/schemas/PackJobInvoiceFilter"}],"description":"Nested search by invoice"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"lineItems":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsListFilter"}],"description":"Nested list search by lineItems"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/PackJobSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"packingSourceContainers":{"allOf":[{"$ref":"#/components/schemas/PackJobPackingSourceContainersListFilter"}],"description":"Nested list search by packingSourceContainers"},"recipient":{"allOf":[{"$ref":"#/components/schemas/PackJobRecipientFilter"}],"description":"Nested search by recipient"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/PackJobStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"}},"title":"PackJobSearchQuery","type":"object","description":"PackJobSearchQuery"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"PackJobInvoiceFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by companyName"},"email":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastName"}},"title":"PackJobInvoiceFilter","type":"object","description":"PackJobInvoiceFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"PackJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PackJobLineItemsListFilter","type":"object","description":"PackJobLineItemsListFilter"},"PackJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/PackJobLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"PackJobLineItemsFilter","type":"object","description":"PackJobLineItemsFilter"},"PackJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"PackJobLineItemsArticleFilter","type":"object","description":"PackJobLineItemsArticleFilter"},"PackJobPackingSourceContainersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PackJobPackingSourceContainersFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PackJobPackingSourceContainersListFilter","type":"object","description":"PackJobPackingSourceContainersListFilter"},"PackJobPackingSourceContainersFilter":{"properties":{"codes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by codes"}},"title":"PackJobPackingSourceContainersFilter","type":"object","description":"PackJobPackingSourceContainersFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"PackJobRecipientFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by companyName"},"email":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastName"}},"title":"PackJobRecipientFilter","type":"object","description":"PackJobRecipientFilter"},"PackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"PackJobStatusEnumFilter","type":"object","description":"PackJobStatusEnumFilter"},"PackJobSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"PackJobSort","type":"object","description":"PackJobSort"},"PackJobPaginatedResult":{"properties":{"packJobs":{"items":{"$ref":"#/components/schemas/PackJob"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","packJobs"],"title":"PackJobPaginatedResult","type":"object","description":"PackJobPaginatedResult"},"PackJob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the pack job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryChannel":{"enum":["COLLECT","SHIPPING"],"type":"string"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"facilityRef":{"description":"Reference to the facility you want to get the corresponding packjob","type":"string"},"id":{"description":"The id of this pack job. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoice":{"$ref":"#/components/schemas/ConsumerAddress"},"lineItems":{"items":{"$ref":"#/components/schemas/PackLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"Date when the order was placed.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order","type":"string"},"packingSourceContainers":{"items":{"$ref":"#/components/schemas/StrippedPackingSourceContainer"}},"pickJobRef":{"description":"Reference to a pick job","type":"string"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipient":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientName":{"description":"The name of the recipient","type":"string"},"shortId":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/PackJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"Until when the pack job must be finished.","format":"date-time","type":"string"},"tenantOrderId":{"type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","facilityRef","documentsRef","status","lineItems","processId","workflowInformation"],"type":"object","xml":{"name":"PackJob"}}],"title":"PackJob","description":"PackJob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"PackLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"},{"properties":{"article":{"$ref":"#/components/schemas/PackLineItemArticle"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"packed":{"description":"The amount of articles that were packed for this packline.","format":"int32","minimum":0,"type":"integer"},"quantity":{"description":"quantity of this item","format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","quantity","article"]}],"type":"object","xml":{"name":"PackLineItem"},"title":"PackLineItem","description":"PackLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"PackLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}}}],"type":"object","xml":{"name":"PackLineItemArticle"},"title":"PackLineItemArticle","description":"PackLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"StrippedPackingSourceContainer":{"additionalProperties":false,"properties":{"codes":{"items":{"description":"Codes, that identify the container","type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"},"loadUnitRef":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use previousModuleContainerInfo instead. For load units ref see: type: LOAD_UNIT.","type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"}},"type":"object","title":"StrippedPackingSourceContainer","description":"StrippedPackingSourceContainer"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"PackJobStatus":{"description":"A pack job initially has the status OPEN and packing can start. When packing has started, the pack job changes its status to IN_PROGRESS. After a pack job has been completely packed its status becomes CLOSED.","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string","xml":{"name":"PackJobStatus"},"title":"PackJobStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/packjobs/search":{"post":{"deprecated":false,"description":"Search for PackJob","operationId":"searchPackJob","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List pack jobs (search)","tags":["Packing"]}}}}
```

## List pick jobs (search)

> Search for PickJob

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to support the management of the picking process.","name":"Picking"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PickJobSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/PickJobSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/PickJobSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"PickJobSearchPayload","type":"object","description":"PickJobSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"PickJobSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/PickJobSearchQuery"},"maxItems":500,"type":"array"},"consumerName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerName"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/PickJobSearchQuery"},"maxItems":500,"type":"array"},"orderRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by orderRef"},"preferredPickingMethods":{"allOf":[{"$ref":"#/components/schemas/PickJobPickingMethodEnumEnumListFilter"}],"description":"Search by preferredPickingMethods"},"status":{"allOf":[{"$ref":"#/components/schemas/PickJobStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantArticleIds":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by tenantArticleIds"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"},"transfers":{"allOf":[{"$ref":"#/components/schemas/PickJobTransfersListFilter"}],"description":"Nested list search by transfers"}},"title":"PickJobSearchQuery","type":"object","description":"PickJobSearchQuery"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"PickJobPickingMethodEnumEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PickJobPickingMethodEnumEnumFilter"}],"description":"Search by preferredPickingMethods"}},"title":"PickJobPickingMethodEnumEnumListFilter","type":"object","description":"PickJobPickingMethodEnumEnumListFilter"},"PickJobPickingMethodEnumEnumFilter":{"properties":{"eq":{"description":"Search by preferredPickingMethods","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"},"in":{"description":"Search by preferredPickingMethods","items":{"enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by preferredPickingMethods","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string"}},"title":"PickJobPickingMethodEnumEnumFilter","type":"object","description":"PickJobPickingMethodEnumEnumFilter"},"PickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"PickJobStatusEnumFilter","type":"object","description":"PickJobStatusEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"PickJobTransfersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/PickJobTransfersFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"PickJobTransfersListFilter","type":"object","description":"PickJobTransfersListFilter"},"PickJobTransfersFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by id"}},"title":"PickJobTransfersFilter","type":"object","description":"PickJobTransfersFilter"},"PickJobSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"},"tenantOrderId":{"enum":["ASC","DESC"],"type":"string"}},"title":"PickJobSort","type":"object","description":"PickJobSort"},"PickJobPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"pickJobs":{"items":{"$ref":"#/components/schemas/PickJob"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","pickJobs"],"title":"PickJobPaginatedResult","type":"object","description":"PickJobPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"PickJob":{"allOf":[{"$ref":"#/components/schemas/PickJobForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"deliveryinformation":{"$ref":"#/components/schemas/PickjobDeliveryInformation"},"documentHandling":{"$ref":"#/components/schemas/DocumentHandling"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"expectedPickLineItems":{"items":{"$ref":"#/components/schemas/ExpectedPickLineItem"},"type":"array"},"id":{"description":"The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"pickingZones":{"items":{"$ref":"#/components/schemas/PickingZone"},"type":"array"},"pickLineItems":{"items":{"$ref":"#/components/schemas/PickLineItem"},"type":"array"},"pickRunRef":{"description":"Pick run id to which the pick job belongs","type":"string"},"resetBlocked":{"default":false,"description":"Indicates if pickJob can still be resetted or restarted","type":"boolean"},"sentNotifications":{"$ref":"#/components/schemas/PickJobSentNotifications"},"shortId":{"description":"A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation.","type":"string"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"statusReason":{"deprecated":true,"description":"deprecated: Use subStatus instead. Maintained for backward compatibility.","type":"string"},"subStatus":{"$ref":"#/components/schemas/PickJobSubStatus","description":"The reason for the current status."},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["id","status","pickLineItems","shortId","workflowInformation","deliveryinformation","documentsRef"],"type":"object"}],"title":"PickJob","description":"PickJob"},"PickJobForCreation":{"additionalProperties":false,"properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"type":"array"},"customAttributes":{"description":"Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"deliveryinformation":{"$ref":"#/components/schemas/PickjobDeliveryInformationForCreation"},"expectedPickLineItems":{"items":{"$ref":"#/components/schemas/ExpectedPickLineItemForCreation"},"minItems":0,"type":"array"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderRef":{"description":"The id of the order reference. The given ID has to be present in the system.","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/PaymentInformation"},"pickingTimes":{"$ref":"#/components/schemas/PickJobPickingTimes"},"pickLineItems":{"items":{"$ref":"#/components/schemas/PickLineItemForCreation"},"minItems":0,"type":"array"},"preferredPickingMethods":{"description":"Preferred way of picking a given pickJob.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"routingPlanRef":{"description":"Reference to the routingplan which created this pickjob","type":"string"},"shortId":{"description":"A short identifier that helps assigning a pick job to a customer.","type":"string"},"status":{"$ref":"#/components/schemas/PickJobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"minItems":0,"type":"array"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"description":"Tags can only be set when there is no process related with this pickJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["orderDate","facilityRef","pickLineItems"],"type":"object","xml":{"name":"Pickjob"},"title":"PickJobForCreation","description":"PickJobForCreation"},"AssignedUserForCreationByName":{"description":"Create a assigned user by giving a valid name","properties":{"username":{"description":"username of the user should be assigned","type":"string"}},"required":["username"],"title":"AssignedUserForCreationByName","type":"object"},"AssignedUserForCreationById":{"description":"Create a assigned user by giving a valid id","properties":{"userId":{"description":"userId of the user should be assigned","type":"string"}},"required":["userId"],"title":"AssignedUserForCreationById","type":"object"},"PickjobDeliveryInformationForCreation":{"properties":{"channel":{"$ref":"#/components/schemas/PickJobDeliveryInformationChannel"},"details":{"properties":{"collect":{"properties":{"identifier":{"description":"Includes information about Click & Collect recipient","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"}},"type":"object"},"shipping":{"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"description":"Desired product of given carrier to choose when ordering a label, this is specific to a carrier","type":"string"},"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"type":"array"},"identifier":{"description":"Includes information on how to identify Ship from Store recipient (Name, PIN, Reference number, ...)","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"postalAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"recipientaddress":{"$ref":"#/components/schemas/ConsumerAddress"},"serviceLevel":{"description":"TBD","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object"}},"type":"object"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"},"targetTimeBaseDate":{"description":"The start date for the targetTime calculation.","format":"date-time","type":"string"}},"type":"object","title":"PickjobDeliveryInformationForCreation","description":"PickjobDeliveryInformationForCreation"},"PickJobDeliveryInformationChannel":{"enum":["COLLECT","SHIPPING"],"type":"string","title":"PickJobDeliveryInformationChannel","description":"PickJobDeliveryInformationChannel"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"ExpectedPickLineItemForCreation":{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["transferId","quantity","article"],"title":"ExpectedPickLineItemForCreation","description":"ExpectedPickLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"PickLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"properties":{"prices":{"deprecated":true,"items":{"$ref":"#/components/schemas/ArticlePrice"},"type":"array","description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"}},"type":"object","xml":{"name":"PickLineItemArticle"},"title":"PickLineItemArticle","description":"PickLineItemArticle"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticlePrice":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"pricePerUnit":{"description":"Price value for a given currency per unit","minimum":0,"type":"number"}},"required":["pricePerUnit","currency"],"type":"object","title":"ArticlePrice","description":"ArticlePrice"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"PickJobLineItemPartialStockLocationForCreation":{"properties":{"available":{"description":"Quantity of unreserved items at the stock location.","format":"int64","minimum":0,"type":"number"},"location":{"$ref":"#/components/schemas/Location"},"quantity":{"description":"Quantity of the specific article that should be picked from given stock location.","format":"int64","minimum":0,"type":"number"},"ratingScore":{"type":"number"},"sequenceScore":{"type":"number"},"stockProperties":{"anyOf":[{"$ref":"#/components/schemas/PickingStockPropertyPreset"},{"$ref":"#/components/schemas/PickingStockProperty"}]},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocationForCreation","description":"PickJobLineItemPartialStockLocationForCreation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"maxItems":50,"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"PickingStockPropertyPreset":{"description":"Preset of Picking Stock Property.","properties":{"expiry":{"type":"string"}},"title":"PickingStockPropertyPreset","type":"object"},"PickingStockProperty":{"additionalProperties":{"type":"string"},"description":"Picking Stock Property.","title":"PickingStockProperty","type":"object"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PaymentInformation":{"properties":{"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"PaymentInformation","description":"PaymentInformation"},"PickJobPickingTimes":{"additionalProperties":false,"properties":{"startLatestAt":{"description":"The date this pickJob should be started at last.","format":"date-time","type":"string"}},"type":"object","title":"PickJobPickingTimes","description":"PickJobPickingTimes"},"PickLineItemForCreation":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItemForCreation"}],"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"},"type":"array"},"quantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Quantity of the specific article that has been ordered.","format":"int64","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"PickLineItemForCreation","description":"PickLineItemForCreation"},"MandatoryLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"},"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"required":["article","quantity"],"title":"MandatoryLineItemForCreation","type":"object","description":"MandatoryLineItemForCreation"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"RecordableAttributeValidation":{"properties":{"allowedValues":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidationsAllowedValue"},"maxItems":60,"minItems":0,"type":"array"},"key":{"description":"Key of this value to validate against operation validations","minLength":1,"nullable":true,"type":"string"},"type":{"enum":["EXACT_MATCH"],"type":"string"}},"required":["type","allowedValues"],"title":"RecordableAttributeValidation","type":"object","description":"RecordableAttributeValidation"},"RecordableAttributeValidationsAllowedValue":{"properties":{"type":{"enum":["STRING"],"type":"string"}},"required":["type"],"title":"RecordableAttributeValidationsAllowedValue","type":"object","description":"RecordableAttributeValidationsAllowedValue"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickJobStatus":{"description":"The status of a pickjob.","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string","xml":{"name":"PickJobStatus"},"title":"PickJobStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"PickjobDeliveryInformation":{"allOf":[{"$ref":"#/components/schemas/PickjobDeliveryInformationForCreation"},{"required":["channel"]}],"type":"object","title":"PickjobDeliveryInformation","description":"PickjobDeliveryInformation"},"DocumentHandling":{"properties":{"sendLabel":{"properties":{"enabled":{"default":false,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["sendLabel"],"type":"object","title":"DocumentHandling","description":"DocumentHandling"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"ExpectedPickLineItem":{"allOf":[{"$ref":"#/components/schemas/ExpectedPickLineItemForCreation"},{"properties":{"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"}},"required":["id"],"type":"object"}],"title":"ExpectedPickLineItem","description":"ExpectedPickLineItem"},"PickingZone":{"description":"Zones from which items can be picked","properties":{"zoneRef":{"type":"string"}},"required":["zoneRef"],"type":"object","title":"PickingZone"},"PickLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"properties":{"allowedSubstitutes":{"items":{"$ref":"#/components/schemas/Substitute"},"type":"array"},"article":{"$ref":"#/components/schemas/PickLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the pick line. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"partialStockLocations":{"description":"Indicates where the items to pick could be found and from where the picking should be started.","items":{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocation"}},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"pickJobLineItemRef":{"description":"used for line items in pick runs to be split up correctly again","type":"string"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"recordableAttributes":{"items":{"$ref":"#/components/schemas/RecordableAttribute"},"nullable":true,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scannedCodes":{"items":{"$ref":"#/components/schemas/PickLineItemScannedCode"},"minimum":0,"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: Use scanningRules instead. This value indicates which scanning rule should be applied for this pick line. Only generated on demand on separate call, no persistence."},"scanningRules":{"$ref":"#/components/schemas/PickLineItemScanningRules"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":0,"type":"integer"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"},"status":{"$ref":"#/components/schemas/PickLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"stockEmptied":{"type":"boolean"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/SubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","picked","status","quantity","article"],"type":"object"}],"title":"PickLineItem","description":"PickLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"PickJobLineItemPartialStockLocation":{"allOf":[{"$ref":"#/components/schemas/PickJobLineItemPartialStockLocationForCreation"}],"properties":{"picked":{"description":"Quantity of the specific article that was picked from this stock location.","format":"int64","minimum":0,"type":"number"},"stockEmptied":{"type":"boolean"},"zoneName":{"type":"string"},"zoneRef":{"type":"string"}},"required":["tenantPartialStockId","stockRef"],"type":"object","title":"PickJobLineItemPartialStockLocation","description":"PickJobLineItemPartialStockLocation"},"PickLineItemScannedCode":{"properties":{"code":{"description":"scannable code i.e. barcode","type":"string"},"quantity":{"description":"scanned quantity","format":"int64","minimum":0,"type":"integer"}},"required":["code","quantity"],"type":"object","title":"PickLineItemScannedCode","description":"PickLineItemScannedCode"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"PickLineItemScanningRules":{"additionalProperties":false,"properties":{"scanningMode":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"scanningType":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"PickLineItemScanningRules","description":"PickLineItemScanningRules"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"PickLineItemStatus":{"description":"A pickjob line item initially has the status OPEN and picking can start. When a line item is opened within the picking app, the item changes its status to IN_PROGRESS. When the commissioning is finished the state is CLOSED","enum":["OPEN","IN_PROGRESS","CLOSED"],"type":"string","xml":{"name":"PickLineItemStatus"},"title":"PickLineItemStatus"},"SubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"picked":{"description":"The amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"quantity":{"description":"quantity of the specific article that needs to be picked to substitute the item","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"secondaryPicked":{"description":"The secondary amount of articles that were picked for this pickline.","format":"int64","minimum":0,"type":"integer"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","format":"int64","minimum":1,"type":"integer"}},"required":["article","id","quantity"],"type":"object","title":"SubstituteLineItem","description":"SubstituteLineItem"},"SubstituteLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"SubstituteLineItemArticle"},"title":"SubstituteLineItemArticle","description":"SubstituteLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"SubstituteLineItemPartialStockLocation":{"properties":{"location":{"$ref":"#/components/schemas/Location"},"picked":{"format":"int64","minimum":0,"type":"number"},"quantity":{"format":"int64","minimum":0,"type":"number"},"ratingScore":{"type":"number"},"sequenceScore":{"type":"number"},"stockProperties":{"anyOf":[{"$ref":"#/components/schemas/PickingStockPropertyPreset"},{"$ref":"#/components/schemas/PickingStockProperty"}]},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"},"zoneName":{"type":"string"}},"required":["location","quantity"],"type":"object","title":"SubstituteLineItemPartialStockLocation","description":"SubstituteLineItemPartialStockLocation"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"type":"object","title":"RefusedItem","description":"RefusedItem"},"PickJobSentNotifications":{"additionalProperties":false,"description":"Markers whether the respective notification was already sent for this pickJob. Maintained by the system.","properties":{"overdueDetected":{"default":false,"description":"Indicates if the overdue (targetTime is in the past) notification was already sent.","type":"boolean"},"urgentDetected":{"default":false,"description":"Indicates if the urgent (targetTime is in the near future (inside fulfillmentProcessBuffer)) notification was already sent.","type":"boolean"}},"type":"object","title":"PickJobSentNotifications"},"PickJobSubStatus":{"description":"The reason for the current status, providing type-safe context beyond the status field.","enum":["SHORT_PICKED","ZERO_PICKED","WAITING_FOR_RELEASE_TIME","ORDER_MODIFIED","PROCESS_REROUTE","MANUAL_REROUTE","SHORT_PICK_REROUTE","TIME_TRIGGERED","STOCK_ZEROED","PICK_JOB_ABORTED","RECALCULATION"],"type":"string","xml":{"name":"PickJobSubStatus"},"title":"PickJobSubStatus"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/pickjobs/search":{"post":{"deprecated":false,"description":"Search for PickJob","operationId":"searchPickJob","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickJobSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickJobPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List pick jobs (search)","tags":["Picking"]}}}}
```

## List stow jobs (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for StowJob

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stow jobs.","name":"Stowing"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StowJobSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/StowJobSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/StowJobSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"StowJobSearchPayload","type":"object","description":"StowJobSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"StowJobSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StowJobSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"default":{"after":"-P1W"},"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StowJobSearchQuery"},"maxItems":500,"type":"array"},"priority":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by priority"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/StowJobStatusTypeEnumFilter"}],"description":"Search by status"},"stowLineItems":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsListFilter"}],"description":"Nested list search by stowLineItems"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"StowJobSearchQuery","type":"object","description":"StowJobSearchQuery"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StowJobStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"}},"title":"StowJobStatusTypeEnumFilter","type":"object","description":"StowJobStatusTypeEnumFilter"},"StowJobStowLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsListFilter","type":"object","description":"StowJobStowLineItemsListFilter"},"StowJobStowLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsArticleFilter"}],"description":"Nested search by article"},"heldStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by heldStockRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"stowTo":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToListFilter"}],"description":"Nested list search by stowTo"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromFilter"}],"description":"Nested search by takeFrom"}},"title":"StowJobStowLineItemsFilter","type":"object","description":"StowJobStowLineItemsFilter"},"StowJobStowLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"StowJobStowLineItemsArticleFilter","type":"object","description":"StowJobStowLineItemsArticleFilter"},"StowJobStowLineItemsStowToListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsStowToListFilter","type":"object","description":"StowJobStowLineItemsStowToListFilter"},"StowJobStowLineItemsStowToFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToStowedFilter"}],"description":"Nested search by stowed"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsStowToFilter","type":"object","description":"StowJobStowLineItemsStowToFilter"},"StowJobStowLineItemsStowToStowedFilter":{"properties":{"stowedStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStockRef"},"stowedStorageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStorageLocationRef"}},"title":"StowJobStowLineItemsStowToStowedFilter","type":"object","description":"StowJobStowLineItemsStowToStowedFilter"},"StowJobStowLineItemsTakeFromFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"taken":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromTakenFilter"}],"description":"Nested search by taken"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsTakeFromFilter","type":"object","description":"StowJobStowLineItemsTakeFromFilter"},"StowJobStowLineItemsTakeFromTakenFilter":{"properties":{"takenStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by takenStockRef"}},"title":"StowJobStowLineItemsTakeFromTakenFilter","type":"object","description":"StowJobStowLineItemsTakeFromTakenFilter"},"StowJobSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"StowJobSort","type":"object","description":"StowJobSort"},"StowJobPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"stowJobs":{"items":{"$ref":"#/components/schemas/StowJob"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","stowJobs"],"title":"StowJobPaginatedResult","type":"object","description":"StowJobPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"StowJob":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":20,"type":"array"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"id":{"description":"Auto-generated, unique primary identifier of the stow job","type":"string"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItem"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["facilityRef","status","stowLineItems","id","version"],"title":"StowJob","type":"object","description":"StowJob"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"StowLineItem":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"heldStockRef":{"description":"Reference to a stock holding the goods after a take and before a stow has taken place","type":"string"},"id":{"description":"The ID of the stowLineItem. It is generated automatically during creation and serves as primary identifier of the entity","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonOutput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToWithId"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFrom"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom","id"],"title":"StowLineItem","type":"object","description":"StowLineItem"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"},"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"},"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stowjobs/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for StowJob","operationId":"searchStowJob","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StowJobSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StowJobPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List stow jobs (search)","tags":["Stowing"]}}}}
```

## List categories (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for Category

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read categories.","name":"Categories"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CategorySearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/CategorySearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/CategorySort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"CategorySearchPayload","type":"object","description":"CategorySearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"CategorySearchQuery":{"properties":{"nameLocalized":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by nameLocalized","type":"object"},"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/CategorySearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/LocalizedStringSearchFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/CategorySearchQuery"},"maxItems":500,"type":"array"},"tenantCategoryId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantCategoryId"}},"title":"CategorySearchQuery","type":"object","description":"CategorySearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"LocalizedStringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"CategorySort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"id":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantCategoryId":{"enum":["ASC","DESC"],"type":"string"}},"title":"CategorySort","type":"object","description":"CategorySort"},"CategoryPaginatedResult":{"properties":{"categories":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","categories"],"title":"CategoryPaginatedResult","type":"object","description":"CategoryPaginatedResult"},"Category":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version","created","lastModified"],"title":"Category","type":"object","description":"Category"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/categories/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for Category","operationId":"searchCategory","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorySearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List categories (search)","tags":["Categories"]}}}}
```

## List facilities (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for Facility

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facilities represent various locations that form part of the fulfillment network.","name":"Facilities"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilitySearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/FacilitySearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/FacilitySort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"FacilitySearchPayload","type":"object","description":"FacilitySearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"FacilitySearchQuery":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressFilter"}],"description":"Nested search by address"},"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/FacilitySearchQuery"},"maxItems":500,"type":"array"},"contact":{"allOf":[{"$ref":"#/components/schemas/FacilityContactFilter"}],"description":"Nested search by contact"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityGroupIds":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Filter facilities by facility group membership"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"locationType":{"allOf":[{"$ref":"#/components/schemas/FacilityLocationTypeEnumFilter"}],"description":"Search by locationType"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/FacilitySearchQuery"},"maxItems":500,"type":"array"},"referenced":{"allOf":[{"$ref":"#/components/schemas/FacilityReferenceFilter"}],"description":"References to other entities"},"services":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesListFilter"}],"description":"Nested list search by services"},"status":{"allOf":[{"$ref":"#/components/schemas/FacilityStatusEnumFilter"}],"description":"Search by status"},"tenantFacilityId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantFacilityId"},"type":{"allOf":[{"$ref":"#/components/schemas/FacilityTypeEnumFilter"}],"description":"Search by type"},"tags":{"allOf":[{"$ref":"#/components/schemas/FacilityTagsListFilter"}],"description":"Nested list search by tags"}},"title":"FacilitySearchQuery","type":"object","description":"FacilitySearchQuery"},"FacilityAddressFilter":{"properties":{"city":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"emailAddresses":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesListFilter"}],"description":"Nested list search by emailAddresses"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"FacilityAddressFilter","type":"object","description":"FacilityAddressFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"FacilityAddressEmailAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressEmailAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityAddressEmailAddressesListFilter","type":"object","description":"FacilityAddressEmailAddressesListFilter"},"FacilityAddressEmailAddressesFilter":{"properties":{"recipient":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recipient"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityAddressEmailAddressesFilter","type":"object","description":"FacilityAddressEmailAddressesFilter"},"FacilityContactFilter":{"properties":{"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"}},"title":"FacilityContactFilter","type":"object","description":"FacilityContactFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"FacilityLocationTypeEnumFilter":{"properties":{"eq":{"description":"Search by locationType","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"},"in":{"description":"Search by locationType","items":{"enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by locationType","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string"}},"title":"FacilityLocationTypeEnumFilter","type":"object","description":"FacilityLocationTypeEnumFilter"},"FacilityReferenceFilter":{"properties":{"facilityCarrierConnection":{"allOf":[{"$ref":"#/components/schemas/FacilityFacilityCarrierConnectionFilter"}],"description":"The referenced entity"}},"title":"FacilityReferenceFilter","type":"object","description":"FacilityReferenceFilter"},"FacilityFacilityCarrierConnectionFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Filter facilities by configured carrier key"}},"title":"FacilityFacilityCarrierConnectionFilter","type":"object","description":"FacilityFacilityCarrierConnectionFilter"},"FacilityServicesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityServicesListFilter","type":"object","description":"FacilityServicesListFilter"},"FacilityServicesFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/FacilityServicesFacilityServiceTypeEnumFilter"}],"description":"Search by type"}},"title":"FacilityServicesFilter","type":"object","description":"FacilityServicesFilter"},"FacilityServicesFacilityServiceTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"}},"title":"FacilityServicesFacilityServiceTypeEnumFilter","type":"object","description":"FacilityServicesFacilityServiceTypeEnumFilter"},"FacilityStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"}},"title":"FacilityStatusEnumFilter","type":"object","description":"FacilityStatusEnumFilter"},"FacilityTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string"}},"title":"FacilityTypeEnumFilter","type":"object","description":"FacilityTypeEnumFilter"},"FacilityTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/FacilityTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"FacilityTagsListFilter","type":"object","description":"FacilityTagsListFilter"},"FacilityTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"FacilityTagsFilter","type":"object","description":"FacilityTagsFilter"},"FacilitySort":{"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressSort"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"id":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"locationType":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"services":{"$ref":"#/components/schemas/FacilityServicesSort"},"status":{"enum":["ASC","DESC"],"type":"string"},"tenantFacilityId":{"enum":["ASC","DESC"],"type":"string"},"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilitySort","type":"object","description":"FacilitySort"},"FacilityAddressSort":{"properties":{"city":{"enum":["ASC","DESC"],"type":"string"},"country":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityAddressSort","type":"object","description":"FacilityAddressSort"},"FacilityServicesSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityServicesSort","type":"object","description":"FacilityServicesSort"},"FacilityPaginatedResult":{"properties":{"facilities":{"items":{"oneOf":[{"$ref":"#/components/schemas/ManagedFacility"},{"$ref":"#/components/schemas/Supplier"}]},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","facilities"],"title":"FacilityPaginatedResult","type":"object","description":"FacilityPaginatedResult"},"ManagedFacility":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/ManagedFacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddress"},"configs":{"items":{"$ref":"#/components/schemas/LinkedConfiguration"},"type":"array"}},"required":["status","address","name"],"type":"object","xml":{"name":"ManagedFacility"},"title":"ManagedFacility","description":"ManagedFacility"},"Facility":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"id":{"description":"The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCost"},"maxItems":1,"type":"array"}},"required":["id","type","status"],"type":"object","xml":{"name":"Facility"},"title":"Facility","description":"Facility"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"FacilityForCreation":{"properties":{"customAttributes":{"description":"Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"name":{"type":"string"},"operativeCosts":{"items":{"$ref":"#/components/schemas/FacilityOperativeCostForCreation"},"maxItems":1,"type":"array"},"status":{"$ref":"#/components/schemas/FacilityStatus"},"tenantFacilityId":{"description":"The id of the facility in the tenants own system","type":"string"},"type":{"$ref":"#/components/schemas/FacilityType","default":"MANAGED_FACILITY"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["name"],"type":"object","xml":{"name":"FacilityForCreation"},"title":"FacilityForCreation","description":"FacilityForCreation"},"FacilityOperativeCostForCreation":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency. We be defaulted according to the currency if missing.","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency"],"type":"object","title":"FacilityOperativeCostForCreation","description":"FacilityOperativeCostForCreation"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"FacilityStatus":{"description":"The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.","enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string","title":"FacilityStatus"},"FacilityType":{"default":"MANAGED_FACILITY","enum":["MANAGED_FACILITY","SUPPLIER"],"type":"string","xml":{"name":"FacilityType"},"title":"FacilityType","description":"FacilityType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"FacilityOperativeCost":{"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code.","nullable":true,"type":"string"},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Value of operational cost of the facility. Value is configured in the smallest subunit, e.g. cents.","minimum":0,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityOperativeCost","description":"FacilityOperativeCost"},"ManagedFacilityForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/FacilityAddressForCreation"},"capacityEnabled":{"default":false,"description":"Indicates that configured capacity limits for picking times are considered","type":"boolean"},"capacityPlanningTimeframe":{"description":"The range in days per facility which defines how many days in the future the capacity of the facility can be planned","minimum":1,"type":"integer"},"closingDays":{"description":"Days of the year where the facility is closed and doesn't allows picking","items":{"$ref":"#/components/schemas/ClosingDay"},"type":"array"},"contact":{"$ref":"#/components/schemas/FacilityContact"},"fulfillmentProcessBuffer":{"default":240,"description":"Duration in minutes until an order is processed","minimum":0,"type":"integer"},"locationType":{"$ref":"#/components/schemas/FacilityLocationType"},"pickingMethods":{"description":"Picking Methods supported by this facility.","items":{"$ref":"#/components/schemas/PickingMethodEnum"},"type":"array"},"pickingTimes":{"$ref":"#/components/schemas/PickingTimes","description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"services":{"items":{"$ref":"#/components/schemas/FacilityService"},"type":"array"}},"required":["name","address"],"type":"object","xml":{"name":"ManagedFacilityForCreation"},"title":"ManagedFacilityForCreation","description":"ManagedFacilityForCreation"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"ClosingDay":{"description":"At this day the facility is closed and does not do picking","properties":{"date":{"description":"The day at which the Facility is closed","format":"date-time","type":"string"},"reason":{"description":"The reason why the Facility is closed on this day","type":"string"},"recurrence":{"enum":["YEARLY","NONRECURRING"],"type":"string"}},"required":["reason","date","recurrence"],"type":"object","title":"ClosingDay"},"FacilityContact":{"properties":{"customAttributes":{"description":"Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"firstName":{"type":"string"},"lastName":{"type":"string"},"roleDescription":{"type":"string"}},"required":["firstName","lastName"],"type":"object","xml":{"name":"FacilityContact"},"title":"FacilityContact","description":"FacilityContact"},"FacilityLocationType":{"default":"STORE","enum":["STORE","WAREHOUSE","EXTERNAL"],"type":"string","xml":{"name":"FacilityLocationType"},"title":"FacilityLocationType","description":"FacilityLocationType"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"PickingTimes":{"description":"Time ranges defining the picking times per weekday. No overlapping ranges are allowed. There must be no overlaps for time ranges on a day","properties":{"friday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"monday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"saturday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"sunday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"thursday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"tuesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"},"wednesday":{"items":{"$ref":"#/components/schemas/TimeRange"},"type":"array"}},"type":"object","title":"PickingTimes"},"TimeRange":{"properties":{"capacity":{"minimum":0,"type":"number"},"end":{"$ref":"#/components/schemas/TimeStamp"},"start":{"$ref":"#/components/schemas/TimeStamp"}},"required":["start","end"],"type":"object","title":"TimeRange","description":"TimeRange"},"TimeStamp":{"properties":{"hour":{"maximum":23,"minimum":0,"type":"number"},"minute":{"maximum":59,"minimum":0,"type":"number"}},"required":["hour","minute"],"type":"object","title":"TimeStamp","description":"TimeStamp"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"FacilityService":{"additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/FacilityServiceType"}},"required":["type"],"type":"object","xml":{"name":"FacilityService"},"title":"FacilityService","description":"FacilityService"},"FacilityServiceType":{"description":"The description of the service this facility offers.","enum":["SHIP_FROM_STORE","PICKUP"],"type":"string","title":"FacilityServiceType"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"LinkedConfiguration":{"properties":{"ref":{"type":"string"},"rel":{"type":"string"}},"type":"object","title":"LinkedConfiguration","description":"LinkedConfiguration"},"Supplier":{"allOf":[{"$ref":"#/components/schemas/Facility"},{"$ref":"#/components/schemas/SupplierForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddress"}},"type":"object","xml":{"name":"Supplier"},"title":"Supplier","description":"Supplier"},"SupplierForCreation":{"allOf":[{"$ref":"#/components/schemas/FacilityForCreation"}],"properties":{"address":{"$ref":"#/components/schemas/SupplierAddressForCreation"}},"type":"object","xml":{"name":"SupplierForCreation"},"title":"SupplierForCreation","description":"SupplierForCreation"},"SupplierAddressForCreation":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"companyName":{"type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"emailAddresses":{"items":{"$ref":"#/components/schemas/SupplierAddressEmailAddress"},"type":"array"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"$ref":"#/components/schemas/SupplierAddressPhoneNumber"},"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZoneForCreation","description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."},"street":{"pattern":"^.+$","type":"string"}},"required":["country","companyName"],"type":"object","title":"SupplierAddressForCreation","description":"SupplierAddressForCreation"},"SupplierAddressEmailAddress":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"format":"email","type":"string"}},"required":["value"],"type":"object","title":"SupplierAddressEmailAddress","description":"SupplierAddressEmailAddress"},"SupplierAddressPhoneNumber":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object","title":"SupplierAddressPhoneNumber","description":"SupplierAddressPhoneNumber"},"SupplierAddress":{"allOf":[{"$ref":"#/components/schemas/SupplierAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","title":"SupplierAddress","description":"SupplierAddress"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for Facility","operationId":"searchFacility","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilitySearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List facilities (search)","tags":["Facilities"]}}}}
```

## List reservations (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for Reservation

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints handle reservations.","name":"Reservations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReservationSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/ReservationSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/ReservationSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"ReservationSearchPayload","type":"object","description":"ReservationSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"ReservationSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/ReservationRelatedRefsFilter"}],"description":"Nested search by relatedRefs"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"ReservationSearchQuery","type":"object","description":"ReservationSearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"ReservationRelatedRefsFilter":{"properties":{"orderRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by orderRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"transferRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by transferRefs"}},"title":"ReservationRelatedRefsFilter","type":"object","description":"ReservationRelatedRefsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ReservationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ReservationSort","type":"object","description":"ReservationSort"},"ReservationPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"reservations":{"items":{"$ref":"#/components/schemas/Reservation"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","reservations"],"title":"ReservationPaginatedResult","type":"object","description":"ReservationPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Reservation":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"host":{"$ref":"#/components/schemas/ReservationHost"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"quantity":{"type":"number"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/RelatedRefs"}]},"tenantArticleId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","facilityRef","host","id","quantity","relatedRefs","tenantArticleId"],"title":"Reservation","type":"object","description":"Reservation"},"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"},"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/reservations/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for Reservation","operationId":"searchReservation","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReservationSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReservationPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List reservations (search)","tags":["Reservations"]}}}}
```

## List handover job (search)

> Search for HandoverJob

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to manage the handover process.","name":"Handovers"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"HandoverJobSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/HandoverJobSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/HandoverJobSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"HandoverJobSearchPayload","type":"object","description":"HandoverJobSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"HandoverJobSearchQuery":{"properties":{"additionalHandoverJobLineItems":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsListFilter"}],"description":"Nested list search by additionalHandoverJobLineItems"},"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/HandoverJobSearchQuery"},"maxItems":500,"type":"array"},"anonymized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by anonymized"},"assignedUsers":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAssignedUsersListFilter"}],"description":"Nested list search by assignedUsers"},"channel":{"allOf":[{"$ref":"#/components/schemas/HandoverJobChannelEnumEnumFilter"}],"description":"Search by channel"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"fullIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by fullIdentifier"},"handoverJobLineItems":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsListFilter"}],"description":"Nested list search by handoverJobLineItems"},"handoverJobParcelInfo":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobParcelInfoFilter"}],"description":"Nested search by handoverJobParcelInfo"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoiceAddress":{"allOf":[{"$ref":"#/components/schemas/HandoverJobInvoiceAddressFilter"}],"description":"Nested search by invoiceAddress"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/HandoverJobSearchQuery"},"maxItems":500,"type":"array"},"pickJobRef":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by pickJobRef"},"pickupIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringEqFilter"}],"description":"Search by pickupIdentifier"},"recipientAddress":{"allOf":[{"$ref":"#/components/schemas/HandoverJobRecipientAddressFilter"}],"description":"Nested search by recipientAddress"},"shortIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortIdentifier"},"status":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverjobStatusEnumFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"}},"title":"HandoverJobSearchQuery","type":"object","description":"HandoverJobSearchQuery"},"HandoverJobAdditionalHandoverJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"HandoverJobAdditionalHandoverJobLineItemsListFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsListFilter"},"HandoverJobAdditionalHandoverJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAdditionalHandoverJobLineItemsArticleFilter"}],"description":"Nested search by article"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"}},"title":"HandoverJobAdditionalHandoverJobLineItemsFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsFilter"},"HandoverJobAdditionalHandoverJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter","type":"object","description":"HandoverJobAdditionalHandoverJobLineItemsArticleFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"HandoverJobAssignedUsersListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobAssignedUsersFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"HandoverJobAssignedUsersListFilter","type":"object","description":"HandoverJobAssignedUsersListFilter"},"HandoverJobAssignedUsersFilter":{"properties":{"userId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by userId"},"username":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by username"}},"title":"HandoverJobAssignedUsersFilter","type":"object","description":"HandoverJobAssignedUsersFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"HandoverJobChannelEnumEnumFilter":{"properties":{"eq":{"description":"Search by channel","enum":["DELIVERY","COLLECT"],"type":"string"},"in":{"description":"Search by channel","items":{"enum":["DELIVERY","COLLECT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by channel","enum":["DELIVERY","COLLECT"],"type":"string"}},"title":"HandoverJobChannelEnumEnumFilter","type":"object","description":"HandoverJobChannelEnumEnumFilter"},"HandoverJobHandoverJobLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"HandoverJobHandoverJobLineItemsListFilter","type":"object","description":"HandoverJobHandoverJobLineItemsListFilter"},"HandoverJobHandoverJobLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsArticleFilter"}],"description":"Nested search by article"},"substituteLineItems":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter"}],"description":"Nested list search by substituteLineItems"}},"title":"HandoverJobHandoverJobLineItemsFilter","type":"object","description":"HandoverJobHandoverJobLineItemsFilter"},"HandoverJobHandoverJobLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"HandoverJobHandoverJobLineItemsArticleFilter","type":"object","description":"HandoverJobHandoverJobLineItemsArticleFilter"},"HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter","type":"object","description":"HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter"},"HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter","type":"object","description":"HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter"},"HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by title"}},"title":"HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter","type":"object","description":"HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter"},"HandoverJobHandoverJobParcelInfoFilter":{"properties":{"carrierKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierKey"},"carrierRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierRef"},"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by carrierTrackingNumber"},"shipmentRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shipmentRef"}},"title":"HandoverJobHandoverJobParcelInfoFilter","type":"object","description":"HandoverJobHandoverJobParcelInfoFilter"},"HandoverJobInvoiceAddressFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by companyName"},"email":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastName"}},"title":"HandoverJobInvoiceAddressFilter","type":"object","description":"HandoverJobInvoiceAddressFilter"},"HandoverJobRecipientAddressFilter":{"properties":{"companyName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by companyName"},"email":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by firstName"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by lastName"}},"title":"HandoverJobRecipientAddressFilter","type":"object","description":"HandoverJobRecipientAddressFilter"},"HandoverJobHandoverjobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string"}},"title":"HandoverJobHandoverjobStatusEnumFilter","type":"object","description":"HandoverJobHandoverjobStatusEnumFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"HandoverJobSort":{"properties":{"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"HandoverJobSort","type":"object","description":"HandoverJobSort"},"HandoverJobPaginatedResult":{"properties":{"handoverJobs":{"items":{"$ref":"#/components/schemas/Handoverjob"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","handoverJobs"],"title":"HandoverJobPaginatedResult","type":"object","description":"HandoverJobPaginatedResult"},"Handoverjob":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"additionalHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/AdditionalHandoverJobLineItem"},"maxItems":100,"minItems":0,"type":"array"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"type":"array"},"cancelReason":{"$ref":"#/components/schemas/HandoverJobCancelReason"},"carrierKey":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierLogoUrl":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierRef":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"carrierTrackingNumber":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"channel":{"$ref":"#/components/schemas/HandoverjobChannel"},"customAttributes":{"description":"Attributes that can be added to the handover job. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documents":{"items":{"$ref":"#/components/schemas/PrintableDocument"},"type":"array"},"documentsRef":{"description":"Reference to the documents collection from this entity","type":"string"},"expectedHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/ExpectedHandoverLineItem"},"type":"array"},"facilityRef":{"description":"The id of the facility reference.","type":"string"},"fullIdentifier":{"description":"An information to identify the recipient","type":"string"},"handoverJobLineItems":{"items":{"$ref":"#/components/schemas/HandoverLineItem"}},"handoverJobParcelInfo":{"$ref":"#/components/schemas/HandoverJobParcelInfo"},"id":{"description":"The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"invoiceAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"loadUnitRefs":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />This field is deprecated since 30 April 2026. HandoverJobs should not be aware of load units. The relation to load units are via handover container, if there ist a relation.","items":{"type":"string"},"type":"array","deprecated":true},"missingHandoverJobLineItems":{"items":{"$ref":"#/components/schemas/MissingHandoverJobLineItem"},"type":"array"},"operativeProcessRef":{"type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"paid":{"description":"Indicates if the order is already paid","type":"boolean"},"parcelRef":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"pickJobRef":{"description":"The reference to the pickjob for which the handoverjob is assigned to","type":"string"},"pickupIdentifier":{"description":"A short, human readable code used to identify this handoverjob when a customer collects the order at the facility, either by scanning a QR code or by typing the code into a search. It is generated automatically during creation and cannot be set or changed by clients. Consists of 10 characters from the alphabet 0123456789ABCDEFGHJKMNPQRSTVWXYZ, which omits the easily confused letters I, L, O and U. Clients may display it grouped, for example H7K29-XQRM4. The code is drawn at random from a space of 32^10 and uniqueness is not enforced, so a lookup by pickupIdentifier can in rare cases return more than one handoverjob and clients should be able to handle that.","type":"string"},"pickupServices":{"items":{"$ref":"#/components/schemas/HandoverJobPickupService"},"maxItems":100,"type":"array"},"pricing":{"$ref":"#/components/schemas/OrderPricing"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"recipientAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"scannableCodes":{"description":"Codes that can be used for scanning this handover job","items":{"type":"string"},"maxItems":20,"type":"array"},"sentNotifications":{"$ref":"#/components/schemas/HandoverJobSentNotifications"},"shipmentRef":{"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 28 November 2024. Use nested object handoverJobParcelInfo instead.","type":"string","deprecated":true},"shortIdentifier":{"description":"The short identifier of the shipment.","type":"string"},"status":{"$ref":"#/components/schemas/HandoverjobStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"targetTime":{"description":"The time the handoverjob is expected to be picked up at the facility.","format":"date-time","type":"string"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/OperativeTransfer"},"minItems":0,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]},"tags":{"description":"Tags can only be set when there is no process related with this handoverJob. Setting processId and tags will lead to an validationError.","items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}}}],"required":["id","status","facilityRef","targetTime","channel","orderDate","workflowInformation"],"type":"object","title":"Handoverjob","description":"Handoverjob"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"AdditionalHandoverJobLineItem":{"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"quantity":{"format":"int64","minimum":1,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity"],"title":"AdditionalHandoverJobLineItem","description":"AdditionalHandoverJobLineItem"},"MandatoryLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/LineItemArticle"}],"description":"Information about the lineItem"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"number"}},"required":["id","article","quantity"],"title":"MandatoryLineItem","type":"object","description":"MandatoryLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in fulfillmenttools clients. Details about usage can be found in the <a href=\\\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":50,"type":"array"},"customAttributes":{"deprecated":true,"description":"Deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"ID of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The ID of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"HandoverLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"HandoverLineItemArticle"},"title":"HandoverLineItemArticle","description":"HandoverLineItemArticle"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"HandoverJobCancelReason":{"enum":["CONSUMER_NO_SHOW","CONSUMER_REJECTS","ORDER_CANCELED"],"type":"string","title":"HandoverJobCancelReason","description":"HandoverJobCancelReason"},"HandoverjobChannel":{"enum":["DELIVERY","COLLECT"],"type":"string","title":"HandoverjobChannel","description":"HandoverjobChannel"},"PrintableDocument":{"properties":{"customAttributes":{"description":"Attributes that can be added to the document. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"},"documentType":{"$ref":"#/components/schemas/DocumentType"},"id":{"type":"string"},"name":{"type":"string"},"operations":{"description":"Offered operations for this document","items":{"$ref":"#/components/schemas/DocumentOperations"},"type":"array"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"status":{"$ref":"#/components/schemas/DocumentStatus"}},"required":["documentType","id","status","documentCategory"],"type":"object","title":"PrintableDocument","description":"PrintableDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"},"DocumentOperations":{"enum":["PRINT","VIEW"],"type":"string","title":"DocumentOperations","description":"DocumentOperations"},"DocumentStatus":{"enum":["AVAILABLE","LOADING","REQUESTABLE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"DocumentStatus","description":"DocumentStatus"},"ExpectedHandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/ExpectedHandoverLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"ExpectedHandoverLineItem","description":"ExpectedHandoverLineItem"},"ExpectedHandoverLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"transferId":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"ExpectedHandoverLineItemForCreation","description":"ExpectedHandoverLineItemForCreation"},"HandoverLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MandatoryLineItem"},{"$ref":"#/components/schemas/SubstitutedLineItem"},{"$ref":"#/components/schemas/ServiceJobAlteredLineItem"}],"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","nullable":true,"type":"string"},"quantity":{"description":"quantity of the specific item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"status":{"$ref":"#/components/schemas/HandoverLineItemStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"substituteLineItems":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/HandoverSubstituteLineItem"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["id","article","quantity","handedOverQuantity"],"title":"HandoverLineItem","description":"HandoverLineItem"},"SubstitutedLineItem":{"properties":{"substituteForOrderedItem":{"$ref":"#/components/schemas/SubstituteForOrderedItem"}},"title":"SubstitutedLineItem","type":"object","description":"SubstitutedLineItem"},"SubstituteForOrderedItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"globalLineItemId":{"description":"This ID is used to identify if this line item is related to the line item of other operational entities.","type":"string"}},"required":["article","globalLineItemId"],"title":"SubstituteForOrderedItem","type":"object","description":"SubstituteForOrderedItem"},"ServiceJobAlteredLineItem":{"properties":{"serviceJobRefs":{"description":"Reference to the service jobs that have altered this line item","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"title":"ServiceJobAlteredLineItem","type":"object","description":"ServiceJobAlteredLineItem"},"RefusedItem":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"comment":{"type":"string"},"quantity":{"minimum":0,"type":"integer"},"reason":{"type":"string"}},"required":["quantity"],"type":"object","title":"RefusedItem","description":"RefusedItem"},"HandoverLineItemStatus":{"enum":["OPEN","CLOSED"],"type":"string","title":"HandoverLineItemStatus","description":"HandoverLineItemStatus"},"HandoverSubstituteLineItem":{"properties":{"article":{"$ref":"#/components/schemas/SubstituteLineItemArticle"},"handedOverQuantity":{"description":"quantity of the specific item to substitute the original line item that has been handed over","format":"int64","minimum":0,"type":"integer"},"id":{"type":"string"},"partialStockLocations":{"items":{"$ref":"#/components/schemas/SubstituteLineItemPartialStockLocation"},"type":"array"},"pickedAt":{"description":"Date when the line has been picked.","format":"date-time","type":"string"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"quantity":{"description":"quantity of the specific item to substitute the original line item that has been provided for handover","format":"int64","minimum":1,"type":"integer"},"refused":{"items":{"$ref":"#/components/schemas/RefusedItem"},"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"}},"required":["quantity","article","id"],"title":"HandoverSubstituteLineItem","description":"HandoverSubstituteLineItem"},"SubstituteLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":40,"type":"array"}},"type":"object"}],"xml":{"name":"SubstituteLineItemArticle"},"title":"SubstituteLineItemArticle","description":"SubstituteLineItemArticle"},"SubstituteLineItemPartialStockLocation":{"properties":{"location":{"$ref":"#/components/schemas/Location"},"picked":{"format":"int64","minimum":0,"type":"number"},"quantity":{"format":"int64","minimum":0,"type":"number"},"ratingScore":{"type":"number"},"sequenceScore":{"type":"number"},"stockProperties":{"anyOf":[{"$ref":"#/components/schemas/PickingStockPropertyPreset"},{"$ref":"#/components/schemas/PickingStockProperty"}]},"stockRef":{"type":"string"},"tenantPartialStockId":{"type":"string"},"zoneName":{"type":"string"}},"required":["location","quantity"],"type":"object","title":"SubstituteLineItemPartialStockLocation","description":"SubstituteLineItemPartialStockLocation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"maxItems":50,"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"PickingStockPropertyPreset":{"description":"Preset of Picking Stock Property.","properties":{"expiry":{"type":"string"}},"title":"PickingStockPropertyPreset","type":"object"},"PickingStockProperty":{"additionalProperties":{"type":"string"},"description":"Picking Stock Property.","title":"PickingStockProperty","type":"object"},"HandoverJobParcelInfo":{"allOf":[{"$ref":"#/components/schemas/HandoverJobParcelInfoForCreation"},{"properties":{"carrierKey":{"description":"the key of the carrier","type":"string"}}}],"type":"object","title":"HandoverJobParcelInfo","description":"HandoverJobParcelInfo"},"HandoverJobParcelInfoForCreation":{"additionalProperties":false,"properties":{"carrierLogoUrl":{"description":"The URL to the carrier logo","type":"string"},"carrierParcelRef":{"description":"The reference number of the parcel by the carrier","maxLength":120,"minLength":1,"type":"string"},"carrierRef":{"description":"the reference to the related carrier","type":"string"},"carrierTrackingNumber":{"description":"the tracking number of the parcel","type":"string"},"parcelRef":{"description":"the reference to the related parcel","type":"string"},"shipmentRef":{"description":"the reference to the related shipment","type":"string"}},"type":"object","title":"HandoverJobParcelInfoForCreation","description":"HandoverJobParcelInfoForCreation"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"MissingHandoverJobLineItem":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MissingHandoverJobLineItemForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","title":"MissingHandoverJobLineItem","description":"MissingHandoverJobLineItem"},"MissingHandoverJobLineItemForCreation":{"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/HandoverLineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"quantity":{"description":"quantity of the specific item that is missing","format":"int64","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"type":"array"}},"required":["quantity","article"],"type":"object","title":"MissingHandoverJobLineItemForCreation","description":"MissingHandoverJobLineItemForCreation"},"HandoverJobPickupService":{"additionalProperties":false,"properties":{"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"applied":{"description":"indicates if the pickup service has been applied","type":"boolean"},"description":{"description":"Localized description of pickup service","type":"string"},"id":{"description":"Identifies the single HandoverJobPickupService of a HandoverJob","type":"string"},"name":{"description":"Localized name of pickup service","type":"string"},"type":{"description":"Type of the pickup service","type":"string"}},"required":["id","type","applied"],"title":"HandoverJobPickupService","description":"HandoverJobPickupService"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"HandoverJobSentNotifications":{"additionalProperties":false,"description":"Markers whether the respective notification was already sent for this handover job. Maintained by the system.","properties":{"overdueDetected":{"default":false,"description":"Indicates if the overdue (targetTime is in the past) notification was already sent.","type":"boolean"}},"type":"object","title":"HandoverJobSentNotifications"},"HandoverjobStatus":{"description":"Status of a Handover Job.\n- OPEN: Active and ready for processing (default initial state)\n- WAITING_FOR_INPUT: Waiting for line items to be populated\n- HANDED_OVER: Items have been handed over (completion state)\n- CANCELED: Handover job was canceled\n- OBSOLETE: No longer relevant (terminal state, cannot transition out)\n","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string","title":"HandoverjobStatus"},"OperativeTransfer":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the transfer","type":"string"},"type":{"description":"The type of the transfer","enum":["SUPPLIER","RECEIVER"],"type":"string"}},"required":["id","type"],"title":"OperativeTransfer","type":"object","description":"OperativeTransfer"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/handoverjobs/search":{"post":{"deprecated":false,"description":"Search for HandoverJob","operationId":"searchHandoverJob","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverJobSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverJobPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List handover job (search)","tags":["Handovers"]}}}}
```

## List facility groups (search)

> Search for FacilityGroup

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Facility groups combine one or multiple facilities into logical groups.","name":"Facility groups"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"FacilityGroupSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/FacilityGroupSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/FacilityGroupSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"FacilityGroupSearchPayload","type":"object","description":"FacilityGroupSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"FacilityGroupSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/FacilityGroupSearchQuery"},"maxItems":500,"type":"array"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/LocalizedStringSearchFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/FacilityGroupSearchQuery"},"maxItems":500,"type":"array"},"tenantFacilityGroupId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantFacilityGroupId"}},"title":"FacilityGroupSearchQuery","type":"object","description":"FacilityGroupSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"LocalizedStringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"},"FacilityGroupSort":{"properties":{"facilityCount":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantFacilityGroupId":{"enum":["ASC","DESC"],"type":"string"}},"title":"FacilityGroupSort","type":"object","description":"FacilityGroupSort"},"FacilityGroupPaginatedResult":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/FacilityGroup"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","facilityGroups"],"title":"FacilityGroupPaginatedResult","type":"object","description":"FacilityGroupPaginatedResult"},"FacilityGroup":{"properties":{"nameLocalized":{"additionalProperties":{"type":"string"},"description":"The localized name","type":"object"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"Attributes that can be added to the facility group. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","nullable":true,"type":"object"},"facilityCount":{"description":"The number of facilities in this group","type":"number"},"facilityRefs":{"description":"Array of facility references belonging to this group. Cannot exceed your quota, default 1000. Each facility can be assigned to at most 20 facility groups (default).","items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"description":"The facility group ID","type":"string"},"lastModified":{"description":"Last modified timestamp","format":"date-time","type":"string"},"name":{"description":"The name of the facility group","type":"string"},"tenantFacilityGroupId":{"description":"The id of the facility group in the tenants own system","type":"string"},"version":{"description":"Document version for optimistic locking","type":"number"}},"required":["tenantFacilityGroupId","facilityRefs","nameLocalized","id","version","created","lastModified","facilityCount"],"title":"FacilityGroup","type":"object","description":"FacilityGroup"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilitygroups/search":{"post":{"deprecated":false,"description":"Search for FacilityGroup","operationId":"searchFacilityGroup","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroupSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacilityGroupPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List facility groups (search)","tags":["Facility groups"]}}}}
```

## List inbound processes (search)

> Search for InboundProcess

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundProcessSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/InboundProcessSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/InboundProcessSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"InboundProcessSearchPayload","type":"object","description":"InboundProcessSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"InboundProcessSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/InboundProcessSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"inboundDate":{"allOf":[{"$ref":"#/components/schemas/DateListFilter"}],"description":"Search by inboundDate"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/InboundProcessSearchQuery"},"maxItems":500,"type":"array"},"purchaseOrder":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderFilter"}],"description":"Nested search by purchaseOrder"},"receipts":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsListFilter"}],"description":"Nested list search by receipts"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessStatusTypeEnumFilter"}],"description":"Search by status"},"tenantInboundProcessId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantInboundProcessId"}},"title":"InboundProcessSearchQuery","type":"object","description":"InboundProcessSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"DateListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/DateEqFilter"}},"title":"DateListFilter","type":"object","description":"DateListFilter"},"DateEqFilter":{"properties":{"eq":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateEqFilter","type":"object","description":"DateEqFilter"},"InboundProcessPurchaseOrderFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateFilter"}],"description":"Nested search by requestedDate"},"requestedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsListFilter"}],"description":"Nested list search by requestedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"}],"description":"Search by status"},"supplier":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplierFilter"}],"description":"Nested search by supplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransferFilter"}],"description":"Nested search by transfer"}},"title":"InboundProcessPurchaseOrderFilter","type":"object","description":"InboundProcessPurchaseOrderFilter"},"InboundProcessPurchaseOrderRequestedDateFilter":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"}],"description":"Search by type"},"value":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by value"}},"title":"InboundProcessPurchaseOrderRequestedDateFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateFilter"},"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["ASAP","TIME_POINT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["ASAP","TIME_POINT"],"type":"string"}},"title":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter"},"InboundProcessPurchaseOrderRequestedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderRequestedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessPurchaseOrderRequestedItemsListFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsListFilter"},"InboundProcessPurchaseOrderRequestedItemsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessPurchaseOrderRequestedItemsFilter","type":"object","description":"InboundProcessPurchaseOrderRequestedItemsFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELED"],"type":"string"}},"title":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter","type":"object","description":"InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter"},"InboundProcessPurchaseOrderSupplierFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"}},"title":"InboundProcessPurchaseOrderSupplierFilter","type":"object","description":"InboundProcessPurchaseOrderSupplierFilter"},"InboundProcessPurchaseOrderTransferFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"}},"title":"InboundProcessPurchaseOrderTransferFilter","type":"object","description":"InboundProcessPurchaseOrderTransferFilter"},"InboundProcessReceiptsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessReceiptsListFilter","type":"object","description":"InboundProcessReceiptsListFilter"},"InboundProcessReceiptsFilter":{"properties":{"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"receivedDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by receivedDate"},"receivedItems":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsListFilter"}],"description":"Nested list search by receivedItems"},"status":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"}],"description":"Search by status"}},"title":"InboundProcessReceiptsFilter","type":"object","description":"InboundProcessReceiptsFilter"},"InboundProcessReceiptsReceivedItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/InboundProcessReceiptsReceivedItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"InboundProcessReceiptsReceivedItemsListFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsListFilter"},"InboundProcessReceiptsReceivedItemsFilter":{"properties":{"stockProperties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by stockProperties","type":"object"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"InboundProcessReceiptsReceivedItemsFilter","type":"object","description":"InboundProcessReceiptsReceivedItemsFilter"},"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"title":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter","type":"object","description":"InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"InboundProcessStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"}},"title":"InboundProcessStatusTypeEnumFilter","type":"object","description":"InboundProcessStatusTypeEnumFilter"},"InboundProcessSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"po_created":{"enum":["ASC","DESC"],"type":"string"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSort"}},"title":"InboundProcessSort","type":"object","description":"InboundProcessSort"},"InboundProcessPurchaseOrderSort":{"properties":{"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InboundProcessRequestedDateSort"}]},"supplier":{"$ref":"#/components/schemas/InboundProcessSupplierSort"}},"title":"InboundProcessPurchaseOrderSort","type":"object","description":"InboundProcessPurchaseOrderSort"},"InboundProcessRequestedDateSort":{"properties":{"type":{"enum":["ASC","DESC"],"type":"string"},"value":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessRequestedDateSort","type":"object","description":"InboundProcessRequestedDateSort"},"InboundProcessSupplierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"InboundProcessSupplierSort","type":"object","description":"InboundProcessSupplierSort"},"InboundProcessPaginatedResult":{"properties":{"inboundProcesses":{"items":{"$ref":"#/components/schemas/InboundProcess"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","inboundProcesses"],"title":"InboundProcessPaginatedResult","type":"object","description":"InboundProcessPaginatedResult"},"InboundProcess":{"properties":{"anonymized":{"description":"Indicates the inbound process was anonymized acording to configured GDPR retention time.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundDate":{"description":"Aggregated dates from sources which advise incoming stock. Currently that is \"purchaseOrder\"","items":{"format":"date-time","type":"string"},"type":"array"},"lastModified":{"format":"date-time","type":"string"},"onHold":{"description":"Indicates if the inbound process is on hold and will not be processed further","type":"boolean"},"origin":{"description":"Aggregated origin data from sources which advise incoming stock. Currently that is just  \"purchaseOrder\"","items":{"$ref":"#/components/schemas/InboundProcessOrigin"},"type":"array"},"purchaseOrder":{"$ref":"#/components/schemas/InboundProcessPurchaseOrder"},"receipts":{"items":{"$ref":"#/components/schemas/InboundReceipt"},"type":"array"},"scannableCodes":{"description":"scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note","items":{"type":"string"},"type":"array"},"status":{"enum":["OPEN","PARTIAL_DELIVERY","ON_HOLD","CLOSED"],"type":"string"},"tenantInboundProcessId":{"type":"string"},"version":{"type":"number"}},"required":["facilityRef","id","version","created","lastModified","inboundDate","origin","anonymized","status","onHold","scannableCodes","receipts"],"title":"InboundProcess","type":"object","description":"InboundProcess"},"InboundProcessOrigin":{"properties":{"name":{"type":"string"}},"title":"InboundProcessOrigin","type":"object","description":"InboundProcessOrigin"},"InboundProcessPurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified"],"title":"InboundProcessPurchaseOrder","type":"object","description":"InboundProcessPurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"InboundReceipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","id"],"title":"InboundReceipt","type":"object","description":"InboundReceipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/inboundprocesses/search":{"post":{"deprecated":false,"description":"Search for InboundProcess","operationId":"searchInboundProcess","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcessSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundProcessPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List inbound processes (search)","tags":["Inbound"]}}}}
```

## List storage locations (search)

> Search for StorageLocation

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StorageLocationSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/StorageLocationSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/StorageLocationSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"StorageLocationSearchPayload","type":"object","description":"StorageLocationSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"StorageLocationSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StorageLocationSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StorageLocationSearchQuery"},"maxItems":500,"type":"array"},"referenced":{"allOf":[{"$ref":"#/components/schemas/StorageLocationReferencedFilter"}],"description":"Nested search by referenced"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"tenantLocationId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantLocationId"},"traits":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTraitEnumListFilter"}],"description":"Search by traits"},"type":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTypeEnumFilter"}],"description":"Search by type"},"zoneRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by zoneRef"}},"title":"StorageLocationSearchQuery","type":"object","description":"StorageLocationSearchQuery"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"StorageLocationReferencedFilter":{"properties":{"stock":{"allOf":[{"$ref":"#/components/schemas/StorageLocationReferencedStockFilter"}],"description":"Nested search by stock"}},"title":"StorageLocationReferencedFilter","type":"object","description":"StorageLocationReferencedFilter"},"StorageLocationReferencedStockFilter":{"properties":{"hasStocks":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Whether the storage locations has any stocks on it."},"sumOfValues":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"The sum of all stock values in this storage location, i.e. how much stock is stored in this location."}},"title":"StorageLocationReferencedStockFilter","type":"object","description":"StorageLocationReferencedStockFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StorageLocationTraitEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTraitEnumFilter"}],"description":"Search by traits"}},"title":"StorageLocationTraitEnumListFilter","type":"object","description":"StorageLocationTraitEnumListFilter"},"StorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StorageLocationTraitEnumFilter","type":"object","description":"StorageLocationTraitEnumFilter"},"StorageLocationTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"}},"title":"StorageLocationTypeEnumFilter","type":"object","description":"StorageLocationTypeEnumFilter"},"StorageLocationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantLocationId":{"enum":["ASC","DESC"],"type":"string"},"zoneRef":{"enum":["ASC","DESC"],"type":"string"}},"title":"StorageLocationSort","type":"object","description":"StorageLocationSort"},"StorageLocationPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"storageLocations":{"items":{"$ref":"#/components/schemas/StorageLocation"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","storageLocations"],"title":"StorageLocationPaginatedResult","type":"object","description":"StorageLocationPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/storagelocations/search":{"post":{"deprecated":false,"description":"Search for StorageLocation","operationId":"searchStorageLocation","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageLocationSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageLocationPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List storage locations (search)","tags":["Storage locations"]}}}}
```

## List linked service jobs (search)

> Search for LinkedServiceJobs

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LinkedServiceJobsSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/LinkedServiceJobsSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/LinkedServiceJobsSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"LinkedServiceJobsSearchPayload","type":"object","description":"LinkedServiceJobsSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"LinkedServiceJobsSearchQuery":{"properties":{"additionalInformation":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by additionalInformation"},"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/LinkedServiceJobsSearchQuery"},"maxItems":500,"type":"array"},"articleTitles":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by articleTitles"},"channel":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by channel"},"consumerName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerName"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoiceAddress":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by invoiceAddress"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"linkedServiceJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by linkedServiceJobRef"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/LinkedServiceJobsSearchQuery"},"maxItems":500,"type":"array"},"serviceName":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by serviceName"},"shippingAddress":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shippingAddress"},"status":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"},"usersModificationHistory":{"allOf":[{"$ref":"#/components/schemas/LinkedServiceJobsUsersModificationHistoryListFilter"}],"description":"Nested list search by usersModificationHistory"}},"title":"LinkedServiceJobsSearchQuery","type":"object","description":"LinkedServiceJobsSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"LinkedServiceJobsUsersModificationHistoryListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/LinkedServiceJobsUsersModificationHistoryFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"LinkedServiceJobsUsersModificationHistoryListFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryListFilter"},"LinkedServiceJobsUsersModificationHistoryFilter":{"properties":{"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"LinkedServiceJobsUsersModificationHistoryFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryFilter"},"LinkedServiceJobsSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"LinkedServiceJobsSort","type":"object","description":"LinkedServiceJobsSort"},"LinkedServiceJobsPaginatedResult":{"properties":{"linkedServiceJobs":{"items":{"$ref":"#/components/schemas/LinkedServiceJobs"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","linkedServiceJobs"],"title":"LinkedServiceJobsPaginatedResult","type":"object","description":"LinkedServiceJobsPaginatedResult"},"LinkedServiceJobs":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"facilityRef":{"description":"Id linked Facility from the includes service jobs","minLength":1,"type":"string"},"fullIdentifier":{"description":"Full identifier of the service job. Using the full name of the customer when created from an order.","minLength":1,"type":"string"},"id":{"description":"Unique ID of this linked service jobs group","minLength":1,"type":"string"},"includedServiceJobLinkIds":{"description":"searchable field of all included service job link ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"includedServiceJobRefs":{"description":"searchable field of all included service job ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this linked service jobs group belongs to","minLength":1,"type":"string"},"processRef":{"description":"ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process","minLength":1,"type":"string"},"serviceJobLinks":{"description":"Chain of service job links representing the execution order","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":1,"type":"array"},"status":{"description":"Current status of this linked service jobs group","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"targetTime":{"description":"Target time by which all linked service jobs are expected to be completed","format":"date-time","type":"string"},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"maxItems":500,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","processRef","facilityRef","targetTime","includedServiceJobLinkIds","includedServiceJobRefs","status","serviceJobLinks"],"title":"LinkedServiceJobs","type":"object","description":"LinkedServiceJobs"},"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/linkedservicejobs/search":{"post":{"deprecated":false,"description":"Search for LinkedServiceJobs","operationId":"searchLinkedServiceJobs","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedServiceJobsSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedServiceJobsPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List linked service jobs (search)","tags":["Services"]}}}}
```

## List all record items (search cached for 5 minutes)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for LookupRecordItem

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints used by shops to get the current available pickup stores and available service levels like same-day delivery.","name":"Checkout options"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LookupRecordItemSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/LookupRecordItemSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"LookupRecordItemSearchPayload","type":"object","description":"LookupRecordItemSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"LookupRecordItemSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/LookupRecordItemSearchQuery"},"maxItems":500,"type":"array"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/LookupRecordItemSearchQuery"},"maxItems":500,"type":"array"},"recordRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recordRef"},"tenantRecordId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantRecordId"},"values":{"allOf":[{"$ref":"#/components/schemas/LookupRecordItemValuesListFilter"}],"description":"Nested list search by values"}},"title":"LookupRecordItemSearchQuery","type":"object","description":"LookupRecordItemSearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"LookupRecordItemValuesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/LookupRecordItemValuesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"LookupRecordItemValuesListFilter","type":"object","description":"LookupRecordItemValuesListFilter"},"LookupRecordItemValuesFilter":{"properties":{"attributeId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeId"},"attributeValue":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeValue"}},"title":"LookupRecordItemValuesFilter","type":"object","description":"LookupRecordItemValuesFilter"},"LookupRecordItemPaginatedResult":{"properties":{"lookupRecordItems":{"items":{"$ref":"#/components/schemas/LookupRecordItem"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","lookupRecordItems"],"title":"LookupRecordItemPaginatedResult","type":"object","description":"LookupRecordItemPaginatedResult"},"LookupRecordItem":{"properties":{"id":{"type":"string"},"recordRef":{"description":"Reference to the parent lookup record.","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"values":{"$ref":"#/components/schemas/LookupRecordItemValue","description":"Array of attribute-value pairs for the lookup record item.","items":{"type":"string"}}},"required":["recordRef","values","id"],"title":"LookupRecordItem","type":"object","description":"LookupRecordItem"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/lookuprecorditems/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for LookupRecordItem","operationId":"searchLookupRecordItem","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecordItemSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecordItemPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List all record items (search cached for 5 minutes)","tags":["Checkout options"]}}}}
```


# Process

A process is the link between entities in fulfillmenttools. Each order, pick job, handover job, and so on, references a process, and each process maintains the IDs of its entities. Furthermore, the process includes the statuses of the domains, modules, and entities.

{% hint style="warning" %}
The expression domain for the fields in the process class is not correct. Correct is module instead of domain. This will be fixed in the future.
{% endhint %}

Some fields of the process class:

```json
{
    "id": "111-222-333",
    // ...
    "pickJobRefs": [],
    "handoverJobRefs": [],
    // ...
    "status": "CREATED",
    "domsStatus": "CREATED",
    "returnStatus": "NOT_AVAILABLE",
    "operativeStatus": "CREATED",
    "domainStatuses": [
        "PICKING": "CREATED",
        // ...
    ],
    "lastDomainEntityStatuses": [
        {
            "domain": "PICKJOB",
            "status": "CREATED",
            "entityId": "123456789"
        },
        // ...
    ]
    // ...
}
```

{% hint style="info" %}
You'll need to have the `PROCESS_LOG_READ` permission to see the logs.
{% endhint %}

## Process statuses calculation flow

The different status of the process are calculated depending on their predecessors. The start status is the `lastDomainEntityStatuses` (at the left of the image), with this the `domainStatuses` are calculated. `domsStatus` and `operativeStatus` are calculated from the `domainStatuses`. The final overall `status` based on `domsStatus` and `operativeStatus`.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FOiohGG37oKNXiodVVMIb%2FProcess%20status.png?alt=media&amp;token=712e312c-d776-4f88-a186-8171e658b041" alt=""><figcaption></figcaption></figure>

## Description of different status

fulfillmenttools contains different pillars[^1] and modules. Every pillar has multiple modules, and every module includes entities like a `pickJob` in the `PICKING` module or a `routingPlan` in the `ROUTING` module.

For the different Process-Status-Calculation, only the `DOMS` and `LOCAL OPERATIONS` modules are taken into account.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FpFv5EvgEvCbwtU4WswkI%2FDifferent%20status%20diagram.png?alt=media&amp;token=09aeb50e-a887-4cfe-87a4-a2f8e33990e8" alt=""><figcaption></figcaption></figure>

### `lastDomainEntityStatuses`

Contains only the last status of every entity. An entity (for example, `routingPlan`, `pickJob` or `handoverJob`) status change in a module (for example, `PACKING` or `ORDER`), will update the entry of the corresponding entity in this list.

Example JSON:

```json
"lastDomainEntityStatuses": [
    {
        "domain": "ROUTING_PLAN",
        "status": "FINISHED",
        "entityId": "ROUTING-A-0000-1111"
    }, {
        "domain": "ROUTING_PLAN",
        "status": "FINISHED",
        "entityId": "ROUTING-B-0000-1111"
    }, {
        "domain": "PICKJOB",
        "status": "CREATED",
        "entityId": "PICK-A-2222-3333"
    },
    // ...
]
```

Because the noticed status in `lastDomainEntityStatuses` must work with all entities from different modules, these saved status are not the original status that's defined in the module. The original status is mapped into one, which can be used across all modules.

### `domainStatuses`

Contains module clean statuses that will be calculated from the module entities from the `lastDomainEntityStatuses`. For example, we have one status for `PICKING` or `SHIPPING`.

Example JSON:

```json
"domainStatuses": [
    "ORDER": "FINISHED",
    "ROUTING_PLAN": "FINISHED",
    "PICKING": "CREATED",
    // ...
]
```

The status enum type is the same like in `lastDomainEntityStatuses`, `DomainStatus` and can be found in our [REST API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/processes/-processId-).

### `domsStatus`, `operativeStatus`, and `inventoryStatus`

Each of these three statuses contains a clear domain status. For the calculation of these three statuses, the associated module statuses from the `domainStatuses` list are taken.

### `status`

This is the overall `status`, and it will be calculated with the three status `domsStatus`, `operativeStatus` and `inventoryStatus`.

### `returnStatus`

This status tracks the progress of returns associated with this order. As long as no returns are in progress, this status will be `NOT_AVAILABLE`. Contrary to other process status like `domsStatus` or `operativeStatus`, the `returnStatus` doesn't influence the overall status of the process. This is because an order is counted as complete once all its items are shipped. If a return is issued later on, the progress should not be reopened. The process will remain `CLOSED`, only its returns will be `IN_PROGRESS`.

[^1]: There are 5 pillars that make up fulfillmenttools. This was previously known as a domain, so this naming can still be found in the API.


# Process endpoints

## The Process object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Process":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Carrier management domain status with aggregated sub-statuses from modules."},"deletionDate":{"description":"The date that defines when the entities will be or have been deleted.","format":"date-time","type":"string"},"documentRefs":{"description":"References to documents that are attached to this process.","items":{"type":"string"},"type":"array"},"domainStatuses":{"additionalProperties":{"$ref":"#/components/schemas/DomainStatus"},"deprecated":true,"description":"Deprecated. Use moduleStatuses instead. Overview of the different domain adherent status of the process.","type":"object"},"domainStatusHistory":{"deprecated":true,"description":"Deprecated. Use moduleEntityStatusesHistory instead. History of process status changes caused by changes on the related domains.","items":{"$ref":"#/components/schemas/DomainStatusHistoryItem"},"type":"array"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use domsStatuses instead. Overall DOMS status of the process."},"domsStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"DOMS domain status with aggregated sub-statuses from modules."},"externalActionRefs":{"description":"References to the external actions connected to this process (if any).","items":{"type":"string"},"type":"array"},"facilityRefs":{"description":"References of the Facilities connected to this process (if any).","items":{"type":"string"},"type":"array"},"flatRefs":{"description":"This field references all IDs of any entity connected to this process.","items":{"type":"string"},"type":"array"},"gdprCleanupDate":{"description":"The date that defines when the entities will be or have been anonymized.","format":"date-time","type":"string"},"handoverJobRefs":{"description":"References to Handoverjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"id":{"description":"ID of this process","type":"string"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use inventoryStatuses instead. Overall inventory status of the process."},"inventoryStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Inventory domain status with aggregated sub-statuses from modules."},"isAnonymized":{"description":"Indicates if the entities have been anonymized.","type":"boolean"},"itemReturnJobsRef":{"description":"References to the Item Return Job connected to this process (if present).","items":{"type":"string"},"type":"array"},"lastDomainEntityStatuses":{"deprecated":true,"description":"Deprecated. Use lastModuleEntityStatuses instead. The last domain statuses of each domain.","items":{"$ref":"#/components/schemas/LastDomainEntityStatusItem"},"type":"array"},"lastModuleEntityStatuses":{"description":"The last status of each module entity.","items":{"$ref":"#/components/schemas/LastModuleEntityStatusItem"},"type":"array"},"moduleEntityStatusesHistory":{"description":"History of module entity status changes.","items":{"$ref":"#/components/schemas/ModuleEntityStatusHistoryItem"},"type":"array"},"moduleStatuses":{"description":"Status of each module involved in this process.","items":{"$ref":"#/components/schemas/ModuleStatusItem"},"type":"array"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use operativeStatuses instead. Overall operative status of the process."},"operativeStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Operative domain status with aggregated sub-statuses from modules."},"orderRef":{"description":"References to the Order connected to this process (if present).","type":"string"},"packJobRefs":{"description":"References of the Packjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"pickJobRefs":{"description":"References to the Pickjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"progressLogs":{"description":"The progress logs of the process, which are used to track the status changes of the process and its related entities.","items":{"$ref":"#/components/schemas/ProgressLog"},"type":"array"},"returnRefs":{"deprecated":true,"description":"Deprecated. Use itemReturnJobRefs instead. References to the Returns connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"NOT_AVAILABLE","deprecated":true,"description":"Deprecated. Use returnStatuses instead. Overall return status of the process."},"returnStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Return domain status with aggregated sub-statuses from modules."},"routingEngine":{"$ref":"#/components/schemas/RoutingEngineEnum"},"routingPlanRefs":{"description":"References the RoutingPlans that were used during this process (if present).","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"References to the Service Jobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"shipmentRefs":{"description":"References to the Shipments connected to this process (if present).","items":{"type":"string"},"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use statuses.status instead. Overall status of the process."},"statuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Aggregated process status with sub-statuses from all domains."},"tenantOrderId":{"description":"The tenantOrderId referencing this process.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["gdprCleanupDate","id"],"type":"object","title":"Process","description":"Process"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"ProgressLog":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"attributes":{"type":"object"},"domain":{"$ref":"#/components/schemas/DomainType"},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus"},"domainLastModified":{"description":"The last modified date of the related domain entity","format":"date-time","type":"string"},"domainRef":{"type":"string"},"domainStatus":{"type":"string"},"domainVersion":{"description":"The version of the related domain entity","format":"int64","type":"integer"},"facilityRef":{"description":"The id of the facility an entity possibly belongs to.","type":"string"},"id":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"moduleEntityLastModified":{"description":"The last modified date of the related module entity","format":"date-time","type":"string"},"moduleEntityRef":{"type":"string"},"moduleEntityStatus":{"description":"Original status of the related module entity","type":"string"},"moduleEntityStatusForProcess":{"allOf":[{"$ref":"#/components/schemas/ModuleEntityStatus"}],"description":"Module entity's original status mapped to the ModuleEntityStatus for process"},"moduleEntitySubStatuses":{"description":"Sub-statuses reported by the module entity for this progress log entry.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"moduleEntityVersion":{"description":"The version of the related module entity","format":"int64","type":"integer"},"schemaVersion":{"type":"number"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each module can define its own set of reasons, represented as an ENUM","type":"string"}},"required":["id","domainVersion","domainEntityProcessStatus","domain","domainRef","domainStatus"],"title":"ProgressLog","description":"ProgressLog"},"RoutingEngineEnum":{"enum":["ADVANCED_ORDER_ROUTING","STANDARD_ORDER_ROUTING"],"type":"string","title":"RoutingEngineEnum","description":"RoutingEngineEnum"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"}}}}
```

## Call process action

> Update Process by calling an action. This can be used to trigger state transitions or other operations on the process. The ASSIGN\_FACILITY\_TO\_PROCESS action additionally requires PROCESS\_REROUTE.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ProcessActionsParameter":{"oneOf":[{"$ref":"#/components/schemas/AddTagsToProcessActionParameter"},{"$ref":"#/components/schemas/AssignFacilityToProcessActionParameter"},{"$ref":"#/components/schemas/UpdateGdprCleanupDateActionParameter"},{"$ref":"#/components/schemas/UpdateProcessDeletionDateActionParameter"}],"title":"ProcessActionsParameter","description":"ProcessActionsParameter"},"AddTagsToProcessActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to add tags to a process.","properties":{"name":{"enum":["ADD_TAGS_TO_PROCESS"],"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":10,"minItems":1,"type":"array"}},"required":["name","version","tags"],"title":"AddTagsToProcessActionParameter"},"AbstractProcessActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractProcessActionsParameter","description":"AbstractProcessActionsParameter"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"AssignFacilityToProcessActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to assign a facility to a process.","properties":{"facilityRef":{"type":"string"},"name":{"enum":["ASSIGN_FACILITY_TO_PROCESS"],"type":"string"},"rerouteDescriptionId":{"type":"string"}},"required":["name","version","facilityRef"],"title":"AssignFacilityToProcessActionParameter"},"UpdateGdprCleanupDateActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to set the GDPR cleanup date of a process.","properties":{"gdprCleanupDate":{"description":"The date when the process and all connected entities should be cleaned up / anonymized.","format":"date","type":"string"},"name":{"enum":["UPDATE_GDPR_CLEANUP_DATE"],"type":"string"}},"required":["name","version","gdprCleanupDate"],"title":"UpdateGdprCleanupDateActionParameter"},"UpdateProcessDeletionDateActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractProcessActionsParameter"}],"description":"Action to set the deletion date date of a process.","properties":{"deletionDate":{"description":"The date when the process must be deleted.","format":"date","type":"string"},"name":{"enum":["UPDATE_PROCESS_DELETION_DATE"],"type":"string"}},"required":["name","version","deletionDate"],"title":"UpdateProcessDeletionDateActionParameter"},"Process":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Carrier management domain status with aggregated sub-statuses from modules."},"deletionDate":{"description":"The date that defines when the entities will be or have been deleted.","format":"date-time","type":"string"},"documentRefs":{"description":"References to documents that are attached to this process.","items":{"type":"string"},"type":"array"},"domainStatuses":{"additionalProperties":{"$ref":"#/components/schemas/DomainStatus"},"deprecated":true,"description":"Deprecated. Use moduleStatuses instead. Overview of the different domain adherent status of the process.","type":"object"},"domainStatusHistory":{"deprecated":true,"description":"Deprecated. Use moduleEntityStatusesHistory instead. History of process status changes caused by changes on the related domains.","items":{"$ref":"#/components/schemas/DomainStatusHistoryItem"},"type":"array"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use domsStatuses instead. Overall DOMS status of the process."},"domsStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"DOMS domain status with aggregated sub-statuses from modules."},"externalActionRefs":{"description":"References to the external actions connected to this process (if any).","items":{"type":"string"},"type":"array"},"facilityRefs":{"description":"References of the Facilities connected to this process (if any).","items":{"type":"string"},"type":"array"},"flatRefs":{"description":"This field references all IDs of any entity connected to this process.","items":{"type":"string"},"type":"array"},"gdprCleanupDate":{"description":"The date that defines when the entities will be or have been anonymized.","format":"date-time","type":"string"},"handoverJobRefs":{"description":"References to Handoverjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"id":{"description":"ID of this process","type":"string"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use inventoryStatuses instead. Overall inventory status of the process."},"inventoryStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Inventory domain status with aggregated sub-statuses from modules."},"isAnonymized":{"description":"Indicates if the entities have been anonymized.","type":"boolean"},"itemReturnJobsRef":{"description":"References to the Item Return Job connected to this process (if present).","items":{"type":"string"},"type":"array"},"lastDomainEntityStatuses":{"deprecated":true,"description":"Deprecated. Use lastModuleEntityStatuses instead. The last domain statuses of each domain.","items":{"$ref":"#/components/schemas/LastDomainEntityStatusItem"},"type":"array"},"lastModuleEntityStatuses":{"description":"The last status of each module entity.","items":{"$ref":"#/components/schemas/LastModuleEntityStatusItem"},"type":"array"},"moduleEntityStatusesHistory":{"description":"History of module entity status changes.","items":{"$ref":"#/components/schemas/ModuleEntityStatusHistoryItem"},"type":"array"},"moduleStatuses":{"description":"Status of each module involved in this process.","items":{"$ref":"#/components/schemas/ModuleStatusItem"},"type":"array"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use operativeStatuses instead. Overall operative status of the process."},"operativeStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Operative domain status with aggregated sub-statuses from modules."},"orderRef":{"description":"References to the Order connected to this process (if present).","type":"string"},"packJobRefs":{"description":"References of the Packjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"pickJobRefs":{"description":"References to the Pickjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"progressLogs":{"description":"The progress logs of the process, which are used to track the status changes of the process and its related entities.","items":{"$ref":"#/components/schemas/ProgressLog"},"type":"array"},"returnRefs":{"deprecated":true,"description":"Deprecated. Use itemReturnJobRefs instead. References to the Returns connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"NOT_AVAILABLE","deprecated":true,"description":"Deprecated. Use returnStatuses instead. Overall return status of the process."},"returnStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Return domain status with aggregated sub-statuses from modules."},"routingEngine":{"$ref":"#/components/schemas/RoutingEngineEnum"},"routingPlanRefs":{"description":"References the RoutingPlans that were used during this process (if present).","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"References to the Service Jobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"shipmentRefs":{"description":"References to the Shipments connected to this process (if present).","items":{"type":"string"},"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use statuses.status instead. Overall status of the process."},"statuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Aggregated process status with sub-statuses from all domains."},"tenantOrderId":{"description":"The tenantOrderId referencing this process.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["gdprCleanupDate","id"],"type":"object","title":"Process","description":"Process"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"ProgressLog":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"attributes":{"type":"object"},"domain":{"$ref":"#/components/schemas/DomainType"},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus"},"domainLastModified":{"description":"The last modified date of the related domain entity","format":"date-time","type":"string"},"domainRef":{"type":"string"},"domainStatus":{"type":"string"},"domainVersion":{"description":"The version of the related domain entity","format":"int64","type":"integer"},"facilityRef":{"description":"The id of the facility an entity possibly belongs to.","type":"string"},"id":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"moduleEntityLastModified":{"description":"The last modified date of the related module entity","format":"date-time","type":"string"},"moduleEntityRef":{"type":"string"},"moduleEntityStatus":{"description":"Original status of the related module entity","type":"string"},"moduleEntityStatusForProcess":{"allOf":[{"$ref":"#/components/schemas/ModuleEntityStatus"}],"description":"Module entity's original status mapped to the ModuleEntityStatus for process"},"moduleEntitySubStatuses":{"description":"Sub-statuses reported by the module entity for this progress log entry.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"moduleEntityVersion":{"description":"The version of the related module entity","format":"int64","type":"integer"},"schemaVersion":{"type":"number"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each module can define its own set of reasons, represented as an ENUM","type":"string"}},"required":["id","domainVersion","domainEntityProcessStatus","domain","domainRef","domainStatus"],"title":"ProgressLog","description":"ProgressLog"},"RoutingEngineEnum":{"enum":["ADVANCED_ORDER_ROUTING","STANDARD_ORDER_ROUTING"],"type":"string","title":"RoutingEngineEnum","description":"RoutingEngineEnum"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/processes/{processId}/actions":{"post":{"description":"Update Process by calling an action. This can be used to trigger state transitions or other operations on the process. The ASSIGN_FACILITY_TO_PROCESS action additionally requires PROCESS_REROUTE.","operationId":"processAction","parameters":[{"description":"ID of process you want to call the action for","in":"path","name":"processId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessActionsParameter"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Process"}}},"description":"Updated Process in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Process not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Process version conflict"}},"summary":"Call process action","tags":["Processes"]}}}}
```

## Create process reroute

> Reroute a process to a different facility.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Process":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Carrier management domain status with aggregated sub-statuses from modules."},"deletionDate":{"description":"The date that defines when the entities will be or have been deleted.","format":"date-time","type":"string"},"documentRefs":{"description":"References to documents that are attached to this process.","items":{"type":"string"},"type":"array"},"domainStatuses":{"additionalProperties":{"$ref":"#/components/schemas/DomainStatus"},"deprecated":true,"description":"Deprecated. Use moduleStatuses instead. Overview of the different domain adherent status of the process.","type":"object"},"domainStatusHistory":{"deprecated":true,"description":"Deprecated. Use moduleEntityStatusesHistory instead. History of process status changes caused by changes on the related domains.","items":{"$ref":"#/components/schemas/DomainStatusHistoryItem"},"type":"array"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use domsStatuses instead. Overall DOMS status of the process."},"domsStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"DOMS domain status with aggregated sub-statuses from modules."},"externalActionRefs":{"description":"References to the external actions connected to this process (if any).","items":{"type":"string"},"type":"array"},"facilityRefs":{"description":"References of the Facilities connected to this process (if any).","items":{"type":"string"},"type":"array"},"flatRefs":{"description":"This field references all IDs of any entity connected to this process.","items":{"type":"string"},"type":"array"},"gdprCleanupDate":{"description":"The date that defines when the entities will be or have been anonymized.","format":"date-time","type":"string"},"handoverJobRefs":{"description":"References to Handoverjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"id":{"description":"ID of this process","type":"string"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use inventoryStatuses instead. Overall inventory status of the process."},"inventoryStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Inventory domain status with aggregated sub-statuses from modules."},"isAnonymized":{"description":"Indicates if the entities have been anonymized.","type":"boolean"},"itemReturnJobsRef":{"description":"References to the Item Return Job connected to this process (if present).","items":{"type":"string"},"type":"array"},"lastDomainEntityStatuses":{"deprecated":true,"description":"Deprecated. Use lastModuleEntityStatuses instead. The last domain statuses of each domain.","items":{"$ref":"#/components/schemas/LastDomainEntityStatusItem"},"type":"array"},"lastModuleEntityStatuses":{"description":"The last status of each module entity.","items":{"$ref":"#/components/schemas/LastModuleEntityStatusItem"},"type":"array"},"moduleEntityStatusesHistory":{"description":"History of module entity status changes.","items":{"$ref":"#/components/schemas/ModuleEntityStatusHistoryItem"},"type":"array"},"moduleStatuses":{"description":"Status of each module involved in this process.","items":{"$ref":"#/components/schemas/ModuleStatusItem"},"type":"array"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use operativeStatuses instead. Overall operative status of the process."},"operativeStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Operative domain status with aggregated sub-statuses from modules."},"orderRef":{"description":"References to the Order connected to this process (if present).","type":"string"},"packJobRefs":{"description":"References of the Packjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"pickJobRefs":{"description":"References to the Pickjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"progressLogs":{"description":"The progress logs of the process, which are used to track the status changes of the process and its related entities.","items":{"$ref":"#/components/schemas/ProgressLog"},"type":"array"},"returnRefs":{"deprecated":true,"description":"Deprecated. Use itemReturnJobRefs instead. References to the Returns connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"NOT_AVAILABLE","deprecated":true,"description":"Deprecated. Use returnStatuses instead. Overall return status of the process."},"returnStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Return domain status with aggregated sub-statuses from modules."},"routingEngine":{"$ref":"#/components/schemas/RoutingEngineEnum"},"routingPlanRefs":{"description":"References the RoutingPlans that were used during this process (if present).","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"References to the Service Jobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"shipmentRefs":{"description":"References to the Shipments connected to this process (if present).","items":{"type":"string"},"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use statuses.status instead. Overall status of the process."},"statuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Aggregated process status with sub-statuses from all domains."},"tenantOrderId":{"description":"The tenantOrderId referencing this process.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["gdprCleanupDate","id"],"type":"object","title":"Process","description":"Process"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"ProgressLog":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"attributes":{"type":"object"},"domain":{"$ref":"#/components/schemas/DomainType"},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus"},"domainLastModified":{"description":"The last modified date of the related domain entity","format":"date-time","type":"string"},"domainRef":{"type":"string"},"domainStatus":{"type":"string"},"domainVersion":{"description":"The version of the related domain entity","format":"int64","type":"integer"},"facilityRef":{"description":"The id of the facility an entity possibly belongs to.","type":"string"},"id":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"moduleEntityLastModified":{"description":"The last modified date of the related module entity","format":"date-time","type":"string"},"moduleEntityRef":{"type":"string"},"moduleEntityStatus":{"description":"Original status of the related module entity","type":"string"},"moduleEntityStatusForProcess":{"allOf":[{"$ref":"#/components/schemas/ModuleEntityStatus"}],"description":"Module entity's original status mapped to the ModuleEntityStatus for process"},"moduleEntitySubStatuses":{"description":"Sub-statuses reported by the module entity for this progress log entry.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"moduleEntityVersion":{"description":"The version of the related module entity","format":"int64","type":"integer"},"schemaVersion":{"type":"number"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each module can define its own set of reasons, represented as an ENUM","type":"string"}},"required":["id","domainVersion","domainEntityProcessStatus","domain","domainRef","domainStatus"],"title":"ProgressLog","description":"ProgressLog"},"RoutingEngineEnum":{"enum":["ADVANCED_ORDER_ROUTING","STANDARD_ORDER_ROUTING"],"type":"string","title":"RoutingEngineEnum","description":"RoutingEngineEnum"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/processes/{processId}/reroute":{"post":{"description":"Reroute a process to a different facility.","operationId":"rerouteProcess","parameters":[{"description":"ID of process you want to reroute","in":"path","name":"processId","required":true,"schema":{"type":"string"}},{"description":"Version of process you want to reroute","in":"query","name":"version","required":true,"schema":{"type":"number"}},{"description":"The id of the rerouteDescription","in":"query","name":"rerouteDescriptionId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Process"}}},"description":"Process was found the corresponding reroute operations have been triggered."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Process not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Process version conflict"}},"summary":"Create process reroute","tags":["Processes"]}}}}
```

## List processes (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for Process

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ProcessSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/ProcessSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/ProcessSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"ProcessSearchPayload","type":"object","description":"ProcessSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"ProcessSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ProcessSearchQuery"},"maxItems":500,"type":"array"},"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by carrierManagementStatuses"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by created"},"documentRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by documentRefs"},"domainStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesFilter"}],"description":"Nested search by domainStatuses"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by domsStatus"},"externalActionRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by externalActionRefs"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"facilityRefsWithActiveOperations":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRefsWithActiveOperations"},"flatRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by flatRefs"},"handoverJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by handoverJobRefs"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by inventoryStatus"},"itemReturnJobsRef":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by itemReturnJobsRef"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by operativeStatus"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ProcessSearchQuery"},"maxItems":500,"type":"array"},"orderRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by orderRef"},"packJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by packJobRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"processId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by processId"},"referenced":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFilter"}],"description":"Nested search by referenced"},"returnRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by returnRefs"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by returnStatus"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"searchTerm":{"allOf":[{"$ref":"#/components/schemas/SearchFilter"}],"description":"Full-text search for this entity"},"serviceJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by serviceJobRefs"},"shipmentRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by shipmentRefs"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusEnumFilter"}],"description":"Search by status"},"tags":{"allOf":[{"$ref":"#/components/schemas/ProcessTagsListFilter"}],"description":"Nested list search by tags"}},"title":"ProcessSearchQuery","type":"object","description":"ProcessSearchQuery"},"ProcessStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string"}},"title":"ProcessStatusEnumFilter","type":"object","description":"ProcessStatusEnumFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ProcessDomainStatusesFilter":{"properties":{"handover":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by handover"},"order":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by order"},"packing":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by packing"},"picking":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by picking"},"return":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by return"},"routing":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by routing"},"service":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by service"},"shipping":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter"}],"description":"Search by shipping"}},"title":"ProcessDomainStatusesFilter","type":"object","description":"ProcessDomainStatusesFilter"},"ProcessDomainStatusesDomainStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessDomainStatusesDomainStatusEnumFilter"}],"description":"Search by order"}},"title":"ProcessDomainStatusesDomainStatusEnumListFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumListFilter"},"ProcessDomainStatusesDomainStatusEnumFilter":{"properties":{"eq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by order","items":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by order","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessDomainStatusesDomainStatusEnumFilter","type":"object","description":"ProcessDomainStatusesDomainStatusEnumFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"ProcessReferencedFilter":{"properties":{"brand":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedBrandFilter"}],"description":"Nested search by brand"},"carrier":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedCarrierFilter"}],"description":"Nested search by carrier"},"consumerAddress":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedConsumerAddressFilter"}],"description":"Nested search by consumerAddress"},"facility":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFacilityFilter"}],"description":"Nested search by facility"},"handoverJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobFilter"}],"description":"Nested search by handoverJob"},"order":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderFilter"}],"description":"Nested search by order"},"packJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobFilter"}],"description":"Nested search by packJob"},"parcel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelFilter"}],"description":"Nested search by parcel"},"parcelTrackingStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelTrackingStatusEnumListFilter"}],"description":"Search by parcelTrackingStatus"},"pickJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobFilter"}],"description":"Nested search by pickJob"},"returnJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobFilter"}],"description":"Nested search by returnJob"},"routingPlan":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanFilter"}],"description":"Nested search by routingPlan"},"serviceJob":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobFilter"}],"description":"Nested search by serviceJob"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceLevelEnumListFilter"}],"description":"Search by serviceLevel"},"serviceType":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by serviceType"},"shipment":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentFilter"}],"description":"Nested search by shipment"},"sticker":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedStickerFilter"}],"description":"Nested search by sticker"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantArticleId"}},"title":"ProcessReferencedFilter","type":"object","description":"ProcessReferencedFilter"},"ProcessReferencedBrandFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedBrandFilter","type":"object","description":"ProcessReferencedBrandFilter"},"ProcessReferencedCarrierFilter":{"properties":{"carrierTrackingNumber":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by carrierTrackingNumber"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedCarrierFilter","type":"object","description":"ProcessReferencedCarrierFilter"},"ProcessReferencedConsumerAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"},"deliveryCountry":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by deliveryCountry"}},"title":"ProcessReferencedConsumerAddressFilter","type":"object","description":"ProcessReferencedConsumerAddressFilter"},"ProcessReferencedFacilityFilter":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedFacilityAddressFilter"}],"description":"Nested search by address"},"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedFacilityFilter","type":"object","description":"ProcessReferencedFacilityFilter"},"ProcessReferencedFacilityAddressFilter":{"properties":{"country":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by country"}},"title":"ProcessReferencedFacilityAddressFilter","type":"object","description":"ProcessReferencedFacilityAddressFilter"},"ProcessReferencedHandoverJobFilter":{"properties":{"assignedUsers":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobAssignedUsersFilter"}],"description":"Nested search by assignedUsers"},"channel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobChannelEnumListFilter"}],"description":"Search by channel"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"pickupIdentifier":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by pickupIdentifier"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobFilter","type":"object","description":"ProcessReferencedHandoverJobFilter"},"ProcessReferencedHandoverJobAssignedUsersFilter":{"properties":{"userId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by userId"},"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"ProcessReferencedHandoverJobAssignedUsersFilter","type":"object","description":"ProcessReferencedHandoverJobAssignedUsersFilter"},"ProcessReferencedHandoverJobHandoverjobChannelEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobChannelEnumFilter"}],"description":"Search by channel"}},"title":"ProcessReferencedHandoverJobHandoverjobChannelEnumListFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobChannelEnumListFilter"},"ProcessReferencedHandoverJobHandoverjobChannelEnumFilter":{"properties":{"eq":{"description":"Search by channel","enum":["DELIVERY","COLLECT"],"type":"string"},"in":{"description":"Search by channel","items":{"enum":["DELIVERY","COLLECT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by channel","enum":["DELIVERY","COLLECT"],"type":"string"}},"title":"ProcessReferencedHandoverJobHandoverjobChannelEnumFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobChannelEnumFilter"},"ProcessReferencedHandoverJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedHandoverJobGlobalActorFilter","type":"object","description":"ProcessReferencedHandoverJobGlobalActorFilter"},"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter"},"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","HANDED_OVER","OBSOLETE","CANCELED","WAITING_FOR_INPUT"],"type":"string"}},"title":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter","type":"object","description":"ProcessReferencedHandoverJobHandoverjobStatusEnumFilter"},"ProcessReferencedOrderFilter":{"properties":{"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerId"},"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderGlobalActorFilter"}],"description":"Nested search by globalActor"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by orderDate"},"orderedAmount":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by orderedAmount"},"provisioningTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by provisioningTime"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumListFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"}},"title":"ProcessReferencedOrderFilter","type":"object","description":"ProcessReferencedOrderFilter"},"ProcessReferencedOrderGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedOrderGlobalActorFilter","type":"object","description":"ProcessReferencedOrderGlobalActorFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"ProcessReferencedOrderOrderStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedOrderOrderStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedOrderOrderStatusEnumListFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumListFilter"},"ProcessReferencedOrderOrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedOrderOrderStatusEnumFilter","type":"object","description":"ProcessReferencedOrderOrderStatusEnumFilter"},"ProcessReferencedPackJobFilter":{"properties":{"assignedUsers":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobAssignedUsersFilter"}],"description":"Nested search by assignedUsers"},"deliveryChannel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobDeliveryChannelEnumListFilter"}],"description":"Search by deliveryChannel"},"editor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobEditorFilter"}],"description":"Nested search by editor"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobFilter","type":"object","description":"ProcessReferencedPackJobFilter"},"ProcessReferencedPackJobAssignedUsersFilter":{"properties":{"userId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by userId"},"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"ProcessReferencedPackJobAssignedUsersFilter","type":"object","description":"ProcessReferencedPackJobAssignedUsersFilter"},"ProcessReferencedPackJobDeliveryChannelEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobDeliveryChannelEnumFilter"}],"description":"Search by deliveryChannel"}},"title":"ProcessReferencedPackJobDeliveryChannelEnumListFilter","type":"object","description":"ProcessReferencedPackJobDeliveryChannelEnumListFilter"},"ProcessReferencedPackJobDeliveryChannelEnumFilter":{"properties":{"eq":{"description":"Search by deliveryChannel","enum":["COLLECT","SHIPPING"],"type":"string"},"in":{"description":"Search by deliveryChannel","items":{"enum":["COLLECT","SHIPPING"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by deliveryChannel","enum":["COLLECT","SHIPPING"],"type":"string"}},"title":"ProcessReferencedPackJobDeliveryChannelEnumFilter","type":"object","description":"ProcessReferencedPackJobDeliveryChannelEnumFilter"},"ProcessReferencedPackJobEditorFilter":{"properties":{"userId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by userId"},"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"ProcessReferencedPackJobEditorFilter","type":"object","description":"ProcessReferencedPackJobEditorFilter"},"ProcessReferencedPackJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPackJobGlobalActorFilter","type":"object","description":"ProcessReferencedPackJobGlobalActorFilter"},"ProcessReferencedPackJobPackJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPackJobPackJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPackJobPackJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumListFilter"},"ProcessReferencedPackJobPackJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","OBSOLETE","CANCELED","PAUSED"],"type":"string"}},"title":"ProcessReferencedPackJobPackJobStatusEnumFilter","type":"object","description":"ProcessReferencedPackJobPackJobStatusEnumFilter"},"ProcessReferencedParcelFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelFilter","type":"object","description":"ProcessReferencedParcelFilter"},"ProcessReferencedParcelParcelStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelParcelStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedParcelParcelStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumListFilter"},"ProcessReferencedParcelParcelStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","PROCESSING","DONE","FAILED","CANCELED","OBSOLETE","WAITING_FOR_INPUT"],"type":"string"}},"title":"ProcessReferencedParcelParcelStatusEnumFilter","type":"object","description":"ProcessReferencedParcelParcelStatusEnumFilter"},"ProcessReferencedParcelTrackingStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedParcelTrackingStatusEnumFilter"}],"description":"Search by parcelTrackingStatus"}},"title":"ProcessReferencedParcelTrackingStatusEnumListFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumListFilter"},"ProcessReferencedParcelTrackingStatusEnumFilter":{"properties":{"eq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"in":{"description":"Search by parcelTrackingStatus","items":{"enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by parcelTrackingStatus","enum":["REGISTERED","PICKED_UP","DELIVERED","NOT_DELIVERED","TRANSIT","EXCEPTION","OUT_FOR_DELIVERY","DESTROYED","UNKNOWN","CANCELED","AWAITS_PICKUP_BY_RECEIVER","DELAYED","NOTIFICATION"],"type":"string"}},"title":"ProcessReferencedParcelTrackingStatusEnumFilter","type":"object","description":"ProcessReferencedParcelTrackingStatusEnumFilter"},"ProcessReferencedPickJobFilter":{"properties":{"assignedUsers":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobAssignedUsersFilter"}],"description":"Nested search by assignedUsers"},"deliveryInformation":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobDeliveryInformationFilter"}],"description":"Nested search by deliveryInformation"},"editor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobEditorFilter"}],"description":"Nested search by editor"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobFilter","type":"object","description":"ProcessReferencedPickJobFilter"},"ProcessReferencedPickJobAssignedUsersFilter":{"properties":{"userId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by userId"},"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"ProcessReferencedPickJobAssignedUsersFilter","type":"object","description":"ProcessReferencedPickJobAssignedUsersFilter"},"ProcessReferencedPickJobDeliveryInformationFilter":{"properties":{"channel":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobDeliveryInformationPickJobDeliveryInformationChannelEnumListFilter"}],"description":"Search by channel"}},"title":"ProcessReferencedPickJobDeliveryInformationFilter","type":"object","description":"ProcessReferencedPickJobDeliveryInformationFilter"},"ProcessReferencedPickJobDeliveryInformationPickJobDeliveryInformationChannelEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobDeliveryInformationPickJobDeliveryInformationChannelEnumFilter"}],"description":"Search by channel"}},"title":"ProcessReferencedPickJobDeliveryInformationPickJobDeliveryInformationChannelEnumListFilter","type":"object","description":"ProcessReferencedPickJobDeliveryInformationPickJobDeliveryInformationChannelEnumListFilter"},"ProcessReferencedPickJobDeliveryInformationPickJobDeliveryInformationChannelEnumFilter":{"properties":{"eq":{"description":"Search by channel","enum":["COLLECT","SHIPPING"],"type":"string"},"in":{"description":"Search by channel","items":{"enum":["COLLECT","SHIPPING"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by channel","enum":["COLLECT","SHIPPING"],"type":"string"}},"title":"ProcessReferencedPickJobDeliveryInformationPickJobDeliveryInformationChannelEnumFilter","type":"object","description":"ProcessReferencedPickJobDeliveryInformationPickJobDeliveryInformationChannelEnumFilter"},"ProcessReferencedPickJobEditorFilter":{"properties":{"userId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by userId"},"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"ProcessReferencedPickJobEditorFilter","type":"object","description":"ProcessReferencedPickJobEditorFilter"},"ProcessReferencedPickJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedPickJobGlobalActorFilter","type":"object","description":"ProcessReferencedPickJobGlobalActorFilter"},"ProcessReferencedPickJobPickJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedPickJobPickJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedPickJobPickJobStatusEnumListFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumListFilter"},"ProcessReferencedPickJobPickJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ABORTED","OPEN","IN_PROGRESS","CLOSED","PICKED","REROUTED","REJECTED","RESTOWED","EXPIRED","CANCELED","OBSOLETE","WAITING_FOR_INPUT","PAUSED"],"type":"string"}},"title":"ProcessReferencedPickJobPickJobStatusEnumFilter","type":"object","description":"ProcessReferencedPickJobPickJobStatusEnumFilter"},"ProcessReferencedReturnJobFilter":{"properties":{"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"returnFacilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by returnFacilityRefs"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobFilter","type":"object","description":"ProcessReferencedReturnJobFilter"},"ProcessReferencedReturnJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedReturnJobGlobalActorFilter","type":"object","description":"ProcessReferencedReturnJobGlobalActorFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter"},"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELED"],"type":"string"}},"title":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter","type":"object","description":"ProcessReferencedReturnJobItemReturnJobStatusEnumFilter"},"ProcessReferencedRoutingPlanFilter":{"properties":{"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanFilter","type":"object","description":"ProcessReferencedRoutingPlanFilter"},"ProcessReferencedRoutingPlanGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedRoutingPlanGlobalActorFilter","type":"object","description":"ProcessReferencedRoutingPlanGlobalActorFilter"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumListFilter"},"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["IN_PREPARATION","INITIAL","PRIORITIZED","ROUTING","PROPOSED","PLANNED","ROUTED","NOT_ROUTABLE","MANUAL_PLANNED","FAILED","REDUNDANT_REROUTE","FAILED_REROUTE","RETRYABLE","FALLBACK_ROUTING","WAITING","OBSOLETE","CANCELED","LOCKED","PROMISED","REROUTED"],"type":"string"}},"title":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter","type":"object","description":"ProcessReferencedRoutingPlanRoutingPlanStatusEnumFilter"},"ProcessReferencedServiceJobFilter":{"properties":{"assignedUsers":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobAssignedUsersFilter"}],"description":"Nested search by assignedUsers"},"editor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobEditorFilter"}],"description":"Nested search by editor"},"facilityRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by facilityRefs"},"globalActor":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobGlobalActorFilter"}],"description":"Nested search by globalActor"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobFilter","type":"object","description":"ProcessReferencedServiceJobFilter"},"ProcessReferencedServiceJobAssignedUsersFilter":{"properties":{"userId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by userId"},"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"ProcessReferencedServiceJobAssignedUsersFilter","type":"object","description":"ProcessReferencedServiceJobAssignedUsersFilter"},"ProcessReferencedServiceJobEditorFilter":{"properties":{"userId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by userId"},"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"ProcessReferencedServiceJobEditorFilter","type":"object","description":"ProcessReferencedServiceJobEditorFilter"},"ProcessReferencedServiceJobGlobalActorFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by id"}},"title":"ProcessReferencedServiceJobGlobalActorFilter","type":"object","description":"ProcessReferencedServiceJobGlobalActorFilter"},"ProcessReferencedServiceJobServiceJobStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumListFilter"},"ProcessReferencedServiceJobServiceJobStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"}},"title":"ProcessReferencedServiceJobServiceJobStatusEnumFilter","type":"object","description":"ProcessReferencedServiceJobServiceJobStatusEnumFilter"},"ProcessReferencedServiceLevelEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"ProcessReferencedServiceLevelEnumListFilter","type":"object","description":"ProcessReferencedServiceLevelEnumListFilter"},"ProcessReferencedServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"ProcessReferencedServiceLevelEnumFilter","type":"object","description":"ProcessReferencedServiceLevelEnumFilter"},"ProcessReferencedShipmentFilter":{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumListFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentFilter","type":"object","description":"ProcessReferencedShipmentFilter"},"ProcessReferencedShipmentShipmentStatusEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessReferencedShipmentShipmentStatusEnumFilter"}],"description":"Search by status"}},"title":"ProcessReferencedShipmentShipmentStatusEnumListFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumListFilter"},"ProcessReferencedShipmentShipmentStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["INITIAL","REQUEST","RETRYABLE","CONFIRMED","COMPLETED","CANCELED","OBSOLETE"],"type":"string"}},"title":"ProcessReferencedShipmentShipmentStatusEnumFilter","type":"object","description":"ProcessReferencedShipmentShipmentStatusEnumFilter"},"ProcessReferencedStickerFilter":{"properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by name"}},"title":"ProcessReferencedStickerFilter","type":"object","description":"ProcessReferencedStickerFilter"},"SearchFilter":{"properties":{"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"}},"title":"SearchFilter","type":"object","description":"SearchFilter"},"ProcessTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ProcessTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ProcessTagsListFilter","type":"object","description":"ProcessTagsListFilter"},"ProcessTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ProcessTagsFilter","type":"object","description":"ProcessTagsFilter"},"ProcessSort":{"properties":{"activeFacilityCountry":{"enum":["ASC","DESC"],"type":"string"},"activeFacilityName":{"enum":["ASC","DESC"],"type":"string"},"created":{"enum":["ASC","DESC"],"type":"string"},"domsStatus":{"enum":["ASC","DESC"],"type":"string"},"inventoryStatus":{"enum":["ASC","DESC"],"type":"string"},"operativeStatus":{"enum":["ASC","DESC"],"type":"string"},"processId":{"enum":["ASC","DESC"],"type":"string"},"referenced":{"$ref":"#/components/schemas/ProcessReferencedSort"},"returnStatus":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessSort","type":"object","description":"ProcessSort"},"ProcessReferencedSort":{"properties":{"brand":{"$ref":"#/components/schemas/ProcessBrandSort"},"carrier":{"$ref":"#/components/schemas/ProcessCarrierSort"},"consumerAddress":{"$ref":"#/components/schemas/ProcessConsumerAddressSort"},"facility":{"$ref":"#/components/schemas/ProcessFacilitySort"},"order":{"$ref":"#/components/schemas/ProcessOrderSort"},"parcelTrackingStatus":{"enum":["ASC","DESC"],"type":"string"},"sticker":{"$ref":"#/components/schemas/ProcessStickerSort"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessReferencedSort","type":"object","description":"ProcessReferencedSort"},"ProcessBrandSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessBrandSort","type":"object","description":"ProcessBrandSort"},"ProcessCarrierSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessCarrierSort","type":"object","description":"ProcessCarrierSort"},"ProcessConsumerAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"},"postalCode":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessConsumerAddressSort","type":"object","description":"ProcessConsumerAddressSort"},"ProcessFacilitySort":{"properties":{"address":{"$ref":"#/components/schemas/ProcessAddressSort"},"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessFacilitySort","type":"object","description":"ProcessFacilitySort"},"ProcessAddressSort":{"properties":{"country":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessAddressSort","type":"object","description":"ProcessAddressSort"},"ProcessOrderSort":{"properties":{"desiredDeliveryTime":{"enum":["ASC","DESC"],"type":"string"},"orderDate":{"enum":["ASC","DESC"],"type":"string"},"orderedAmount":{"enum":["ASC","DESC"],"type":"string"},"provisioningTime":{"enum":["ASC","DESC"],"type":"string"},"tenantOrderId":{"enum":["ASC","DESC"],"type":"string"},"updateDetails":{"allOf":[{"$ref":"#/components/schemas/ProcessUpdateDetailsSort"}]}},"title":"ProcessOrderSort","type":"object","description":"ProcessOrderSort"},"ProcessUpdateDetailsSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"user":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessUpdateDetailsSort","type":"object","description":"ProcessUpdateDetailsSort"},"ProcessStickerSort":{"properties":{"name":{"enum":["ASC","DESC"],"type":"string"}},"title":"ProcessStickerSort","type":"object","description":"ProcessStickerSort"},"ProcessPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"processes":{"items":{"$ref":"#/components/schemas/Process"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","processes"],"title":"ProcessPaginatedResult","type":"object","description":"ProcessPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Process":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Carrier management domain status with aggregated sub-statuses from modules."},"deletionDate":{"description":"The date that defines when the entities will be or have been deleted.","format":"date-time","type":"string"},"documentRefs":{"description":"References to documents that are attached to this process.","items":{"type":"string"},"type":"array"},"domainStatuses":{"additionalProperties":{"$ref":"#/components/schemas/DomainStatus"},"deprecated":true,"description":"Deprecated. Use moduleStatuses instead. Overview of the different domain adherent status of the process.","type":"object"},"domainStatusHistory":{"deprecated":true,"description":"Deprecated. Use moduleEntityStatusesHistory instead. History of process status changes caused by changes on the related domains.","items":{"$ref":"#/components/schemas/DomainStatusHistoryItem"},"type":"array"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use domsStatuses instead. Overall DOMS status of the process."},"domsStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"DOMS domain status with aggregated sub-statuses from modules."},"externalActionRefs":{"description":"References to the external actions connected to this process (if any).","items":{"type":"string"},"type":"array"},"facilityRefs":{"description":"References of the Facilities connected to this process (if any).","items":{"type":"string"},"type":"array"},"flatRefs":{"description":"This field references all IDs of any entity connected to this process.","items":{"type":"string"},"type":"array"},"gdprCleanupDate":{"description":"The date that defines when the entities will be or have been anonymized.","format":"date-time","type":"string"},"handoverJobRefs":{"description":"References to Handoverjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"id":{"description":"ID of this process","type":"string"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use inventoryStatuses instead. Overall inventory status of the process."},"inventoryStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Inventory domain status with aggregated sub-statuses from modules."},"isAnonymized":{"description":"Indicates if the entities have been anonymized.","type":"boolean"},"itemReturnJobsRef":{"description":"References to the Item Return Job connected to this process (if present).","items":{"type":"string"},"type":"array"},"lastDomainEntityStatuses":{"deprecated":true,"description":"Deprecated. Use lastModuleEntityStatuses instead. The last domain statuses of each domain.","items":{"$ref":"#/components/schemas/LastDomainEntityStatusItem"},"type":"array"},"lastModuleEntityStatuses":{"description":"The last status of each module entity.","items":{"$ref":"#/components/schemas/LastModuleEntityStatusItem"},"type":"array"},"moduleEntityStatusesHistory":{"description":"History of module entity status changes.","items":{"$ref":"#/components/schemas/ModuleEntityStatusHistoryItem"},"type":"array"},"moduleStatuses":{"description":"Status of each module involved in this process.","items":{"$ref":"#/components/schemas/ModuleStatusItem"},"type":"array"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use operativeStatuses instead. Overall operative status of the process."},"operativeStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Operative domain status with aggregated sub-statuses from modules."},"orderRef":{"description":"References to the Order connected to this process (if present).","type":"string"},"packJobRefs":{"description":"References of the Packjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"pickJobRefs":{"description":"References to the Pickjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"progressLogs":{"description":"The progress logs of the process, which are used to track the status changes of the process and its related entities.","items":{"$ref":"#/components/schemas/ProgressLog"},"type":"array"},"returnRefs":{"deprecated":true,"description":"Deprecated. Use itemReturnJobRefs instead. References to the Returns connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"NOT_AVAILABLE","deprecated":true,"description":"Deprecated. Use returnStatuses instead. Overall return status of the process."},"returnStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Return domain status with aggregated sub-statuses from modules."},"routingEngine":{"$ref":"#/components/schemas/RoutingEngineEnum"},"routingPlanRefs":{"description":"References the RoutingPlans that were used during this process (if present).","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"References to the Service Jobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"shipmentRefs":{"description":"References to the Shipments connected to this process (if present).","items":{"type":"string"},"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use statuses.status instead. Overall status of the process."},"statuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Aggregated process status with sub-statuses from all domains."},"tenantOrderId":{"description":"The tenantOrderId referencing this process.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["gdprCleanupDate","id"],"type":"object","title":"Process","description":"Process"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"ProgressLog":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"attributes":{"type":"object"},"domain":{"$ref":"#/components/schemas/DomainType"},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus"},"domainLastModified":{"description":"The last modified date of the related domain entity","format":"date-time","type":"string"},"domainRef":{"type":"string"},"domainStatus":{"type":"string"},"domainVersion":{"description":"The version of the related domain entity","format":"int64","type":"integer"},"facilityRef":{"description":"The id of the facility an entity possibly belongs to.","type":"string"},"id":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"moduleEntityLastModified":{"description":"The last modified date of the related module entity","format":"date-time","type":"string"},"moduleEntityRef":{"type":"string"},"moduleEntityStatus":{"description":"Original status of the related module entity","type":"string"},"moduleEntityStatusForProcess":{"allOf":[{"$ref":"#/components/schemas/ModuleEntityStatus"}],"description":"Module entity's original status mapped to the ModuleEntityStatus for process"},"moduleEntitySubStatuses":{"description":"Sub-statuses reported by the module entity for this progress log entry.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"moduleEntityVersion":{"description":"The version of the related module entity","format":"int64","type":"integer"},"schemaVersion":{"type":"number"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each module can define its own set of reasons, represented as an ENUM","type":"string"}},"required":["id","domainVersion","domainEntityProcessStatus","domain","domainRef","domainStatus"],"title":"ProgressLog","description":"ProgressLog"},"RoutingEngineEnum":{"enum":["ADVANCED_ORDER_ROUTING","STANDARD_ORDER_ROUTING"],"type":"string","title":"RoutingEngineEnum","description":"RoutingEngineEnum"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/processes/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for Process","operationId":"searchProcess","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List processes (search)","tags":["Processes"]}}}}
```

## Get process

> Get a process by query parameters such as order or pickJob reference

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Process":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Carrier management domain status with aggregated sub-statuses from modules."},"deletionDate":{"description":"The date that defines when the entities will be or have been deleted.","format":"date-time","type":"string"},"documentRefs":{"description":"References to documents that are attached to this process.","items":{"type":"string"},"type":"array"},"domainStatuses":{"additionalProperties":{"$ref":"#/components/schemas/DomainStatus"},"deprecated":true,"description":"Deprecated. Use moduleStatuses instead. Overview of the different domain adherent status of the process.","type":"object"},"domainStatusHistory":{"deprecated":true,"description":"Deprecated. Use moduleEntityStatusesHistory instead. History of process status changes caused by changes on the related domains.","items":{"$ref":"#/components/schemas/DomainStatusHistoryItem"},"type":"array"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use domsStatuses instead. Overall DOMS status of the process."},"domsStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"DOMS domain status with aggregated sub-statuses from modules."},"externalActionRefs":{"description":"References to the external actions connected to this process (if any).","items":{"type":"string"},"type":"array"},"facilityRefs":{"description":"References of the Facilities connected to this process (if any).","items":{"type":"string"},"type":"array"},"flatRefs":{"description":"This field references all IDs of any entity connected to this process.","items":{"type":"string"},"type":"array"},"gdprCleanupDate":{"description":"The date that defines when the entities will be or have been anonymized.","format":"date-time","type":"string"},"handoverJobRefs":{"description":"References to Handoverjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"id":{"description":"ID of this process","type":"string"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use inventoryStatuses instead. Overall inventory status of the process."},"inventoryStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Inventory domain status with aggregated sub-statuses from modules."},"isAnonymized":{"description":"Indicates if the entities have been anonymized.","type":"boolean"},"itemReturnJobsRef":{"description":"References to the Item Return Job connected to this process (if present).","items":{"type":"string"},"type":"array"},"lastDomainEntityStatuses":{"deprecated":true,"description":"Deprecated. Use lastModuleEntityStatuses instead. The last domain statuses of each domain.","items":{"$ref":"#/components/schemas/LastDomainEntityStatusItem"},"type":"array"},"lastModuleEntityStatuses":{"description":"The last status of each module entity.","items":{"$ref":"#/components/schemas/LastModuleEntityStatusItem"},"type":"array"},"moduleEntityStatusesHistory":{"description":"History of module entity status changes.","items":{"$ref":"#/components/schemas/ModuleEntityStatusHistoryItem"},"type":"array"},"moduleStatuses":{"description":"Status of each module involved in this process.","items":{"$ref":"#/components/schemas/ModuleStatusItem"},"type":"array"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use operativeStatuses instead. Overall operative status of the process."},"operativeStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Operative domain status with aggregated sub-statuses from modules."},"orderRef":{"description":"References to the Order connected to this process (if present).","type":"string"},"packJobRefs":{"description":"References of the Packjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"pickJobRefs":{"description":"References to the Pickjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"progressLogs":{"description":"The progress logs of the process, which are used to track the status changes of the process and its related entities.","items":{"$ref":"#/components/schemas/ProgressLog"},"type":"array"},"returnRefs":{"deprecated":true,"description":"Deprecated. Use itemReturnJobRefs instead. References to the Returns connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"NOT_AVAILABLE","deprecated":true,"description":"Deprecated. Use returnStatuses instead. Overall return status of the process."},"returnStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Return domain status with aggregated sub-statuses from modules."},"routingEngine":{"$ref":"#/components/schemas/RoutingEngineEnum"},"routingPlanRefs":{"description":"References the RoutingPlans that were used during this process (if present).","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"References to the Service Jobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"shipmentRefs":{"description":"References to the Shipments connected to this process (if present).","items":{"type":"string"},"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use statuses.status instead. Overall status of the process."},"statuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Aggregated process status with sub-statuses from all domains."},"tenantOrderId":{"description":"The tenantOrderId referencing this process.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["gdprCleanupDate","id"],"type":"object","title":"Process","description":"Process"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"ProgressLog":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"attributes":{"type":"object"},"domain":{"$ref":"#/components/schemas/DomainType"},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus"},"domainLastModified":{"description":"The last modified date of the related domain entity","format":"date-time","type":"string"},"domainRef":{"type":"string"},"domainStatus":{"type":"string"},"domainVersion":{"description":"The version of the related domain entity","format":"int64","type":"integer"},"facilityRef":{"description":"The id of the facility an entity possibly belongs to.","type":"string"},"id":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"moduleEntityLastModified":{"description":"The last modified date of the related module entity","format":"date-time","type":"string"},"moduleEntityRef":{"type":"string"},"moduleEntityStatus":{"description":"Original status of the related module entity","type":"string"},"moduleEntityStatusForProcess":{"allOf":[{"$ref":"#/components/schemas/ModuleEntityStatus"}],"description":"Module entity's original status mapped to the ModuleEntityStatus for process"},"moduleEntitySubStatuses":{"description":"Sub-statuses reported by the module entity for this progress log entry.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"moduleEntityVersion":{"description":"The version of the related module entity","format":"int64","type":"integer"},"schemaVersion":{"type":"number"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each module can define its own set of reasons, represented as an ENUM","type":"string"}},"required":["id","domainVersion","domainEntityProcessStatus","domain","domainRef","domainStatus"],"title":"ProgressLog","description":"ProgressLog"},"RoutingEngineEnum":{"enum":["ADVANCED_ORDER_ROUTING","STANDARD_ORDER_ROUTING"],"type":"string","title":"RoutingEngineEnum","description":"RoutingEngineEnum"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/process":{"get":{"description":"Get a process by query parameters such as order or pickJob reference","operationId":"getProcess","parameters":[{"in":"query","name":"tenantOrderId","required":false,"schema":{"type":"string"}},{"in":"query","name":"orderRef","required":false,"schema":{"type":"string"}},{"in":"query","name":"pickJobRef","required":false,"schema":{"type":"string"}},{"in":"query","name":"shipmentRef","required":false,"schema":{"type":"string"}},{"in":"query","name":"handoverJobRef","required":false,"schema":{"type":"string"}},{"in":"query","name":"returnRef","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Process"}}},"description":"Process belonging to the given parameters"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The given parameters are invalid"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get process","tags":["Processes"]}}}}
```

## Get process

> Get a specific process by ID.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Process":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"carrierManagementStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Carrier management domain status with aggregated sub-statuses from modules."},"deletionDate":{"description":"The date that defines when the entities will be or have been deleted.","format":"date-time","type":"string"},"documentRefs":{"description":"References to documents that are attached to this process.","items":{"type":"string"},"type":"array"},"domainStatuses":{"additionalProperties":{"$ref":"#/components/schemas/DomainStatus"},"deprecated":true,"description":"Deprecated. Use moduleStatuses instead. Overview of the different domain adherent status of the process.","type":"object"},"domainStatusHistory":{"deprecated":true,"description":"Deprecated. Use moduleEntityStatusesHistory instead. History of process status changes caused by changes on the related domains.","items":{"$ref":"#/components/schemas/DomainStatusHistoryItem"},"type":"array"},"domsStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use domsStatuses instead. Overall DOMS status of the process."},"domsStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"DOMS domain status with aggregated sub-statuses from modules."},"externalActionRefs":{"description":"References to the external actions connected to this process (if any).","items":{"type":"string"},"type":"array"},"facilityRefs":{"description":"References of the Facilities connected to this process (if any).","items":{"type":"string"},"type":"array"},"flatRefs":{"description":"This field references all IDs of any entity connected to this process.","items":{"type":"string"},"type":"array"},"gdprCleanupDate":{"description":"The date that defines when the entities will be or have been anonymized.","format":"date-time","type":"string"},"handoverJobRefs":{"description":"References to Handoverjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"id":{"description":"ID of this process","type":"string"},"inventoryStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use inventoryStatuses instead. Overall inventory status of the process."},"inventoryStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Inventory domain status with aggregated sub-statuses from modules."},"isAnonymized":{"description":"Indicates if the entities have been anonymized.","type":"boolean"},"itemReturnJobsRef":{"description":"References to the Item Return Job connected to this process (if present).","items":{"type":"string"},"type":"array"},"lastDomainEntityStatuses":{"deprecated":true,"description":"Deprecated. Use lastModuleEntityStatuses instead. The last domain statuses of each domain.","items":{"$ref":"#/components/schemas/LastDomainEntityStatusItem"},"type":"array"},"lastModuleEntityStatuses":{"description":"The last status of each module entity.","items":{"$ref":"#/components/schemas/LastModuleEntityStatusItem"},"type":"array"},"moduleEntityStatusesHistory":{"description":"History of module entity status changes.","items":{"$ref":"#/components/schemas/ModuleEntityStatusHistoryItem"},"type":"array"},"moduleStatuses":{"description":"Status of each module involved in this process.","items":{"$ref":"#/components/schemas/ModuleStatusItem"},"type":"array"},"operativeStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use operativeStatuses instead. Overall operative status of the process."},"operativeStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Operative domain status with aggregated sub-statuses from modules."},"orderRef":{"description":"References to the Order connected to this process (if present).","type":"string"},"packJobRefs":{"description":"References of the Packjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"pickJobRefs":{"description":"References to the Pickjobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"progressLogs":{"description":"The progress logs of the process, which are used to track the status changes of the process and its related entities.","items":{"$ref":"#/components/schemas/ProgressLog"},"type":"array"},"returnRefs":{"deprecated":true,"description":"Deprecated. Use itemReturnJobRefs instead. References to the Returns connected to this process (if present).","items":{"type":"string"},"type":"array"},"returnStatus":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"NOT_AVAILABLE","deprecated":true,"description":"Deprecated. Use returnStatuses instead. Overall return status of the process."},"returnStatuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Return domain status with aggregated sub-statuses from modules."},"routingEngine":{"$ref":"#/components/schemas/RoutingEngineEnum"},"routingPlanRefs":{"description":"References the RoutingPlans that were used during this process (if present).","items":{"type":"string"},"type":"array"},"serviceJobRefs":{"description":"References to the Service Jobs connected to this process (if present).","items":{"type":"string"},"type":"array"},"shipmentRefs":{"description":"References to the Shipments connected to this process (if present).","items":{"type":"string"},"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/ProcessStatus"}],"default":"CREATED","deprecated":true,"description":"Deprecated. Use statuses.status instead. Overall status of the process."},"statuses":{"allOf":[{"$ref":"#/components/schemas/ProcessStatusDetail"}],"description":"Aggregated process status with sub-statuses from all domains."},"tenantOrderId":{"description":"The tenantOrderId referencing this process.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":1,"type":"array"}},"required":["gdprCleanupDate","id"],"type":"object","title":"Process","description":"Process"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ProcessStatusDetail":{"properties":{"status":{"$ref":"#/components/schemas/ProcessStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"subStatusHistory":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["status"],"type":"object","title":"ProcessStatusDetail","description":"ProcessStatusDetail"},"ProcessStatus":{"enum":["CREATED","IN_PROGRESS","FINISHED","CANCELED","ERROR","NOT_AVAILABLE"],"type":"string","title":"ProcessStatus","description":"ProcessStatus"},"ProcessSubStatus":{"enum":["MISMATCH","DELAYED","AT_RISK"],"type":"string","title":"ProcessSubStatus","description":"ProcessSubStatus"},"DomainStatus":{"deprecated":true,"description":"Deprecated. Use ModuleStatus instead.","enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"DomainStatus"},"DomainStatusHistoryItem":{"description":"This item represent a process status change triggered by a specific domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus","description":"The assigned status"},"domainRef":{"description":"The id of the domain entity that caused the status change.","type":"string"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each domain can define its own set of reasons, represented as an ENUM","type":"string"},"timestamp":{"description":"Timestamp of the moment at which the state was notified by the domain.","format":"date-time","type":"string"}},"required":["timestamp","domain","domainEntityProcessStatus","domainRef"],"type":"object","title":"DomainStatusHistoryItem"},"DomainType":{"deprecated":true,"description":"Deprecated. Use ModuleType instead.","enum":["ORDER","ROUTING_PLAN","PICKJOB","PACKJOB","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION"],"type":"string","title":"DomainType"},"LastDomainEntityStatusItem":{"description":"An object holding the last DomainStatus of a given entity and its corresponding domain.","properties":{"domain":{"$ref":"#/components/schemas/DomainType","description":"The domain of the entity that caused the status change."},"entityId":{"description":"The entity id","type":"string"},"status":{"$ref":"#/components/schemas/DomainStatus","description":"The status of the entity."},"subStatuses":{"description":"The current sub-statuses of the entity, persisted to avoid reloading all progress logs on each recalculation.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["domain","status","entityId"],"type":"object","title":"LastDomainEntityStatusItem"},"LastModuleEntityStatusItem":{"properties":{"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"type":"array"}},"required":["moduleEntity","status","entityRef"],"type":"object","title":"LastModuleEntityStatusItem","description":"LastModuleEntityStatusItem"},"ModuleEntity":{"enum":["ORDER","ROUTING_PLAN","PICK_JOB","PACK_JOB","SHIPMENT","HANDOVER_JOB","SERVICE_JOB","ITEM_RETURN_JOB","PARCEL","RESERVATION","PARCEL_INFORMATION","LABEL","TRACKING_INFORMATION"],"type":"string","title":"ModuleEntity","description":"ModuleEntity"},"ModuleEntityStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","CANCELED","OBSOLETE"],"type":"string","title":"ModuleEntityStatus","description":"ModuleEntityStatus"},"ModuleEntityStatusHistoryItem":{"properties":{"created":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"facilityRef":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"status":{"$ref":"#/components/schemas/ModuleEntityStatus"},"subStatus":{"$ref":"#/components/schemas/ProcessSubStatus"}},"required":["moduleEntity","status","entityRef","created"],"type":"object","title":"ModuleEntityStatusHistoryItem","description":"ModuleEntityStatusHistoryItem"},"ModuleStatusItem":{"properties":{"module":{"$ref":"#/components/schemas/ModuleType"},"status":{"$ref":"#/components/schemas/ModuleStatus"},"subStatuses":{"items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"}},"required":["module","status"],"type":"object","title":"ModuleStatusItem","description":"ModuleStatusItem"},"ModuleType":{"enum":["PICKING","ROUTING","PACKING","SHIPMENT","HANDOVER","RETURN","SERVICE_JOB","RESERVATION","ORDER","SHIPPING"],"type":"string","title":"ModuleType","description":"ModuleType"},"ModuleStatus":{"enum":["PENDING","CREATED","IN_PROGRESS","STUCK","FINISHED","INCOMPLETE","CANCELED","OBSOLETE"],"type":"string","title":"ModuleStatus","description":"ModuleStatus"},"ProgressLog":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"attributes":{"type":"object"},"domain":{"$ref":"#/components/schemas/DomainType"},"domainEntityProcessStatus":{"$ref":"#/components/schemas/DomainStatus"},"domainLastModified":{"description":"The last modified date of the related domain entity","format":"date-time","type":"string"},"domainRef":{"type":"string"},"domainStatus":{"type":"string"},"domainVersion":{"description":"The version of the related domain entity","format":"int64","type":"integer"},"facilityRef":{"description":"The id of the facility an entity possibly belongs to.","type":"string"},"id":{"type":"string"},"moduleEntity":{"$ref":"#/components/schemas/ModuleEntity"},"moduleEntityLastModified":{"description":"The last modified date of the related module entity","format":"date-time","type":"string"},"moduleEntityRef":{"type":"string"},"moduleEntityStatus":{"description":"Original status of the related module entity","type":"string"},"moduleEntityStatusForProcess":{"allOf":[{"$ref":"#/components/schemas/ModuleEntityStatus"}],"description":"Module entity's original status mapped to the ModuleEntityStatus for process"},"moduleEntitySubStatuses":{"description":"Sub-statuses reported by the module entity for this progress log entry.","items":{"$ref":"#/components/schemas/ProcessSubStatus"},"nullable":true,"type":"array"},"moduleEntityVersion":{"description":"The version of the related module entity","format":"int64","type":"integer"},"schemaVersion":{"type":"number"},"statusChangeReasonKey":{"description":"This property captures the reason for the entity’s status change. Each module can define its own set of reasons, represented as an ENUM","type":"string"}},"required":["id","domainVersion","domainEntityProcessStatus","domain","domainRef","domainStatus"],"title":"ProgressLog","description":"ProgressLog"},"RoutingEngineEnum":{"enum":["ADVANCED_ORDER_ROUTING","STANDARD_ORDER_ROUTING"],"type":"string","title":"RoutingEngineEnum","description":"RoutingEngineEnum"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/processes/{processId}":{"get":{"description":"Get a specific process by ID.","operationId":"getProcessByID","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Process"}}},"description":"The found process."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get process","tags":["Processes"]}}}}
```

## Get process history logs

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Return all logs for a given process.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ProcessHistoryLogSort":{"description":"Attribute to order a process history log by","enum":["TIMESTAMP_DESC","TIMESTAMP_ASC","INFO_DESC","INFO_ASC","TYPE_ASC","TYPE_DESC","USERNAME_DESC","USERNAME_ASC","FACILITY_NAME_DESC","FACILITY_NAME_ASC"],"type":"string","xml":{"name":"ProcessHistoryLogSort"},"title":"ProcessHistoryLogSort"},"ProcessHistoryLogs":{"properties":{"historyLogs":{"items":{"$ref":"#/components/schemas/ProcessHistoryLog"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"ProcessHistoryLogs","description":"ProcessHistoryLogs"},"ProcessHistoryLog":{"allOf":[{"$ref":"#/components/schemas/ProcessHistoryLogBase"}],"properties":{"eventType":{"$ref":"#/components/schemas/ProcessHistoryEventType"},"payload":{"description":"Payload varies based on eventType","nullable":true,"oneOf":[{"$ref":"#/components/schemas/RerouteLogPayload"},{"$ref":"#/components/schemas/RerouteLogPayloadBase"},{"$ref":"#/components/schemas/OrderCancellationPayload"},{"$ref":"#/components/schemas/OrderModificationPayloadBase"},{"$ref":"#/components/schemas/ConsumerAddressModifiedLogPayload"},{"$ref":"#/components/schemas/OrderModificationPreferredHandlingTimePayload"},{"$ref":"#/components/schemas/StatusReasonsPayload"},{"$ref":"#/components/schemas/OrderLineItemModifiedLogPayload"},{"$ref":"#/components/schemas/OperativeEntityPayloadBase"},{"$ref":"#/components/schemas/ExternalActionHistoryLogPayload"},{"$ref":"#/components/schemas/ParcelLabelCreationFailedPayload"},{"$ref":"#/components/schemas/OperativeEntityPickingDoneIncompletePayload"},{"$ref":"#/components/schemas/ReturnManagementPayloadBase"}],"type":"object"}},"required":["eventType"],"title":"ProcessHistoryLog","description":"ProcessHistoryLog"},"ProcessHistoryLogBase":{"properties":{"domain":{"$ref":"#/components/schemas/ProcessHistoryDomainType"},"domainRef":{"type":"string"},"eventCause":{"type":"string"},"id":{"type":"string"},"status":{"description":"Status can be OrderStatus, PickJobStatus, PackJobStatus, ParcelStatus, HandoverjobStatus, RoutingPlanStatus, ShipmentStatus, ItemReturnJobStatus or null","nullable":true,"type":"string"},"timestamp":{"description":"Timestamp of the moment at which this log entry was created.","format":"date-time","type":"string"},"type":{"description":"Can be ProcessHistoryLogTypeCommon or user-defined action type","type":"string"},"user":{"$ref":"#/components/schemas/ProcessHistoryLogUser"},"version":{"nullable":true,"type":"number"},"info":{"type":"string"}},"required":["id","type","domain","status","domainRef","version","user","timestamp"],"type":"object","title":"ProcessHistoryLogBase","description":"ProcessHistoryLogBase"},"ProcessHistoryDomainType":{"description":"The domain type of the process history entry","enum":["ORDER","ORDER_MODIFICATION","PICKJOB","PACKJOB","SERVICEJOB","PARCEL","HANDOVER","ROUTING_PLAN","EXTERNAL_ACTION","SHIPMENT","ITEM_RETURN"],"type":"string","title":"ProcessHistoryDomainType"},"ProcessHistoryLogUser":{"properties":{"username":{"type":"string"},"userRef":{"type":"string"}},"required":["userRef","username"],"type":"object","title":"ProcessHistoryLogUser","description":"ProcessHistoryLogUser"},"ProcessHistoryEventType":{"description":"Event types for process history","enum":["ORDER_CREATED","LOCKED_ORDER_CREATED","DELIVERY_PROMISE_CREATED","ORDER_CANCELLED","ORDER_FORCE_CANCELLED","ORDER_UNLOCKED","ORDER_CREATED_FROM_PROMISE","ORDER_MANUAL_REROUTE","UNROUTABLE_ITEMS_REROUTE","REROUTE_FAILED","ORDER_MANUAL_FACILITY_ASSIGNMENT","ORDER_TIME_TRIGGERED_REROUTE","ORDER_HAS_UNROUTABLE_ITEMS","ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE","TASK_MANUAL_REROUTE","ORDER_MODIFICATION_REROUTE","PICKING_DONE_INCOMPLETE_REROUTE","CONSUMER_ADDRESS_CHANGED","ORDER_ITEM_AMOUNT_CHANGED","ORDER_ITEM_DELETED","ORDER_ITEM_ADDED","ORDER_PREFERRED_DATE_MODIFIED","OPERATIVE_TASK_CREATED","PICKING_IN_PROGRESS","PICKING_PAUSED","PICKING_DONE","PICKING_DONE_INCOMPLETE","PICKING_ABORTED_NO_ITEMS_PICKED","PICKING_RESET","PICKING_RESTART","PICKING_CANCELLED","PACKING_CREATED","PACKING_IN_PROGRESS","PACKING_DONE","PARCEL_CREATED","PARCEL_LABEL_REQUESTED","PARCEL_LABEL_CREATION_FAILED","HANDOVER_CREATED","HANDOVER_DONE","HANDOVER_DONE_WITH_REFUSED_ITEMS","HANDOVER_CANCELED","SERVICEJOB_CREATED","SERVICEJOB_IN_PROGRESS","SERVICEJOB_DONE","SERVICEJOB_CANCELED","ACTION_TRIGGERED","COMMENT_ADDED","RETURN_ANNOUNCED","RETURN_CANCELED","RETURN_FINISHED","REFUND_TRIGGERED"],"type":"string","title":"ProcessHistoryEventType"},"RerouteLogPayload":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"},"targetFacility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"}},"required":["targetFacility"],"type":"object","title":"RerouteLogPayload","description":"RerouteLogPayload"},"RerouteDescriptionHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"RerouteDescriptionHistoryLog","description":"RerouteDescriptionHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"RerouteLogPayloadBase":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"}},"type":"object","title":"RerouteLogPayloadBase","description":"RerouteLogPayloadBase"},"OrderCancellationPayload":{"properties":{"cancelationReason":{"$ref":"#/components/schemas/CancelationReasonHistoryLog"}},"type":"object","title":"OrderCancellationPayload","description":"OrderCancellationPayload"},"CancelationReasonHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"CancelationReasonHistoryLog","description":"CancelationReasonHistoryLog"},"OrderModificationPayloadBase":{"properties":{"reason":{"type":"string"}},"type":"object","title":"OrderModificationPayloadBase","description":"OrderModificationPayloadBase"},"ConsumerAddressModifiedLogPayload":{"properties":{"changes":{"description":"List of address changes","items":{"$ref":"#/components/schemas/ConsumerAddressModifiedLogEntry"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogPayload","description":"ConsumerAddressModifiedLogPayload"},"ConsumerAddressModifiedLogEntry":{"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"changedFields":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogEntry","description":"ConsumerAddressModifiedLogEntry"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"OrderModificationPreferredHandlingTimePayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"newPreferredHandlingTime":{"description":"Updated preferredHandlingTime value","format":"date-time","nullable":true,"type":"string"},"previousPreferredHandlingTime":{"description":"preferredHandlingTime value before an update","format":"date-time","nullable":true,"type":"string"}},"required":["previousPreferredHandlingTime","newPreferredHandlingTime"],"title":"OrderModificationPreferredHandlingTimePayload","description":"OrderModificationPreferredHandlingTimePayload"},"StatusReasonsPayload":{"properties":{"statusReason":{"allOf":[{"$ref":"#/components/schemas/OrderStatusReasonLog"}],"description":"Reason for the status change","type":"object"}},"type":"object","title":"StatusReasonsPayload","description":"StatusReasonsPayload"},"OrderStatusReasonLog":{"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"type":"object","title":"OrderStatusReasonLog","description":"OrderStatusReasonLog"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderLineItemModifiedLogPayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"articles":{"description":"List of modified articles","items":{"$ref":"#/components/schemas/ArticleHistoryLog"},"type":"array"}},"title":"OrderLineItemModifiedLogPayload","description":"OrderLineItemModifiedLogPayload"},"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ExternalActionHistoryLogPayload":{"properties":{"groups":{"items":{"type":"string"},"type":"array"}},"required":["groups"],"type":"object","title":"ExternalActionHistoryLogPayload","description":"ExternalActionHistoryLogPayload"},"ParcelLabelCreationFailedPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"errorMessage":{"type":"string"}},"required":["errorMessage"],"type":"object","title":"ParcelLabelCreationFailedPayload","description":"ParcelLabelCreationFailedPayload"},"OperativeEntityPickingDoneIncompletePayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"shortPickedItems":{"items":{"$ref":"#/components/schemas/OperativeEntityShortPickedItem"},"type":"array"}},"title":"OperativeEntityPickingDoneIncompletePayload","description":"OperativeEntityPickingDoneIncompletePayload"},"OperativeEntityShortPickedItem":{"properties":{"article":{"$ref":"#/components/schemas/ArticleHistoryLog"},"picked":{"type":"number"},"quantity":{"type":"number"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"}},"required":["article","picked","quantity"],"type":"object","title":"OperativeEntityShortPickedItem","description":"OperativeEntityShortPickedItem"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"ReturnManagementPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"itemReturnJobsRef":{"type":"string"},"shortId":{"type":"string"}},"type":"object","title":"ReturnManagementPayloadBase","description":"ReturnManagementPayloadBase"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/processes/{processId}/historylogs":{"get":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Return all logs for a given process.","operationId":"getProcessHistoryLogs","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string"}},{"description":"A type parameter for filtering history logs","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Reference to the username you want to get the corresponding history logs","in":"query","name":"username","required":false,"schema":{"type":"string"}},{"description":"Reference to the facility name you want to get the corresponding history logs","in":"query","name":"facilityName","required":false,"schema":{"type":"string"}},{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"query process history log orderBy","in":"query","name":"orderBy","required":false,"schema":{"$ref":"#/components/schemas/ProcessHistoryLogSort"}},{"description":"control whether you want to filter consecutive duplicate logs","in":"query","name":"filterConsecutiveDuplicates","required":false,"schema":{"default":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessHistoryLogs"}}},"description":"The process logs which were found in response body"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Get process history logs","tags":["Processes"]}}}}
```

## Create process document

> Add a document to a process.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ExternalDocumentForCreation":{"additionalProperties":false,"properties":{"file":{"$ref":"#/components/schemas/NamedFile"},"priority":{"minimum":0,"type":"number"},"section":{"$ref":"#/components/schemas/Section"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["type","section"],"type":"object","title":"ExternalDocumentForCreation","description":"ExternalDocumentForCreation"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"},"Section":{"enum":["ORDER","PACKJOB","PICKJOB","HANDOVERJOB","PARCEL","PACKING_TARGET_CONTAINER","HANDOVER_CONTAINER"],"type":"string","title":"Section","description":"Section"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"},"ExternalDocument":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"section":{"$ref":"#/components/schemas/Section"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["type","section","id"],"type":"object","title":"ExternalDocument","description":"ExternalDocument"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/processes/{processId}/documents":{"post":{"description":"Add a document to a process.","operationId":"addDocumentToProcess","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDocumentForCreation"}}},"description":"","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDocument"}}},"description":"The document was successfully created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"}},"summary":"Create process document","tags":["Processes"]}}}}
```

## Get process document

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Get document metadata from a process.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ExternalDocument":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"section":{"$ref":"#/components/schemas/Section"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["type","section","id"],"type":"object","title":"ExternalDocument","description":"ExternalDocument"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"Section":{"enum":["ORDER","PACKJOB","PICKJOB","HANDOVERJOB","PARCEL","PACKING_TARGET_CONTAINER","HANDOVER_CONTAINER"],"type":"string","title":"Section","description":"Section"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"}}},"paths":{"/api/processes/{processId}/documents/{documentId}":{"get":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Get document metadata from a process.","operationId":"readDocumentMetaInProcess","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string"}},{"in":"path","name":"documentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDocument"}}},"description":"The document meta information with given id attached to the selected process"}},"summary":"Get process document","tags":["Processes"]}}}}
```

## Update process file

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Update a document file in a process.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ExternalDocumentForUpdate":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"file":{"$ref":"#/components/schemas/NamedFile"}},"required":["file"],"type":"object","title":"ExternalDocumentForUpdate","description":"ExternalDocumentForUpdate"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"NamedFile":{"additionalProperties":false,"properties":{"content":{"description":"File content base64 encoded","type":"string"},"name":{"description":"File name with extension","type":"string"}},"required":["name","content"],"type":"object","xml":{"name":"NamedFile"},"title":"NamedFile","description":"NamedFile"},"ExternalDocument":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"priority":{"minimum":0,"type":"number"},"section":{"$ref":"#/components/schemas/Section"},"type":{"$ref":"#/components/schemas/DocumentType"}},"required":["type","section","id"],"type":"object","title":"ExternalDocument","description":"ExternalDocument"},"Section":{"enum":["ORDER","PACKJOB","PICKJOB","HANDOVERJOB","PARCEL","PACKING_TARGET_CONTAINER","HANDOVER_CONTAINER"],"type":"string","title":"Section","description":"Section"},"DocumentType":{"enum":["PDF","PNG","JPG","GIF","JPEG","XML","JSON","ZPL"],"type":"string","title":"DocumentType","description":"DocumentType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/processes/{processId}/documents/{documentId}/file":{"put":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Update a document file in a process.","operationId":"updateDocumentInProcess","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string"}},{"in":"path","name":"documentId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDocumentForUpdate"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDocument"}}},"description":"The document was successfully updated"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"}},"summary":"Update process file","tags":["Processes"]}}}}
```

## Download process file

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Download a document file from a process.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/api/processes/{processId}/documents/{documentId}/file":{"get":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Download a document file from a process.","operationId":"downloadDocumentInProcess","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string"}},{"in":"path","name":"documentId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"The document with given id attached to the selected process"}},"summary":"Download process file","tags":["Processes"]}}}}
```

## Create retry not routable

> Retry routing for all not-routable processes.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/processes/retrynotroutable":{"post":{"description":"Retry routing for all not-routable processes.","operationId":"triggerRetryNotRoutable","responses":{"204":{"description":"The retry for all not routable proceses has been succesfully triggered"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The retry task can not be triggered due to a conflicting operation"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create retry not routable","tags":["Processes"]}}}}
```

## List operative processes

> Get all operative processes

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to get operative processes.","name":"Operative processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OperativeProcessPaginatedResult":{"properties":{"operativeProcesses":{"items":{"$ref":"#/components/schemas/OperativeProcess"},"type":"array"},"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"total":{"minimum":0,"type":"number"}},"required":["total","pageInfo","operativeProcesses"],"title":"OperativeProcessPaginatedResult","type":"object","description":"OperativeProcessPaginatedResult"},"OperativeProcess":{"properties":{"created":{"description":"The timestamp when the operative process was created.","format":"date-time","type":"string"},"entityChildren":{"description":"Entities involved in this operative process represented as a hierarchical tree structure.","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"facilityRef":{"description":"Reference to the facility this operative process is associated with.","type":"string"},"flatEntityRefs":{"description":"Entities involved in this operative process represented as a flat list of entity references.","items":{"minLength":0,"type":"string"},"type":"array"},"id":{"description":"auto generated unique identifier","type":"string"},"isEditable":{"description":"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.","type":"boolean"},"lastModified":{"description":"The timestamp when the operative process was last modified.","format":"date-time","type":"string"},"processRef":{"description":"Reference to the process this operative process is associated with.","type":"string"},"routingPlanRef":{"description":"Reference to the routing plan this operative process is associated with.","type":"string"},"version":{"description":"The version number of the operative process. This number is incremented each time the operative process is modified.","type":"number"}},"required":["id","version","processRef","facilityRef","flatEntityRefs","entityChildren"],"title":"OperativeProcess","type":"object","description":"OperativeProcess"},"OperativeEntity":{"properties":{"entityChildren":{"description":"Tree structure of entities belonging to this entity","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"entityRef":{"description":"Reference to the full entity","type":"string"},"entityType":{"description":"Type of the entity","enum":["PICK_JOB","PACK_JOB","SHIPMENT","SHIPPING_INFORMATION","HANDOVER_JOB","PARCEL","PARCEL_INFORMATION","SERVICE_JOB","RESTOW_ITEM","ITEM_RETURN_JOB","LINKED_SERVICE_JOBS","PACKING_TARGET_CONTAINER","LOAD_UNIT","SERVICE_CONTAINER","HANDOVER_CONTAINER"],"type":"string"}},"required":["entityRef","entityType"],"title":"OperativeEntity","type":"object","description":"OperativeEntity"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/operativeprocesses":{"get":{"deprecated":false,"description":"Get all operative processes","operationId":"getOperativeProcesses","parameters":[{"description":"facility to filter the results","in":"query","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"entity to start after","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":500,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperativeProcessPaginatedResult"}}},"description":"All operative processes matching the given parameters"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"List operative processes","tags":["Operative processes"]}}}}
```

## Get operative process

> Get the operative processes for a specific id

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to get operative processes.","name":"Operative processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OperativeProcess":{"properties":{"created":{"description":"The timestamp when the operative process was created.","format":"date-time","type":"string"},"entityChildren":{"description":"Entities involved in this operative process represented as a hierarchical tree structure.","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"facilityRef":{"description":"Reference to the facility this operative process is associated with.","type":"string"},"flatEntityRefs":{"description":"Entities involved in this operative process represented as a flat list of entity references.","items":{"minLength":0,"type":"string"},"type":"array"},"id":{"description":"auto generated unique identifier","type":"string"},"isEditable":{"description":"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.","type":"boolean"},"lastModified":{"description":"The timestamp when the operative process was last modified.","format":"date-time","type":"string"},"processRef":{"description":"Reference to the process this operative process is associated with.","type":"string"},"routingPlanRef":{"description":"Reference to the routing plan this operative process is associated with.","type":"string"},"version":{"description":"The version number of the operative process. This number is incremented each time the operative process is modified.","type":"number"}},"required":["id","version","processRef","facilityRef","flatEntityRefs","entityChildren"],"title":"OperativeProcess","type":"object","description":"OperativeProcess"},"OperativeEntity":{"properties":{"entityChildren":{"description":"Tree structure of entities belonging to this entity","items":{"$ref":"#/components/schemas/OperativeEntity","minLength":0},"type":"array"},"entityRef":{"description":"Reference to the full entity","type":"string"},"entityType":{"description":"Type of the entity","enum":["PICK_JOB","PACK_JOB","SHIPMENT","SHIPPING_INFORMATION","HANDOVER_JOB","PARCEL","PARCEL_INFORMATION","SERVICE_JOB","RESTOW_ITEM","ITEM_RETURN_JOB","LINKED_SERVICE_JOBS","PACKING_TARGET_CONTAINER","LOAD_UNIT","SERVICE_CONTAINER","HANDOVER_CONTAINER"],"type":"string"}},"required":["entityRef","entityType"],"title":"OperativeEntity","type":"object","description":"OperativeEntity"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/operativeprocesses/{operativeProcessId}":{"get":{"deprecated":false,"description":"Get the operative processes for a specific id","operationId":"getOperativeProcessById","parameters":[{"in":"path","name":"operativeProcessId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperativeProcess"}}},"description":"Found operativeProcess by given ID"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get operative process","tags":["Operative processes"]}}}}
```


# Tags

In fulfillmenttools, there's the possibility to map individual processes and to customize entities according to special needs. One way to apply specific customization to your processes is through tags.

{% hint style="info" %}
Before using a tag, it must be created via API: [Tag REST API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/tags). If the tag doesn't exist, the request to use it will be rejected.
{% endhint %}

Tags can be attached to several entities at fulfillmenttools, such as orders, order lines, pick jobs, pack jobs, or handover jobs. The usage of tags is indicated by the field `tags`. Usually, tags are added to entities by services that supply data to the platform (external services, middleware, or connectors).

### **Tag inheritance**

Tags are inherited from one entity to another. Multiple tags with the same ID are merged into one tag. This applies to tags on the root level of the entity and the tags on the line item itself. This covers:

* Order inherits tags to pick jobs, pack job, and handover job.
* Listings inherit tags to pick job line items, pack job line items and handover job line items.

### Use cases for tags

* Create [routing rules](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/doms-toolkit)
* Define a picking method
* Define which external documents are offered for printing during picking and packing
* Configure the scanner behavior during [picking](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking)
* Add [sticker](https://docs.fulfillmenttools.com/documentation/getting-started/stickers) to entities

{% hint style="info" %}
For more details about the `tags` endpoint, refer to the [REST API reference](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/tags).
{% endhint %}

## Create tags

{% hint style="info" %}
A tag's `allowedValues` can only be extended. Once a value is added, it can't be removed.
{% endhint %}

To create a tag, send a `POST` request to the `/api/tags` endpoint.

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/tags
```

```json
{
  "id": "channel",
  "allowedValues": [
    "marketplace",
    "webshop"
  ]
}
```

The field `id` must be unique across all tags.

## Get tags

To retrieve all defined tags, send a `GET` request to the `/api/tags` endpoint.

```http
GET https://ocff-{projectId}.api.fulfillmenttools.com/api/tags
```

The response body contains an array of tag objects:

```json
{
    "tags": [
        {
            "id": "channel",
            "allowedValues": [
                "marketplace",
                "webshop"
            ],
            "created": "2020-02-03T08:45:51.525Z",
            "lastModified": "2020-02-03T09:45:51.525Z",
            "version": 1
        }
    ],
    "total": 1
}
```

## Patch tags

Once a tag is created, new values can be added to its `allowedValues` array.

```http
PATCH https://ocff-{projectId}.api.fulfillmenttools.com/api/tags/{tagId}
```

```json
{
    "actions": [
        {
            "action": "AddAllowedValueToTag",
            "allowedValue": "amazon"
        }
    ],
    "version": 1
}
```

A successful request returns an `200 OK` response with the updated tag object in the body:

```json
{
    "id": "channel",
    "allowedValues": [
        "marketplace",
        "webshop",
        "amazon"
    ],
    "version": 3,
    ...
}
```

The value `amazon` can now be used for the `channel` tag.


# Tags endpoints

## The Tag object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Tag":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"xml":{"name":"Tag"},"title":"Tag","description":"Tag"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagForCreation":{"additionalProperties":false,"properties":{"allowedValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"}},"required":["id","allowedValues"],"title":"TagForCreation","description":"TagForCreation"}}}}
```

## POST /api/tags

> Create tag

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read tags.","name":"Tags"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TagForCreation":{"additionalProperties":false,"properties":{"allowedValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"}},"required":["id","allowedValues"],"title":"TagForCreation","description":"TagForCreation"},"Tag":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"xml":{"name":"Tag"},"title":"Tag","description":"Tag"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/tags":{"post":{"description":"","operationId":"addTag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagForCreation"}}},"description":"Tag object","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"The tag was successfully created."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create tag","tags":["Tags"]}}}}
```

## GET /api/tags

> List tags

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read tags.","name":"Tags"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StrippedTags":{"properties":{"total":{"description":"Total number of found entities for this query","type":"integer"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"}},"type":"object","title":"StrippedTags","description":"StrippedTags"},"Tag":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"xml":{"name":"Tag"},"title":"Tag","description":"Tag"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagForCreation":{"additionalProperties":false,"properties":{"allowedValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"}},"required":["id","allowedValues"],"title":"TagForCreation","description":"TagForCreation"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/tags":{"get":{"description":"","operationId":"getTags","parameters":[{"description":"all entities","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrippedTags"}}},"description":"The current list of available tags"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"No more elements available"}},"summary":"List tags","tags":["Tags"]}}}}
```

## GET /api/tags/{tagRef}

> Get tag

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read tags.","name":"Tags"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Tag":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"xml":{"name":"Tag"},"title":"Tag","description":"Tag"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagForCreation":{"additionalProperties":false,"properties":{"allowedValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"}},"required":["id","allowedValues"],"title":"TagForCreation","description":"TagForCreation"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/tags/{tagRef}":{"get":{"description":"","operationId":"getTag","parameters":[{"description":"Id of the tag you want to get","in":"path","name":"tagRef","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"Tag was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"User not found"}},"summary":"Get tag","tags":["Tags"]}}}}
```

## PATCH /api/tags/{tagRef}

> Update tag

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read tags.","name":"Tags"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TagPatchActions":{"properties":{"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/AddAllowedValueToTag"}]},"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","actions"],"type":"object","xml":{"name":"TagPatchActions"},"title":"TagPatchActions","description":"TagPatchActions"},"AddAllowedValueToTag":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'AddAllowedValueToTag', because you want to add an allowed value to a tag","enum":["AddAllowedValueToTag"],"type":"string"},"allowedValue":{"type":"string"}},"required":["action","allowedValue"],"type":"object"}],"description":"Action to add allowed values to a tag","title":"AddAllowedValueToTag","xml":{"name":"AddAllowedValueToTag"}},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"Tag":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagForCreation"}],"properties":{"id":{"type":"string"}},"required":["id"],"xml":{"name":"Tag"},"title":"Tag","description":"Tag"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagForCreation":{"additionalProperties":false,"properties":{"allowedValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"id":{"type":"string"}},"required":["id","allowedValues"],"title":"TagForCreation","description":"TagForCreation"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/tags/{tagRef}":{"patch":{"description":"","operationId":"putTag","parameters":[{"description":"Id of the tag you want to update","in":"path","name":"tagRef","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagPatchActions"}}},"description":"Tag patch action","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"Tag was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Tag not found"}},"summary":"Update tag","tags":["Tags"]}}}}
```


# Tag configurations endpoints

## Update order tag configuration

> Update the order tag configuration.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to define and manage configuration settings related to order processing, such as defaults, business rules, and operational parameters that influence how orders are handled.","name":"Orders configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}},"title":"OrderTagConfiguration","description":"OrderTagConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/tags/order":{"put":{"description":"Update the order tag configuration.","operationId":"putOrderTagConfigurations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderTagConfiguration"}}},"description":"Desired Tag Configuration for orders","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderTagConfiguration"}}},"description":"The order tag configuration was successfully updated."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Update order tag configuration","tags":["Orders configuration"]}}}}
```

## Get order tag configuration

> Get the order tag configuration.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to define and manage configuration settings related to order processing, such as defaults, business rules, and operational parameters that influence how orders are handled.","name":"Orders configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}},"title":"OrderTagConfiguration","description":"OrderTagConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/tags/order":{"get":{"description":"Get the order tag configuration.","operationId":"getOrderTagConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderTagConfiguration"}}},"description":"Order tag config is in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get order tag configuration","tags":["Orders configuration"]}}}}
```

## PUT /api/configurations/tags/pickjob

> Update pick job tag config

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read pick jobs.","name":"Picking configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PickJobTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"lineItemScanningConfiguration":{"$ref":"#/components/schemas/TagScanningConfiguration"},"lineItemStickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"},"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"type":"array"},"preferredPickingMethodsConfiguration":{"$ref":"#/components/schemas/PreferredPickingMethodsConfiguration"},"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"PickJobTagConfiguration","description":"PickJobTagConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagScanningConfiguration":{"additionalProperties":false,"properties":{"offeredScanningRuleByTag":{"items":{"$ref":"#/components/schemas/OfferedScanningRuleByTag"},"type":"array"}},"title":"TagScanningConfiguration","description":"TagScanningConfiguration"},"OfferedScanningRuleByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"scanningType":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"tagRef":{"minLength":1,"type":"string"}},"required":["tagRef","matchingValues","scanningType"],"type":"object","title":"OfferedScanningRuleByTag","description":"OfferedScanningRuleByTag"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"PreferredPickingMethodsConfiguration":{"properties":{"PreferredPickingMethodsPerTag":{"items":{"$ref":"#/components/schemas/PreferredPickingMethodsPerTag"},"type":"array"}},"title":"PreferredPickingMethodsConfiguration","description":"PreferredPickingMethodsConfiguration"},"PreferredPickingMethodsPerTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"pickingMethods":{"items":{"$ref":"#/components/schemas/PickingMethodEnum"},"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","pickingMethods","matchingValues"],"title":"PreferredPickingMethodsPerTag","description":"PreferredPickingMethodsPerTag"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/tags/pickjob":{"put":{"description":"","operationId":"putPickJobTagConfigurations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickJobTagConfiguration"}}},"description":"Desired Tag Configuration for Pickjobs","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickJobTagConfiguration"}}},"description":"The packing configuration was successfully updated."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Update pick job tag config","tags":["Picking configuration"]}}}}
```

## PUT /api/configurations/tags/handoverjob

> Update handover jobs tag config

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read handover configuration.","name":"Handovers configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"HandoverJobTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}},"title":"HandoverJobTagConfiguration","description":"HandoverJobTagConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/tags/handoverjob":{"put":{"description":"","operationId":"putHandoverTagConfigurations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverJobTagConfiguration"}}},"description":"Desired Tag Configuration for HandoverJobs","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverJobTagConfiguration"}}},"description":"The handoverjob tag configuration was successfully updated."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Update handover jobs tag config","tags":["Handovers configuration"]}}}}
```

## Get parcel tag config

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Returns the tag configuration for parcels

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read shipping configuration.","name":"Shipments configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ParcelTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"alternativeReturnAddressConfiguration":{"$ref":"#/components/schemas/AlternativeReturnAddressConfiguration"}},"required":["alternativeReturnAddressConfiguration"],"type":"object","title":"ParcelTagConfiguration","description":"ParcelTagConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"AlternativeReturnAddressConfiguration":{"additionalProperties":false,"properties":{"alternativeReturnAddressPerTag":{"items":{"$ref":"#/components/schemas/AlternativeReturnAddressPerTag"},"minItems":0,"type":"array"}},"required":["alternativeReturnAddressPerTag"],"type":"object","title":"AlternativeReturnAddressConfiguration","description":"AlternativeReturnAddressConfiguration"},"AlternativeReturnAddressPerTag":{"additionalProperties":false,"properties":{"alternativeReturnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"tagRef":{"description":"needs to be an existing tag id","type":"string"}},"required":["tagRef","matchingValues","alternativeReturnAddress"],"type":"object","title":"AlternativeReturnAddressPerTag","description":"AlternativeReturnAddressPerTag"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/tags/parcel":{"get":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Returns the tag configuration for parcels","operationId":"getParcelTagConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelTagConfiguration"}}},"description":"tag config is in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get parcel tag config","tags":["Shipments configuration"]}}}}
```

## Update parcel tag config

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Updates the tag configuration for parcels.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read shipping configuration.","name":"Shipments configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ParcelTagConfigurationForUpsert":{"allOf":[{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"alternativeReturnAddressConfiguration":{"$ref":"#/components/schemas/AlternativeReturnAddressConfiguration"},"version":{"type":"number"}},"required":["alternativeReturnAddressConfiguration"],"type":"object","title":"ParcelTagConfigurationForUpsert","description":"ParcelTagConfigurationForUpsert"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"AlternativeReturnAddressConfiguration":{"additionalProperties":false,"properties":{"alternativeReturnAddressPerTag":{"items":{"$ref":"#/components/schemas/AlternativeReturnAddressPerTag"},"minItems":0,"type":"array"}},"required":["alternativeReturnAddressPerTag"],"type":"object","title":"AlternativeReturnAddressConfiguration","description":"AlternativeReturnAddressConfiguration"},"AlternativeReturnAddressPerTag":{"additionalProperties":false,"properties":{"alternativeReturnAddress":{"$ref":"#/components/schemas/FacilityAddress"},"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"tagRef":{"description":"needs to be an existing tag id","type":"string"}},"required":["tagRef","matchingValues","alternativeReturnAddress"],"type":"object","title":"AlternativeReturnAddressPerTag","description":"AlternativeReturnAddressPerTag"},"FacilityAddress":{"allOf":[{"$ref":"#/components/schemas/FacilityAddressForCreation"},{"properties":{"resolvedTimeZone":{"$ref":"#/components/schemas/TimeZone"}},"type":"object"}],"type":"object","xml":{"name":"FacilityAddress"},"title":"FacilityAddress","description":"FacilityAddress"},"FacilityAddressForCreation":{"allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"companyName":{"type":"string"},"emailAddresses":{"items":{"properties":{"recipient":{"description":"Human readable information who is the recipient for emails sent to this address.","type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"},"maxItems":10,"type":"array"},"resolvedCoordinates":{"$ref":"#/components/schemas/Coordinates"},"resolvedTimeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZoneForCreation"}],"description":"User-specified time zone in identifier format (e.g., \"America/Los_Angeles\"). Used to determine local time. Relevant only if the country spans multiple time zones; otherwise, the time zone is automatically determined from the country or via Google if unspecified."}},"required":["companyName"],"type":"object"}],"type":"object","xml":{"name":"FacilityAddressForCreation"},"title":"FacilityAddressForCreation","description":"FacilityAddressForCreation"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"TimeZoneForCreation":{"description":"Self-provided timezone for determining the local time of a facility","properties":{"timeZoneId":{"description":"official id of the timezone","type":"string"}},"required":["timeZoneId"],"type":"object","title":"TimeZoneForCreation"},"TimeZone":{"description":"Timezone for information retrieved e.g. by the Google Maps API","properties":{"offsetInSeconds":{"description":"offset in seconds to standard time. Does not account for daylight saving time.","type":"number"},"source":{"description":"source of the timezone information","type":"string"},"timeZoneId":{"description":"official id of the timezone","type":"string"},"timeZoneName":{"description":"descriptive name of the timezone","type":"string"}},"required":["timeZoneId","timeZoneName","offsetInSeconds"],"type":"object","title":"TimeZone"},"ParcelTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"alternativeReturnAddressConfiguration":{"$ref":"#/components/schemas/AlternativeReturnAddressConfiguration"}},"required":["alternativeReturnAddressConfiguration"],"type":"object","title":"ParcelTagConfiguration","description":"ParcelTagConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/tags/parcel":{"put":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Updates the tag configuration for parcels.","operationId":"putParcelTagConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelTagConfigurationForUpsert"}}},"description":"Desired Tag Configuration for Parcels","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelTagConfiguration"}}},"description":"The tag configuration was successfully updated."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Update parcel tag config","tags":["Shipments configuration"]}}}}
```

## GET /api/configurations/tags/packjob

> Get pack jobs tag config

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read packing configuration.","name":"Packing configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackJobTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/TagConfiguration"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"lineItemStickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"},"packJobCreationPerTag":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: This field will be removed in a future release. There is currently no replacement. All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/PackJobCreationPerTag"},"type":"array"},"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}}}],"required":["version"],"type":"object","title":"PackJobTagConfiguration","description":"PackJobTagConfiguration"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PackJobCreationPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"type":"array"},"packJobCreationDisabled":{"type":"boolean"},"tagRef":{"type":"string"}},"required":["packJobCreationDisabled","matchingValues","tagRef"],"type":"object","title":"PackJobCreationPerTag","description":"PackJobCreationPerTag"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/tags/packjob":{"get":{"description":"","operationId":"getPackJobTagConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobTagConfiguration"}}},"description":"Packjob tag config is in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get pack jobs tag config","tags":["Packing configuration"]}}}}
```

## PUT /api/configurations/tags/packjob

> Update pack jobs tag config

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read packing configuration.","name":"Packing configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PackJobTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/TagConfiguration"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"lineItemStickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"},"packJobCreationPerTag":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Deprecated: This field will be removed in a future release. There is currently no replacement. All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/PackJobCreationPerTag"},"type":"array"},"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}}}],"required":["version"],"type":"object","title":"PackJobTagConfiguration","description":"PackJobTagConfiguration"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"PackJobCreationPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"type":"array"},"packJobCreationDisabled":{"type":"boolean"},"tagRef":{"type":"string"}},"required":["packJobCreationDisabled","matchingValues","tagRef"],"type":"object","title":"PackJobCreationPerTag","description":"PackJobCreationPerTag"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/tags/packjob":{"put":{"description":"","operationId":"putPackJobTagConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobTagConfiguration"}}},"description":"Desired PackJobTagConfiguration","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackJobTagConfiguration"}}},"description":"The packing configuration was successfully updated."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Update pack jobs tag config","tags":["Packing configuration"]}}}}
```

## GET /api/configurations/tags/pickjob

> Get pick job tag config

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read pick jobs.","name":"Picking configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PickJobTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"lineItemScanningConfiguration":{"$ref":"#/components/schemas/TagScanningConfiguration"},"lineItemStickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"},"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"type":"array"},"preferredPickingMethodsConfiguration":{"$ref":"#/components/schemas/PreferredPickingMethodsConfiguration"},"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"PickJobTagConfiguration","description":"PickJobTagConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagScanningConfiguration":{"additionalProperties":false,"properties":{"offeredScanningRuleByTag":{"items":{"$ref":"#/components/schemas/OfferedScanningRuleByTag"},"type":"array"}},"title":"TagScanningConfiguration","description":"TagScanningConfiguration"},"OfferedScanningRuleByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"scanningType":{"$ref":"#/components/schemas/PickingScanningConfigurationEnum"},"tagRef":{"minLength":1,"type":"string"}},"required":["tagRef","matchingValues","scanningType"],"type":"object","title":"OfferedScanningRuleByTag","description":"OfferedScanningRuleByTag"},"PickingScanningConfigurationEnum":{"description":"Way in which the scanning of articles during picking is enforced","enum":["MUST_SCAN_FIRST","MUST_SCAN_EACH","SCAN_NOT_REQUIRED"],"type":"string","title":"PickingScanningConfigurationEnum"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"PreferredPickingMethodsConfiguration":{"properties":{"PreferredPickingMethodsPerTag":{"items":{"$ref":"#/components/schemas/PreferredPickingMethodsPerTag"},"type":"array"}},"title":"PreferredPickingMethodsConfiguration","description":"PreferredPickingMethodsConfiguration"},"PreferredPickingMethodsPerTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"minItems":1,"type":"array"},"pickingMethods":{"items":{"$ref":"#/components/schemas/PickingMethodEnum"},"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","pickingMethods","matchingValues"],"title":"PreferredPickingMethodsPerTag","description":"PreferredPickingMethodsPerTag"},"PickingMethodEnum":{"description":"Way in which the picking should be handled Deprecated: BATCH_PICKING, use BATCH instead","enum":["SINGLE_ORDER","MULTI_ORDER","BATCH_PICKING","BATCH"],"type":"string","title":"PickingMethodEnum"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/tags/pickjob":{"get":{"description":"","operationId":"getPickJobTagConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickJobTagConfiguration"}}},"description":"pickjob tag config is in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get pick job tag config","tags":["Picking configuration"]}}}}
```

## GET /api/configurations/tags/handoverjob

> Get handover jobs tag config

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read handover configuration.","name":"Handovers configuration"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"HandoverJobTagConfiguration":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"$ref":"#/components/schemas/TagConfiguration"}],"properties":{"stickerConfiguration":{"$ref":"#/components/schemas/StickerConfiguration"}},"title":"HandoverJobTagConfiguration","description":"HandoverJobTagConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"TagConfiguration":{"properties":{"offeredDocumentsByDefault":{"description":"This configuration is a fallback and applies only if none of the entries in offeredDocumentsPerTag can be applied","items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"offeredDocumentsPerTag":{"description":"All entries with a match in their matchingValues will be combined when determining what documents belong to an entity","items":{"$ref":"#/components/schemas/OfferedDocumentPerTag"},"maxItems":500,"type":"array"}},"required":["offeredDocumentsPerTag","offeredDocumentsByDefault"],"title":"TagConfiguration","description":"TagConfiguration"},"OfferedDocument":{"properties":{"documentCategory":{"$ref":"#/components/schemas/DocumentCategory"}},"required":["documentCategory"],"type":"object","title":"OfferedDocument","description":"OfferedDocument"},"DocumentCategory":{"enum":["EXTERNAL","DELIVERYNOTE","RETURNNOTE","SENDLABEL","RETURNLABEL","TRANSFERLABEL","PICKUPIDENTIFIER","CUSTOMS","SIGNATURE_DRAFT","SIGNATURE_SIGNED","IDENTIFIERDOCUMENT"],"type":"string","title":"DocumentCategory","description":"DocumentCategory"},"OfferedDocumentPerTag":{"properties":{"matchingValues":{"items":{"minItems":1,"type":"string"},"maxItems":500,"type":"array"},"offeredDocuments":{"items":{"$ref":"#/components/schemas/OfferedDocument"},"maxItems":500,"type":"array"},"tagRef":{"type":"string"}},"required":["offeredDocuments","matchingValues","tagRef"],"type":"object","title":"OfferedDocumentPerTag","description":"OfferedDocumentPerTag"},"StickerConfiguration":{"additionalProperties":false,"properties":{"offeredStickersByTag":{"items":{"$ref":"#/components/schemas/OfferedStickersByTag"},"maxItems":500,"type":"array"}},"title":"StickerConfiguration","description":"StickerConfiguration"},"OfferedStickersByTag":{"additionalProperties":false,"properties":{"matchingValues":{"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":500,"minItems":1,"type":"array"},"tagRef":{"type":"string"}},"required":["tagRef","matchingValues","stickers"],"type":"object","title":"OfferedStickersByTag","description":"OfferedStickersByTag"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/tags/handoverjob":{"get":{"description":"","operationId":"getHandoverJobTagConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandoverJobTagConfiguration"}}},"description":"handoverJob tag config is in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get handover jobs tag config","tags":["Handovers configuration"]}}}}
```


# Stickers

Stickers can be added to various entities. They can show information that is helpful during order processing or for display in Backoffice and mobile applications. They also include language localization features to facilitate understanding for human users.

Different from [tags](https://docs.fulfillmenttools.com/documentation/getting-started/tags), stickers don't have to be known to fulfillmenttools before being used.

{% hint style="warning" %}
Stickers aren't used to make business decisions, they only have an informative character. If connectors should make decisions based on a value, use tags instead.
{% endhint %}

## Working with stickers

Stickers can be added on entities via their respective API, or can automatically be added if configured in tags. That means if the entity has a tag at creation, the sticker for this tag will be added automatically. Entities with such a tag-sticker configuration are:

* Order: [REST API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/configurations/tags/order)
* Pick job: [REST API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/tags/pickjob)
* Pack job: [REST API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/tags/packjob)
* Handover job: [REST API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/tags/handoverjob)

Stickers are not inherited from one entity to another.

A sticker is a visual indicator that can be attached to entities within fulfillmenttools to highlight important information. For example, a sticker can signal that an order is a high-priority shipment or requires special handling.

There are two primary methods for applying stickers to entities.

## Adding stickers at entity creation

To add stickers directly to an entity at creation, include the `stickers` array in the request payload.

The following example demonstrates how to add a sticker during the creation of an `order`.

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/orders
```

```json
{
    "tenantOrderId": "A-57636-274",
    "orderLineItems": [
        ...
    ],
    "stickers": [
        {
            "key": "information",
            "priority": 100,
            "nameLocalized": {
                "de_DE": "Wichtig",
                "en_US": "Important"
            }
        }
    ],
    ...
}
```

## Adding stickers via tags

Stickers can also be applied automatically based on an entity's tags. This functionality requires defining a `tag-sticker-configuration` for the relevant entity type.

These configurations are managed using the API. A `tag-sticker-configuration` can be defined for the following entities:

* [Order tag-sticker configuration](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/configurations/tags/order)
* [Pick job tag-sticker configuration](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/tags/pickjob)
* [Pack job tag-sticker configuration](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/tags/packjob)
* [Handover job tag-sticker configuration](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/tags/handoverjob)

## Show stickers to clients

There are two methods to display a sticker in fulfillmenttools clients, such as the network order overview in Backoffice.

{% hint style="info" %}
Both options can be used together.
{% endhint %}

## Directly assigning stickers during order creation

The first method involves attaching a `sticker` directly to an `order` payload during its creation. When fulfillmenttools processes this `order`, the `sticker` is displayed in client applications like Backoffice. This also enables filtering orders based on assigned stickers.

An example `order` payload with a `sticker` is shown below.

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/orders
```

```json
{
  "tenantOrderId": "4711",
  ...
  "stickers": [
    {
      "key": "customercategory",
      "priority": 100,
      "nameLocalized": {
        "de_DE": "A-Kunde",
        "en_US": "A-Customer"
      },
      "color": "#19b6b5"
    }
  ],
  ...
}
```

## Automatically assigning stickers via tags

The second method is to attach a `tag` to an `order` and create a configuration that automatically assigns a `sticker` when the `order` enters the system. This configuration-based approach can also be used to assign stickers to other entities.

This example assumes a `tag` is already configured in the system:

```http
GET https://ocff-{projectId}.api.fulfillmenttools.com/api/tags
```

```json
{
    "id": "Channel",
    "allowedValues": [
        "B2B",
        "B2C"
    ],
    "created": "2023-04-03T09:28:59.336Z",
    "lastModified": "2023-04-03T09:28:59.336Z",
    "version": 1
}
```

Next, a configuration is created to map specific `tag` values to `stickers` for the `order` entity. The following example demonstrates this configuration:

```http
PUT https://ocff-{projectId}.api.fulfillmenttools.com/api/configurations/tags/order
```

```json
{
    "version": 1,
    "stickerConfiguration": {
      "offeredStickersByTag": [
        {
          "tagRef": "Channel",
          "matchingValues": [
            "B2B"
          ],
          "stickers": [
            {
              "key": "CustomerType",
              "priority": 100,
              "nameLocalized": {
                "de_DE": "Firmenkunde",
                "en_US": "Business Customer"
              },
              "name": "Firmenkunde",
              "color": "#9919b6"
            }
          ]
        }
      ]
    },
  "offeredDocumentsPerTag": [
     {
        "tagRef": "DOCUMENT-TAG-ID",
        "matchingValues": [
            "CUSTOM-INFO"
        ],
        "offeredDocuments": [
            {
                "documentCategory": "CUSTOMS"
            }
        ]
      }
    ],
    "offeredDocumentsByDefault": [
        {
            "documentCategory": "EXTERNAL"
        } 
  ]
}
```

With this configuration in place, new orders created with the `Channel` `tagRef` will automatically have the corresponding `CustomerType` `sticker` assigned:

```http
POST https://ocff-{projectId}.api.fulfillmenttools.com/api/orders
```

```json
{
    "tenantOrderId": "4711",
    ...
    "tags": [
        {
            "id": "Channel",
            "value": "B2B"
        }
    ],
    ...
}
```


# Recordable attributes

Recordable attributes enable the addition of specific information to line items during operational processes. They are inherited when creating subsequent entities within fulfillmenttools.

If a line item of a pick job has a recordable attribute, it's inherited by the corresponding pack job and, under certain circumstances, handover job line items. Handover job line items can also inherit recordable attributes from parcel line items.

Recordable attributes can be added when an order is created for inheritance by all subsequent line items, or they can be defined on listings for inheritance.

{% hint style="info" %}
While article attributes are non-editable after creation, recordable attributes add a value or an entire object to the line item during the corresponding operative process. For more information, see [article attributes](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes).
{% endhint %}

## Recordable attribute example

In the example below, we'll add a recordable attribute to a pick job.

We need to use the create pick job endpoint:

```http
POST https://ocff-{PROJECT_ID}.fulfillmenttools.com/api/pickjobs
```

Then, within the `pickLineItems` array, we can add the `recordableAttributes` object.

```json
...
{
    "pickLineItems": {
        "recordableAttributes": {
            "keyLocalized": {
                "de_DE": "Herkunftsland",
                "en_US": "Country of Origin"
            },    
            "value": "Korea, Republic of",
            "group": "general",
            "recordingRule": "MANDATORY"           
        }
    }
...
}
```

The `value` field contains the data that can be added or modified during different operative processes.


# Custom attributes

Custom attributes can be added to all editable fulfillmenttools entities.

You can store any relevant data for the entity you want (within reason) if our current properties don't fit your needs.

There's no schema to follow, and there's no validation from our side. You're free to work with the data as you wish, as long as you follow the [limitations section](#custom-attribute-inheritance).

Some entities display the custom attributes in Backoffice, such as the [Network order details view](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/order-details-view#custom-attributes), but others are only accessible via API.

Example use cases for custom attributes include storing a consumer rating for a shop, specifying a consumer segment, indicating how to access a facility, or defining a foreign key that relates to data in a connected system.

## Using custom attributes

If you see the `customAttributes` field within a fulfillmenttools entity, you can add any relevant data to it, whether that be from integrations or other services outside of fulfillmenttools.

{% hint style="info" %}
The `customAttributes` field shouldn't be confused with the `attributes` field mentioned in [customization via article attributes](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes).
{% endhint %}

Within the relevant entity, you can add the `customAttributes` object. For example, in the code extract below, we've added our own `customAttributes` as part of the facility entity:

{% code title="Facility custom attribute" %}

```json
{
...
  "name": "Nerd Herd Clothing",
  "type": "MANAGED_FACILITY",
  "customAttributes": {
        "accessibility": "Stairs only",
        "storageSize": "Medium",
        "staff": 12
  },
...
}
```

{% endcode %}

The `customAttributes` are stored and can be retrieved through the various fulfillmenttools APIs.

If you want the custom attribute to be searchable in the order overview in Backoffice, add the `searchTerms` field. This will only work for orders, pick jobs, pack jobs, handover jobs, shipments, and parcels.

{% code title="Order custom attribute" %}

```json
{
...
  "customAttributes": {
        "priority": "VIP customer",
        "searchTerms": {
              "priority": "VIP customer"
        }      
  },
...
```

{% endcode %}

Note:

* Only values directly under `searchTerms` are indexed. Anything else in `customAttributes` isn't found by the Backoffice search.
* Values have to be strings. Numbers, booleans, or nested objects aren't indexed.
* Search for the full value in Backoffice. Partial matches won't work.

## Limitations <a href="#custom-attribute-inheritance" id="custom-attribute-inheritance"></a>

Although you can add the data that you wish to a custom attribute, it needs to follow the limitations below:

* Each `customAttributes` object is serialized into a string and is subject to a size limit of 15,360 characters. You'll get an `HTTP 400` error if creating or updating an entity exceeds this limit.
* Keys within a `customAttributes` object must not start with a `$` character and must not contain a `.` character.
* Follow our [responsible API usage guidelines](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/limits-and-scaling#responsible-api-use).
* You're responsible for the data, including regulations that fall under GDPR or similar.

## Inheritance <a href="#custom-attribute-inheritance" id="custom-attribute-inheritance"></a>

Some `customAttributes` are inherited when entities are created in fulfillmenttools.

For example, when order line items include `customAttributes`, the resulting pick job line items include those `customAttributes`.

In general, all subsequent entities inherit these `customAttributes`.

{% hint style="info" %}
Not all `customAttributes` are shown in an [event](https://docs.fulfillmenttools.com/documentation/getting-started/eventing).
{% endhint %}


# Preparation for go live


# Performance on test versus production

As a customer of fulfillmenttools, you'll automatically have access to two environments:

1. Pre-production: The `projectId` would be `example-pre`
2. Production: The `projectId` would be `example-prd`

{% hint style="info" %}
Note that a `projectId` and a `{YOUR_TENANT_NAME}` are different. `{YOUR_TENANT_NAME}` includes ocff- whereas a `projectId` doesn't. For example, `{YOUR_TENANT_NAME}-example-pre` and `ocff-projectId-example-pre` are the same.
{% endhint %}

## Pre-production (PRE)

Pre-production (PRE) environments are suitable for functional testing of integration use cases. fulfillmenttools doesn't allow load testing in pre-production environments. For more information, refer to the [load testing guidelines](https://docs.fulfillmenttools.com/documentation/getting-started/preparation-for-go-live/load-testing).

{% hint style="info" %}
In specific cases, fulfillmenttools can temporarily create a production-like environment on pre-production with similar scaling properties and database connection configurations. To request this, contact us through the [service portal](https://ocfulfillment.atlassian.net/servicedesk/customer/portals).
{% endhint %}

### Cold starts

To conserve resources, pre-production environments scale to zero when no API traffic is present for a period of time. This applies to both the REST and GraphQL APIs. When fulfillmenttools is in this idle state, it's considered "cold."

The first API request to a cold system, such as creating an order, triggers a cold start. During a cold start, fulfillmenttools initiates the necessary services to serve the API. This initial request is blocked until the API gateway instances are ready, which can take up to 30 seconds. Once the services are running, fulfillmenttools becomes "warm," and subsequent API requests respond quickly.

Because fulfillmenttools is a distributed system that uses asynchronous events for internal communication, this event distribution is also affected by cold starts. If a tenant experiences constant traffic, cold starts typically occur only when resources are scaled up.

### Scaling

Once in a warm state, pre-production scales similarly to production environments based on parallel concurrent requests and resource usage, such as CPU and memory. Details on this behavior are available in the [Limits and scaling article](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/limits-and-scaling). However, the maximum scaling configuration in pre-production differs from that in production.

## Production (PRD)

Production environments (PRD) are configured for high availability and performance. On production, the REST API and GraphQL API gateways are always "warm," meaning no cold starts occur on the first request. This configuration minimizes API latency and ensures that events are delivered promptly.

Typical activities in a production system, such as incoming orders or pick job processing, keep the asynchronous event processing services warm. The production environment configuration ensures the elasticity and scalability of both the backend compute resources and the database systems.


# Load testing

A load test evaluates the integration with fulfillmenttools under regular expected traffic and peak loads. It's a recommended practice to perform a load test before the integration goes live.

## Load test types

Two types of load tests exist: Regular traffic and high-traffic scenarios.

Regular traffic scenarios model typical daily traffic, excluding promotions, and represent the steady state of the system.

High-traffic scenarios simulate sudden traffic peaks, such as the launch of a television campaign that's expected to increase traffic by 30%.

## Fair use policy and rules for load tests

Load tests must target expected traffic volumes. Don't attempt to crash fulfillmenttools.

Don't conduct load tests with sudden request spikes, such as increasing traffic from 0 to 1,000 requests per second (req/sec) instantly. A ramp-up phase is a mandatory prerequisite for all load tests.

As a general rule, one high-traffic scenario and one regular steady performance test may be performed per working day. To arrange additional tests before a launch, contact fulfillmenttools using the [contact form](https://docs.fulfillmenttools.com/documentation/products/core/incident-management) to discuss the process.

All load tests must be announced to fulfillmenttools at least **three business days in advance**. This notice allows the fulfillmenttools team to review the planned test, prepare the platform if needed, and ensure the load test doesn't interfere with other activities. When announcing a load test, include the planned execution date, expected traffic volumes, test duration, and the API endpoints involved.

## How to conduct the load test

### Define the load test scenario

First, define the use case for the load test by documenting the traffic goals, user scenarios, and API endpoints under test. Next, create scripts with a load-testing tool (for example, k6 or Siege) to simulate realistic traffic.

The simulation must be as realistic as possible. Mimic actual user behavior, such as visiting Product Detail Pages (PDPs), creating orders, and fulfilling orders via headless order fulfillment.

### Prepare the test scenario

Prepare the system by ensuring all required data, such as `facilities`, `listings`, and `stocks`, is available in the system before the test begins. This data serves as the baseline for the load test.

To reduce network overhead, execute the load test from a machine located in a cloud region near the fulfillmenttools instance deployment (see [available regions](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/helpful-information#available-regions)). For optimal results, execute load tests from a cloud provider machine instead of a local machine.

Each load test must be executed in two phases:

1. **Ramp up**\
   Slowly increase the traffic over a 20-minute period. This allows the fulfillmenttools platform to scale up and prepare for the full load.
2. **Load test**\
   Conduct the load test with the predefined traffic for 30 minutes while recording the results.

After the test concludes, clean the system by deleting all data created during the load test.

Don't begin the first load test with the final traffic goal. Start with a small traffic goal and incrementally increase the load in subsequent tests.

### Target environment

A typical setup includes a test environment and a production environment (see [performance on test versus production systems](https://docs.fulfillmenttools.com/documentation/getting-started/preparation-for-go-live/performance-on-test-versus-production)). fulfillmenttools does not support load tests on standard test environments. However, a dedicated pre-environment for load testing can be ordered via the [contact form](https://docs.fulfillmenttools.com/documentation/products/core/incident-management).

It is also possible to load-test production environments with real traffic before the go-live event. Ensure all test data is cleaned up afterward to provide a clean system for the go-live.


# Status and health

We provide two dedicated endpoints to check the health status of fulfillmenttools:

1. [Status](#status)
2. [Health](#health)

## Status

The status endpoint returns the current status: `UP`, `DEGRADED`, or `DOWN`. This endpoint doesn't require authentication and is ideal for a simple, regular ping.

## Get status

> Returns the fulfillmenttools status.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to get health status about fulfillmenttools.","name":"Health"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Status":{"additionalProperties":false,"properties":{"status":{"description":"The current state of the API","enum":["UP","DEGRADED","DOWN"],"type":"string"}},"required":["status"],"type":"object","xml":{"name":"Status"},"title":"Status","description":"Status"}}},"paths":{"/api/status":{"get":{"description":"Returns the fulfillmenttools status.","operationId":"status","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}},"description":"The status result"}},"summary":"Get status","tags":["Health"]}}}}
```

## Health

The health endpoint returns the status of individual internal dependencies, indicated as either `UP` or DOWN. This endpoint requires a valid Bearer token (JWT).

The endpoint returns not just a single overall status, but a list of individual internal components (for example, database connections or dependent services) that fulfillmenttools uses internally. Each component is checked separately, and its own status is reported.

A sample response from the endpoint would be structured as follows:

```json
{
    "status": "UP",
    "dependencies": [
        {
            "name": "database",
            "status": "UP"
        },
        {
            "name": "messaging",
            "status": "UP"
        }
    ]
}
```

* The top-level `status` field shows the overall status of fulfillmenttools: `UP` or `DOWN`.
* The `dependencies` array lists the individual internal components, each with its own `name` and `status` (also `UP` or `DOWN`).

This is particularly useful for monitoring, as it lets you not only spot an issue, but also identify which component is affected.

{% hint style="warning" %}
This documentation doesn't list the specific component names that appear in the `dependencies` array because they're derived from your tenant's actual API response.
{% endhint %}

## GET /api/health

> Health check

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to get health status about fulfillmenttools.","name":"Health"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"HealthResult":{"properties":{"dependencies":{"items":{"$ref":"#/components/schemas/HealthDependencyStatus"},"minItems":1,"type":"array"},"status":{"allOf":[{"$ref":"#/components/schemas/HealthStatus"}]}},"required":["status","dependencies"],"title":"HealthResult","type":"object","description":"HealthResult"},"HealthDependencyStatus":{"properties":{"name":{"description":"Name of the component that is checked to be healthy","type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/HealthStatus"}]}},"required":["name","status"],"title":"HealthDependencyStatus","type":"object","description":"HealthDependencyStatus"},"HealthStatus":{"enum":["UP","DOWN"],"title":"HealthStatus","type":"string","description":"HealthStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/health":{"get":{"deprecated":false,"description":"","operationId":"healthCheck","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResult"}}},"description":"Result of all tested dependencies for their health status"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Health check","tags":["Health"]}}}}
```


# Global Inventory Hub

The fulfillmenttools Global Inventory Hub enables the distribution and management of the entire network inventory across all facilities. Stock can be categorized according to various criteria, such as storage location or condition, and made available for sale.

## Overview inventory modules

Our Global Inventory Hub offers various functionalities that can be used modularly depending on your individual use case and requirements. Central modules such as stocks are necessary to manage inventory via fulfillmenttools.

<table><thead><tr><th width="142.98828125">Functionality</th><th width="144.046875">Store</th><th width="151.00390625">Dark store/small warehouse</th><th>Comment</th></tr></thead><tbody><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing">Listing</a></td><td>✔</td><td>✔</td><td>Recommended so that article data can be shown in the frontend and <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties">stock properties</a> can be used.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock">Stock</a></td><td>✔</td><td>✔</td><td>Required for all inventory features besides storage locations. Recommended for routing and picking.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/reservations">Reservations</a></td><td>✔</td><td>✔</td><td>Automatically made when using orders and routing.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability">Safety stock</a></td><td>✔</td><td>🅧</td><td>Used to reserve stock in stores for offline customers.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties">Stock properties</a></td><td>✔ / 🅧</td><td>✔</td><td>Recommended for tracking expiry dates or other special attributes on stock level. Prevents expired items from being sold, and can be used for picking by FIFO.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing#stock-available-until">Stock available until</a></td><td>✔ / 🅧</td><td>✔ / 🅧</td><td>Recommended when using expiry dates or sales periods, to prevent the sale of expired or outdated products.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits">Inventory traits</a></td><td>✔ / 🅧</td><td>✔</td><td>Used for differentiation between (non-) pickable and/or (un-)blocked stock. Enables assignment of articles to dedicated locations for <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones#storage-location-recommendations">location recommendations</a>.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/categories">Article categories</a></td><td>✔ / 🅧</td><td>✔ / 🅧</td><td>Categories can be used to mark listings as belonging to a specific group.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/inbound">Inbound</a></td><td>✔ / 🅧</td><td>✔</td><td>Necessary for making <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/expected-stock-in-availability">expected stock</a> already available for sale. Allows managing the goods receipt and storage process via fulfillmenttools.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones">Storage locations</a></td><td>✔ / 🅧</td><td>✔</td><td>Allows managing the facility layout and using the <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process">inbound</a>, storage, relocation, <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones#running-sequences-on-storage-locations">running sequence</a>, and <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones#storage-location-recommendations">location recommendations</a> features.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones#zones">Zone</a></td><td>✔ / 🅧</td><td>✔ / 🅧</td><td>Recommended if useful for managing the facility layout or using <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking#zone-picking">zone picking</a>.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/measurement-units">Measurement units</a></td><td>✔ / 🅧</td><td>✔ / 🅧</td><td>Recommended if other units than pieces should be tracked.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stow-jobs">Stow jobs</a></td><td>✔ / 🅧</td><td>✔</td><td>Allows managing the storage and relocation of items.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/external-stock-change-reasons">External stock change reasons</a></td><td>✔ / 🅧</td><td>✔ / 🅧</td><td>Allows giving reasons for changes in stock levels (can only be used in combination with stow jobs as of now).</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#short-pick-configuration">Short pick configuration</a></td><td>✔ / 🅧</td><td>✔ / 🅧</td><td>Recommended if picking is used, and stock should be adapted after <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking#short-pick">short picks</a>.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#unmixed-storage-configuration">Unmixed storage configuration</a></td><td>✔ / 🅧</td><td>✔ / 🅧</td><td>Recommended if the same article with different attributes (for example, expiry date) should not be stored in the same location.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#outbound-stock-configuration">Outbound stock configuration</a></td><td>🅧</td><td>✔ / 🅧</td><td>Recommended if items should be tracked until handed over to a carrier or consumer.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory">Backoffice – Stock overview</a></td><td>✔</td><td>✔</td><td>Always on</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory">Backoffice – Listings</a></td><td>✔</td><td>✔</td><td>Always on</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/inbound">Backoffice – Inbound</a></td><td>✔ / 🅧</td><td>✔</td><td>Recommended if inbound and expected stock features are used.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/storage-locations">Backoffice – Storage locations</a></td><td>✔ / 🅧</td><td>✔</td><td>Recommended if storage locations are used.</td></tr><tr><td><a href="https://docs.fulfillmenttools.com/documentation/apps/inventory-app">Inventory app</a></td><td>✔ / 🅧</td><td>✔</td><td>Allows managing the goods receipt, storage and relocation of items via an Android app.</td></tr></tbody></table>


# Listing

A listing is an item that's sold in a facility. It contains product information, such as price, barcodes, and attributes. A listing doesn't represent the actual (available) quantity of a product in a facility.

The listing `id` is composed of `{facilityId}_{tenantArticleId}`. For example, if the `facilityId` is `5d174533-29b9-464b-9325-94bfacefe335` and the `tenantArticleId` is `SNEAK-W-4891`, the listing `id` would be `5d174533-29b9-464b-9325-94bfacefe335_SNEAK-W-4891`.

{% hint style="warning" %}
Note the difference between listings and [articles](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles).
{% endhint %}

## Listings and stocks

A listing holds master data for a product within a facility. Stock refers to one or more items in a facility that share the same attributes. Stock holds all information specific to individual pieces of a product.

Stock can technically exist without listings. However, we strongly recommend always creating listings for two reasons:

* Listings are required for order routing as they contain data relevant to routing processes. Routing to a facility isn't possible if that facility has no listings.
* Listings provide the product information displayed in fulfillmenttools clients (for example, Backoffice and Store Operations app).

See the [Stock article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock) for more information.

## Listing properties and configurations

### Tenant article ID

A `tenantArticleID` is a unique identifier of an item. You can define this field as you wish. For example, you could use your product ID from your commerce system, or your SKU (Stock Keeping Unit) number. See the [URN pattern article](https://docs.fulfillmenttools.com/documentation/apis/api-reference#uniform-resource-name-pattern-urn-in-path-parameters) for more details.

### Status

Listings can be active or inactive.

{% hint style="warning" %}
Deactivated listings are not considered for incoming orders.
{% endhint %}

The `LISTINGS_STATUS_CHANGED` event is emitted when the status is changed.

### Listing attributes

Attributes store listing-specific information, including:

* Descriptions
* Picking sequence
* Shop and sales price
* Insurance-related data for shipping
* Dimensions

{% hint style="info" %}
For more information, see the [article attributes article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes).
{% endhint %}

### Scanning rule

Configuration that shows the client how items should be scanned during picking. For more information, see the [scanning configuration article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking#scanning-configuration).

### Out-of-stock behavior <a href="#out-of-stock-behaviour" id="out-of-stock-behaviour"></a>

Defines the behavior when a customer places an order for a product that is out of stock or unavailable for immediate shipment.

A listing can be designated as backorderable, preorderable, restockable, or both preorderable and restockable.

You can configure out-of-stock behavior for specific facility groups or orders with certain tags. You can also set exceptions to these out-of-stock behaviors.

{% hint style="info" %}
See the [Preorders and backorders article](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/pre-and-backorders) for functional details. Configuration details can be found in the [Out of stock behavior and configuration article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/out-of-stock-behavior-and-configuration).
{% endhint %}

The `LISTINGS_STOCK_CONFIGURATIONS_CHANGED` event is emitted when this setting is changed.

### Availability timeframe <a href="#availability-timeframe" id="availability-timeframe"></a>

If a listing is already flagged with `outOfStockBehaviour` = "BACKORDER" and has an `availabilityTimeFrame` configured, orders containing that listing are accepted but assigned a specific facility only when the date defined in the `availabilityTimeFrame` is reached.​

### Out-of-stock configuration

{% hint style="info" %}
This functionality is only available if your tenant is configured for operating in complex networks. If you're interested, contact our Support team via [service request](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11/create/39).
{% endhint %}

The out-of-stock configuration defines behavior if a consumer places an order for an article that is currently out of stock or unavailable for immediate shipment.

A listing can be either backorderable, preorderable, restockable, or preorderable and restockable. You can define this in the listing's `outOfStockBehaviour`.

For preorderable, restockable, or preorderable and restockable, you must also configure an `outOfStockConfig` on the listing. If the out-of-stock behavior should apply only to specific facility groups or orders with certain tags, define an `outOfStockBehaviourByContexts`.

* Preorderable
  * The order can be picked as soon as the `availabilityTimeFrame.start` is reached.
  * If no stock is available for the order line item(s), this configuration is not considered.
* Restockable
  * The order is treated as having "infinite" stock for the respective line items (after "x days").
  * The `restockableInDays` is used for calculations in routing. If `restockableInDays` = 0, routing assumes the facility has sufficient stock.

{% hint style="info" %}
If different facility groups or orders have different out-of-stock behaviors, you can add a `context` to the [out-of-stock configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/out-of-stock-behavior-and-configuration).
{% endhint %}

The `LISTINGS_STOCK_CONFIGURATIONS_CHANGED` event is emitted when `outOfStockBehaviour`, `outOfStockConfig`, or `outOfStockBehaviourByContexts` are changed.

### Tags

Tags consist of a tag `id` plus allowed values for each tag. They can map very specific processes and customize entities to meet particular needs. For more information, see the [Tags](https://docs.fulfillmenttools.com/documentation/getting-started/tags) and [Stickers](https://docs.fulfillmenttools.com/documentation/getting-started/stickers) articles.

### Measurement units

Measurement units specify the unit used to count or measure the product. You can set them using the `measurementUnitKey` field. The default counting unit is pieces. However, you can define other units, such as grams, liters, or custom units. For more information on creating new units and their localizations, refer to the [Measurement units article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/measurement-units).

If one product should be tracked in different units (for example, as bulk by weight and also by prepackaged quantity), two listings with different tenant article IDs need to be created, for example, "xyz-123-bulk" and "xyz-123-packaged". Since each product is kept in one measurement unit, operations like adding or moving stock don't need to validate or convert units between stocks.

### Stock properties

Stock properties allow tracking specific values on a set of items, a [stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock). A typical example of properties is the expiry date or batch number. The listing defines which properties should be tracked for stocks associated with this specific listing. Moreover, the listing can be configured to make tracking stock properties mandatory (for example, during goods receipt) and to specify whether the value is expected to be text or a date.

Often, it helps to limit and enforce which properties are tracked for each product type. You can configure this using the `stockProperties` field on `Listings`. This field does not contain key-value pairs of property values but rather `StockPropertyDefinitions`. Each defines the following:

For more information, see the [Stock properties article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties).

The `LISTINGS_STOCK_CONFIGURATIONS_CHANGED` event is emitted when `stockProperties` is changed.

| Field          | Description                                                                                                                                          |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `inputType`    | `DATE` or `TEXT`. The input type controls how clients should treat this property's values (for example, show a date picker instead of a text field). |
| `required`     | `boolean`. Creating a stock without providing a value for a `required` property will be forbidden and will fail.                                     |
| `defaultValue` | String or `{{NOW}}`, which will be interpolated to the current timestamp.                                                                            |

{% hint style="warning" %}
Constraints, validations, and default values are only applied when creating stocks.

This means existing stocks may still lack required properties, or have properties that are not allowed under newer rulesets.
{% endhint %}

If you don't want to enforce constraints, you can set the `stockProperties` field to `null` or `undefined`. In that case, no properties are set.

### Stock available until

The `availableUntil` field defines until when stock is included in the stock availability, which is, for example, used to communicate available stock to shop systems. For consumer orders, the availability check ensures that stock has not exceeded its `availableUntil` value until it is delivered to the customer.

In the listing, you can specify until when the corresponding stock should be available. The `availableUntil` value is set when stock is created if configured in the listing. When updating a listing with `stockAvailableUntil`, the value is added only to newly created stock.

The `LISTINGS_STOCK_CONFIGURATIONS_CHANGED` event is emitted when `stockAvailableUntil` is changed.

For more information, see the [Stock availability article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability).

* `calculation base`: Specifies the base date for the calculation of `availableUntil`. Set the field to `EXPIRY` if the stock should become unavailable before it expires. `EXPIRY` must be configured in the [stockProperties](#stock-properties) before it can be used here. Set the field to `CREATION` if the stock should become unavailable sometime after it was created.
* `modifier`: The time span is applied to the calculation base to calculate when stock should become unavailable. Use negative values to move the date backward. Example: `-P30D` places the `availableUntil` value 30 days before the calculated date.

{% hint style="warning" %}

* `stockAvailableUntil` defaults to the expiry date. So, if no `stockAvailableUntil` is configured on the listing, a stock's `stockAvailableUntil` will be its expiry date.
* An undefined `stockAvailableUntil` on stocks (for example, no `stockAvailableUntil` and no expiry is configured) means the stock will be available indefinitely.
  {% endhint %}

### Legal

Under `legal`, you can specify a `hsCode`. HS stands for Harmonized System and is a description and coding system authorities use to classify a product. In fulfillmenttools, it's used, for example, when requesting a carrier label for sending a package.

### Categories

A listing can belong to one to many categories. The `categoryRef` on the listing lets you assign multiple listings to the same category.

{% hint style="info" %}
More information can be found under [article categories](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/categories).
{% endhint %}

{% hint style="info" %}
For detailed API specifications, see the [REST API documentation for Listings](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/facilities/-facilityId-/listings).
{% endhint %}

## Create a listing

{% hint style="warning" %}
Before creating a listing, you must create a [facility](https://docs.fulfillmenttools.com/documentation/getting-started/facilities). Listings are always related to a specific facility.
{% endhint %}

To create a listing, send a `PUT` request to the following endpoint with a JSON body:

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/listings
```

```json
{
  "listings": [
    {
      "imageUrl": "https://img.example.com/img/sneakw4891.jpg",
      "price": 119.00,
      "tenantArticleId": "SNEAK-W-4891",
      "titleLocalized": {
        "de_DE": "Weiße turnschuhe",
        "en_US": "White sneakers"
      }
    }
  ]
}
```

A successful request returns an `HTTP 200 OK` response.

Use the same `PUT` request to update your listings for a single facility. To update listings for multiple facilities, see the [Bulk upsert listings section](#bulk-upsert-listings).

{% hint style="info" %}
The `PUT` acts with upsert behavior. It creates a new listing or updates an existing one. It will never delete a listing. To delete a listing, see [Delete a listing](#delete-a-listing).
{% endhint %}

When you update certain fields, the `LISTINGS_INFORMATION_CHANGED` event is emitted. This applies to updates for the following fields:

* `attributes`
* `price`
* `title`
* `titleLocalized`
* `weight`
* `scannableCodes`
* `tags`
* `measurementUnitKey`
* `currency`
* `legal`
* `customAttributes`
* `categoryRefs`
* `imageUrl`

{% hint style="info" %}
Listings are visible in Backoffice, but can only be created via API.
{% endhint %}

## Retrieve listings

To retrieve all listings for a specific facility, send a paginated `GET` request to the following endpoint using the `facilityId`:

```http
GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/listings
```

A successful request returns an `HTTP 200 OK` response containing all listings for that facility.

```json
{
    "total": 1,
    "listings": [
        {
            "id": "5d174533-29b9-464b-9325-94bfacefe335_SNEAK-W-4891",
            "version": 1,
            "status": "ACTIVE",
            "tenantArticleId": "SNEAK-W-4891",
            "created": "2026-08-22T12:19:14.129Z"
        }
    ]
}
```

Alternatively, to retrieve a specific listing by its `tenantArticleId`, use the following `GET` endpoint:

```http
GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/listings/{YOUR_TENANT_ARTICLE_ID}
```

The endpoint returns an `HTTP 200 OK` response with a detailed view of the specified listing:

```json
{
  "attributes": null,
  "imageUrl": "https://img.example.com/img/sneakw4891.jpg",
  "price": 119.00,
  "tenantArticleId": "SNEAK-W-4891",
  "titleLocalized": {
    "de_DE": "Weiße turnschuhe",
    "en_US": "White sneakers"
  },
  "scannableCodes": [],
  "created": "2026-08-22T12:19:14.129Z",
  "lastModified": "2026-08-22T12:19:14.129Z",
  "version": 1,
  "facilityId": "5d174533-29b9-464b-9325-94bfacefe335",
  "id": "5d174533-29b9-464b-9325-94bfacefe335_SNEAK-W-4891",
  "status": "ACTIVE"
}
```

{% hint style="info" %}
Notice that the `id` for the listing is made up of both the `facilityId` and the `tenantArticleId`.
{% endhint %}

## Bulk upsert listings

To upsert listings for multiple facilities while minimizing API calls, use the bulk upsert endpoint.

There are two options for using the endpoint:

* [`ListingForBulkUpsertBySelector`](#updating-with-listingforbulkupsertbyselector): Lets you send listing information once and update it for multiple facilities.
* [`ListingForBulkUpsertByFacility`](#updating-with-listingforbulkupsertbyfacility): Lets you send different listing information for the same `tenantArticleId` for multiple facilities.

{% hint style="info" %}
Send the listing `version` to update it. Otherwise, it creates a new listing. If a listing with the same `tenantArticleId` already exists, the entire update batch fails.
{% endhint %}

### Search for the listing version

Before updating existing listings, you must retrieve their current `version`. You can do this by searching for the listings. Then use the bulk API to update multiple listings across facilities simultaneously.

The following example shows how to search for all listings with `tenantArticleId` SNEAK-W-4891 to retrieve their current versions.

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/listings/search
```

```json
{
  "query": {
    "tenantArticleId": {
      "eq": "SNEAK-W-4891"
    }
  }
}
```

{% hint style="info" %}
You might need to iterate over multiple pages to get all listings with the corresponding `tenantArticleId`. More information can be found under [Pagination.](https://docs.fulfillmenttools.com/documentation/getting-started/general-concepts#pagination)
{% endhint %}

The search returns the complete listings.

### Update with `ListingForBulkUpsertBySelector`

To update multiple listings, send a `PUT` request to the following endpoint with the JSON body:

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/listings
```

```json
{
  "listings": [
    {
      "tenantArticleId": "SNEAK-W-4891",
      "selector": [
        {
          "facility": {
            "facilityRef": "facility1"
          },
          "version": 42
        },
        {
          "facility": {
            "facilityRef": "facility2"
          },
          "version": 43
        }
      ],
      "targetingStrategy": "MULTI_SELECTOR",
       ... // the full updated listing
    }
  ]
}
```

Each object in the `selector` array specifies a listing in a particular facility by its `tenantArticleId` and current `version`. A single batch can update up to 25 listings. You can do this by providing 25 selectors for one listing, or by providing multiple listings with their respective selectors. The endpoint returns the updated listings and a summary of the operations.

{% hint style="warning" %}
This is an all-or-nothing behavior. If one listing insert fails, all others will fail as well.
{% endhint %}

```json
{
  "listings": [
    {
      ...
    },
    ...
  ],
  "summary": {
    "created": 0,
    "updated": 2
  }
}
```

### Update with `ListingForBulkUpsertByFacility`

To update multiple listings, send a `PUT` request to the following endpoint with the JSON body:

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/listings
```

```json
{
  "listings": [
    {
      "tenantArticleId": "SNEAK-W-4891",
      "facility": {
        "facilityRef": "facility1"
      },
      "targetingStrategy": "SINGLE_FACILITY",
      "version": 42,
      ... // the full updated listing
    },
    {
      "tenantArticleId": "SNEAK-W-4891",
      "facility": {
        "facilityRef": "facility2"
      },
      "targetingStrategy": "SINGLE_FACILITY",
      "version": 43,
      ... // the full updated listing
    },
    ...
  ]
}
```

The endpoint returns the updated listings and a summary of the operations.

{% hint style="warning" %}
This is an all-or-nothing behavior. If one listing insert fails, all others will fail as well.
{% endhint %}

```json
{
  "listings": [
    {
      ...
    },
    ...
  ],
  "summary": {
    "created": 0,
    "updated": 2
  }
}
```

## Delete a listing

To delete a single listing, send a `DELETE` request to this endpoint:

```http
DELETE https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{facilityId}/listings/{tenantArticleId}
```

To delete all the listings for a facility, use the endpoint below:

```http
DELETE https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{facilityId}/listings
```


# Listings endpoint

## The Listing object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"maxItems":50,"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"RecordableAttributeValidation":{"properties":{"allowedValues":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidationsAllowedValue"},"maxItems":60,"minItems":0,"type":"array"},"key":{"description":"Key of this value to validate against operation validations","minLength":1,"nullable":true,"type":"string"},"type":{"enum":["EXACT_MATCH"],"type":"string"}},"required":["type","allowedValues"],"title":"RecordableAttributeValidation","type":"object","description":"RecordableAttributeValidation"},"RecordableAttributeValidationsAllowedValue":{"properties":{"type":{"enum":["STRING"],"type":"string"}},"required":["type"],"title":"RecordableAttributeValidationsAllowedValue","type":"object","description":"RecordableAttributeValidationsAllowedValue"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"}}}}
```

## List listings (search)

> Search for Listing

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read facility listings.","name":"Listings"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ListingSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/ListingSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/ListingSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"ListingSearchPayload","type":"object","description":"ListingSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"ListingSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ListingSearchQuery"},"maxItems":500,"type":"array"},"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/ListingAvailabilityTimeframeFilter"}],"description":"Nested search by availabilityTimeframe"},"categoryRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by categoryRefs"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"measurementUnitKey":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by measurementUnitKey"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ListingSearchQuery"},"maxItems":500,"type":"array"},"outOfStockBehaviour":{"allOf":[{"$ref":"#/components/schemas/ListingOutOfStockBehaviourEnumFilter"}],"description":"Search by outOfStockBehaviour"},"price":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by price"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"status":{"allOf":[{"$ref":"#/components/schemas/ListingStatusEnumEnumFilter"}],"description":"Search by status"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"weight":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by weight"},"tags":{"allOf":[{"$ref":"#/components/schemas/ListingTagsListFilter"}],"description":"Nested list search by tags"}},"title":"ListingSearchQuery","type":"object","description":"ListingSearchQuery"},"ListingAvailabilityTimeframeFilter":{"properties":{"start":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by start"}},"title":"ListingAvailabilityTimeframeFilter","type":"object","description":"ListingAvailabilityTimeframeFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"ListingOutOfStockBehaviourEnumFilter":{"properties":{"eq":{"description":"Search by outOfStockBehaviour","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"in":{"description":"Search by outOfStockBehaviour","items":{"enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by outOfStockBehaviour","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string"}},"title":"ListingOutOfStockBehaviourEnumFilter","type":"object","description":"ListingOutOfStockBehaviourEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"ListingStatusEnumEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["ACTIVE","INACTIVE"],"type":"string"}},"title":"ListingStatusEnumEnumFilter","type":"object","description":"ListingStatusEnumEnumFilter"},"ListingTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/ListingTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"ListingTagsListFilter","type":"object","description":"ListingTagsListFilter"},"ListingTagsFilter":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"ListingTagsFilter","type":"object","description":"ListingTagsFilter"},"ListingSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"tenantArticleId":{"enum":["ASC","DESC"],"type":"string"}},"title":"ListingSort","type":"object","description":"ListingSort"},"ListingPaginatedResult":{"properties":{"listings":{"items":{"$ref":"#/components/schemas/Listing"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","listings"],"title":"ListingPaginatedResult","type":"object","description":"ListingPaginatedResult"},"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"maxItems":50,"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"RecordableAttributeValidation":{"properties":{"allowedValues":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidationsAllowedValue"},"maxItems":60,"minItems":0,"type":"array"},"key":{"description":"Key of this value to validate against operation validations","minLength":1,"nullable":true,"type":"string"},"type":{"enum":["EXACT_MATCH"],"type":"string"}},"required":["type","allowedValues"],"title":"RecordableAttributeValidation","type":"object","description":"RecordableAttributeValidation"},"RecordableAttributeValidationsAllowedValue":{"properties":{"type":{"enum":["STRING"],"type":"string"}},"required":["type"],"title":"RecordableAttributeValidationsAllowedValue","type":"object","description":"RecordableAttributeValidationsAllowedValue"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/listings/search":{"post":{"deprecated":false,"description":"Search for Listing","operationId":"searchListing","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List listings (search)","tags":["Listings"]}}}}
```

## Create and update listings

> Bulk upsert listings independently of their facility

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read facility listings.","name":"Listings"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ListingBulkUpsertPayload":{"properties":{"listings":{"description":"List of listings to be upserted in bulk. Number of entries times selectors must not exceed 25.","items":{"discriminator":{"mapping":{"MULTI_SELECTOR":"#/components/schemas/ListingForBulkUpsertBySelector","SINGLE_FACILITY":"#/components/schemas/ListingForBulkUpsertByFacility"},"propertyName":"targetingStrategy"},"oneOf":[{"$ref":"#/components/schemas/ListingForBulkUpsertBySelector"},{"$ref":"#/components/schemas/ListingForBulkUpsertByFacility"}]},"minItems":1,"type":"array"}},"required":["listings"],"title":"ListingBulkUpsertPayload","type":"object","description":"ListingBulkUpsertPayload"},"ListingForBulkUpsertBySelector":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","nullable":true,"type":"string"},"customAttributes":{"additionalProperties":true,"description":"Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext2"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"allOf":[{"$ref":"#/components/schemas/OutOfStockConfig2"}],"description":"The outOfStockConfig is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>"},"price":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","type":"number"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"selector":{"description":"Facility selectors for bulk operations. Add one or more selectors to specify the facilities for the listings.","items":{"$ref":"#/components/schemas/ListingFacilitySelector"},"minItems":1,"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"description":"Key-value pairs for stock properties of the requested items. Must be a subset of the listings defined stockProperties","type":"object"},"targetingStrategy":{"description":"Targeting strategy for this bulk upsert entry - determines how target facilities are specified.","enum":["MULTI_SELECTOR","SINGLE_FACILITY"],"type":"string"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId","title","targetingStrategy","selector"],"title":"ListingForBulkUpsertBySelector","type":"object","description":"ListingForBulkUpsertBySelector"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext2":{"properties":{"context":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext"},"maxItems":5,"minItems":1,"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig2"},"priority":{"type":"number"}},"required":["outOfStockBehaviour","context","priority"],"title":"OutOfStockBehaviourByContext2","type":"object","description":"OutOfStockBehaviourByContext2"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig2":{"properties":{"preorder":{"$ref":"#/components/schemas/OutOfStockConfigPreorder2"},"restock":{"$ref":"#/components/schemas/InventoryOutOfStockConfigRestock"}},"title":"OutOfStockConfig2","type":"object","description":"OutOfStockConfig2"},"OutOfStockConfigPreorder2":{"properties":{"availabilityTimeframe":{"allOf":[{"$ref":"#/components/schemas/AvailabilityTimeframe2"}]}},"required":["availabilityTimeframe"],"title":"OutOfStockConfigPreorder2","type":"object","description":"OutOfStockConfigPreorder2"},"AvailabilityTimeframe2":{"properties":{"start":{"type":"string"}},"required":["start"],"title":"AvailabilityTimeframe2","type":"object","description":"AvailabilityTimeframe2"},"InventoryOutOfStockConfigRestock":{"properties":{"restockableInDays":{"type":"number"}},"required":["restockableInDays"],"title":"InventoryOutOfStockConfigRestock","type":"object","description":"InventoryOutOfStockConfigRestock"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"ListingFacilitySelector":{"properties":{"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"version":{"description":"Optional version of the facility. Must be provided for existing facilities. Leave empty for new facilities.","type":"number"}},"required":["facility"],"title":"ListingFacilitySelector","type":"object","description":"ListingFacilitySelector"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ListingForBulkUpsertByFacility":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","nullable":true,"type":"string"},"customAttributes":{"additionalProperties":true,"description":"Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext2"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"allOf":[{"$ref":"#/components/schemas/OutOfStockConfig2"}],"description":"The outOfStockConfig is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br/>"},"price":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","type":"number"},"scannableCodes":{"description":"Codes, that identify the article","items":{"type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"description":"Key-value pairs for stock properties of the requested items. Must be a subset of the listings defined stockProperties","type":"object"},"targetingStrategy":{"description":"Targeting strategy for this bulk upsert entry - determines how target facilities are specified.","enum":["MULTI_SELECTOR","SINGLE_FACILITY"],"type":"string"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"version":{"description":"Optional version of the facility. Must be provided for existing facilities.","type":"number"},"weight":{"deprecated":true,"description":"Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId","title","targetingStrategy","facility"],"title":"ListingForBulkUpsertByFacility","type":"object","description":"ListingForBulkUpsertByFacility"},"ListingBulkUpsertResponse":{"properties":{"listings":{"description":"Listings upsert operations that were successfully upserted.","items":{"$ref":"#/components/schemas/ListingBulkUpsertSuccess"},"type":"array"},"summary":{"allOf":[{"$ref":"#/components/schemas/BulkUpsertSummary"}],"description":"Summary of the operations."}},"required":["summary","listings"],"title":"ListingBulkUpsertResponse","type":"object","description":"ListingBulkUpsertResponse"},"ListingBulkUpsertSuccess":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/Listing"}],"description":"The resulting entity."},"status":{"description":"Indicates whether the operation created or updated the entity.","enum":["CREATED","UPDATED","UNCHANGED"],"type":"string"}},"required":["status","result"],"title":"ListingBulkUpsertSuccess","type":"object","description":"ListingBulkUpsertSuccess"},"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"maxItems":50,"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"RecordableAttributeValidation":{"properties":{"allowedValues":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidationsAllowedValue"},"maxItems":60,"minItems":0,"type":"array"},"key":{"description":"Key of this value to validate against operation validations","minLength":1,"nullable":true,"type":"string"},"type":{"enum":["EXACT_MATCH"],"type":"string"}},"required":["type","allowedValues"],"title":"RecordableAttributeValidation","type":"object","description":"RecordableAttributeValidation"},"RecordableAttributeValidationsAllowedValue":{"properties":{"type":{"enum":["STRING"],"type":"string"}},"required":["type"],"title":"RecordableAttributeValidationsAllowedValue","type":"object","description":"RecordableAttributeValidationsAllowedValue"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"},"BulkUpsertSummary":{"properties":{"created":{"description":"The number of operations that led to an insertion","type":"number"},"unchanged":{"description":"The number of operations that led to no change","type":"number"},"updated":{"description":"The number of operations that led to an update","type":"number"}},"required":["created","updated","unchanged"],"title":"BulkUpsertSummary","type":"object","description":"BulkUpsertSummary"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/listings":{"put":{"deprecated":false,"description":"Bulk upsert listings independently of their facility","operationId":"bulkUpsertListings","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingBulkUpsertPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingBulkUpsertResponse"}}},"description":"Result of the bulk upsert operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."}},"summary":"Create and update listings","tags":["Listings"]}}}}
```

## GET /api/facilities/{facilityId}/listings/{tenantArticleId}

> Get listing

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read facility listings.","name":"Listings"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"maxItems":50,"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"RecordableAttributeValidation":{"properties":{"allowedValues":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidationsAllowedValue"},"maxItems":60,"minItems":0,"type":"array"},"key":{"description":"Key of this value to validate against operation validations","minLength":1,"nullable":true,"type":"string"},"type":{"enum":["EXACT_MATCH"],"type":"string"}},"required":["type","allowedValues"],"title":"RecordableAttributeValidation","type":"object","description":"RecordableAttributeValidation"},"RecordableAttributeValidationsAllowedValue":{"properties":{"type":{"enum":["STRING"],"type":"string"}},"required":["type"],"title":"RecordableAttributeValidationsAllowedValue","type":"object","description":"RecordableAttributeValidationsAllowedValue"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/listings/{tenantArticleId}":{"get":{"description":"","operationId":"getListing","parameters":[{"description":"ID of facility you want to get listing. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"tenantArticleId of listing you want to get","in":"path","name":"tenantArticleId","required":true,"schema":{"type":"string"}},{"description":"Provide the localized names and descriptions for the listing. If not provided the default locale is used., for example de_DE.","in":"query","name":"locale","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listing"}}},"description":"Listing is found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Listings not found"}},"summary":"Get listing","tags":["Listings"]}}}}
```

## DELETE /api/facilities/{facilityId}/listings

> Delete listings

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read facility listings.","name":"Listings"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/listings":{"delete":{"description":"","operationId":"deleteListingsOfFacility","parameters":[{"description":"ID of facility you want to delete all listings of. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Facility listings were found and successfully deleted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility listing not found"}},"summary":"Delete listings","tags":["Listings"]}}}}
```

## GET /api/facilities/{facilityId}/listings

> List listings

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read facility listings.","name":"Listings"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StrippedListings":{"properties":{"listings":{"items":{"$ref":"#/components/schemas/StrippedListing"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedListings","description":"StrippedListings"},"StrippedListing":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"id":{"type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"tenantArticleId":{"description":"This is a reference to an article Id","type":"string"}},"required":["status","facilityId","id","tenantArticleId"],"type":"object"}],"title":"StrippedListing","description":"StrippedListing"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/listings":{"get":{"description":"","operationId":"getFacilityListing","parameters":[{"description":"ID of facility you want to get listing for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of facilities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"Array of tenantArticleIds","explode":false,"in":"query","name":"tenantArticleIds","required":false,"schema":{"items":{"type":"string"},"maxItems":500,"type":"array"}},{"description":"limit results to this scannableCode","in":"query","name":"scannableCode","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrippedListings"}}},"description":"Facility was found & you were allowed to access it. The results are in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"List listings","tags":["Listings"]}}}}
```

## Create and update listings per facility

> Bulk PUT for Listings. Please note: This endpoint has legacy behaviour, i.e. all PUTs fail if a single PUT fails.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read facility listings.","name":"Listings"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ListingsForReplacement":{"properties":{"listings":{"items":{"$ref":"#/components/schemas/ListingForReplacement"},"maxItems":500,"minItems":1,"type":"array"}},"required":["listings"],"type":"object","xml":{"name":"ListingsForReplacement"},"title":"ListingsForReplacement","description":"ListingsForReplacement"},"ListingForReplacement":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"}],"properties":{"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"version":{"format":"int64","type":"integer"}},"type":"object","xml":{"name":"ListingForReplacement"},"title":"ListingForReplacement","description":"ListingForReplacement"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"maxItems":50,"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"RecordableAttributeValidation":{"properties":{"allowedValues":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidationsAllowedValue"},"maxItems":60,"minItems":0,"type":"array"},"key":{"description":"Key of this value to validate against operation validations","minLength":1,"nullable":true,"type":"string"},"type":{"enum":["EXACT_MATCH"],"type":"string"}},"required":["type","allowedValues"],"title":"RecordableAttributeValidation","type":"object","description":"RecordableAttributeValidation"},"RecordableAttributeValidationsAllowedValue":{"properties":{"type":{"enum":["STRING"],"type":"string"}},"required":["type"],"title":"RecordableAttributeValidationsAllowedValue","type":"object","description":"RecordableAttributeValidationsAllowedValue"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"ListingBulkOperationResult":{"properties":{"listing":{"$ref":"#/components/schemas/Listing"},"status":{"$ref":"#/components/schemas/BulkOperationResultStatus"}},"required":["listing","status"],"type":"object","title":"ListingBulkOperationResult","description":"ListingBulkOperationResult"},"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"},"BulkOperationResultStatus":{"enum":["UPDATED","UNCHANGED","CREATED","FAILED"],"type":"string","title":"BulkOperationResultStatus","description":"BulkOperationResultStatus"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/listings":{"put":{"description":"Bulk PUT for Listings. Please note: This endpoint has legacy behaviour, i.e. all PUTs fail if a single PUT fails.","operationId":"putFacilityListing","parameters":[{"description":"ID of facility you want to put listings for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingsForReplacement"}}},"description":"listings for put","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ListingBulkOperationResult"},"type":"array"}}},"description":"Facility listing was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility listing not found"}},"summary":"Create and update listings per facility","tags":["Listings"]}}}}
```

## PATCH /api/facilities/{facilityId}/listings/{tenantArticleId}

> Update listing

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read facility listings.","name":"Listings"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ListingPatchActions":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyListing"},"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","actions"],"type":"object","xml":{"name":"ListingPatchActions"},"title":"ListingPatchActions","description":"ListingPatchActions"},"ModifyListing":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"action":{"description":"Use value 'ModifyListing', because you want to modify a listing","enum":["ModifyListing"],"type":"string"},"attributes":{"description":"The attributes of this listing","items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"nullable":true,"type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"status":{"description":"The status indicates if a listing is available or not","enum":["ACTIVE","INACTIVE"],"type":"string"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"nullable":true,"type":"object"},"subtitle":{"description":"a subtitle describing the article","type":"string"},"title":{"description":"a title describing the article","type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyListing"},"title":"ModifyListing","description":"ModifyListing"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ListingAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"properties":{"valueLocalized":{"$ref":"#/components/schemas/LocaleString"},"keyLocalized":{"$ref":"#/components/schemas/LocaleString"}},"title":"ListingAttributeItem","description":"ListingAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"ListingLegal":{"additionalProperties":false,"properties":{"hsCode":{"maxLength":50,"type":"string"}},"type":"object","title":"ListingLegal","description":"ListingLegal"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"OutOfStockConfig":{"additionalProperties":false,"properties":{"preorder":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"}},"required":["availabilityTimeframe"],"type":"object"},"restock":{"properties":{"restockableInDays":{"type":"integer"}},"required":["restockableInDays"],"type":"object"}},"type":"object","title":"OutOfStockConfig","description":"OutOfStockConfig"},"ListingRecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttributeForCreation","type":"object","description":"ListingRecordableAttributeForCreation"},"RecordableAttributeValidation":{"properties":{"allowedValues":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidationsAllowedValue"},"maxItems":60,"minItems":0,"type":"array"},"key":{"description":"Key of this value to validate against operation validations","minLength":1,"nullable":true,"type":"string"},"type":{"enum":["EXACT_MATCH"],"type":"string"}},"required":["type","allowedValues"],"title":"RecordableAttributeValidation","type":"object","description":"RecordableAttributeValidation"},"RecordableAttributeValidationsAllowedValue":{"properties":{"type":{"enum":["STRING"],"type":"string"}},"required":["type"],"title":"RecordableAttributeValidationsAllowedValue","type":"object","description":"RecordableAttributeValidationsAllowedValue"},"ScanningRuleConfiguration":{"description":"Configuration to show the client how the items should be scanned during picking","properties":{"values":{"items":{"$ref":"#/components/schemas/ScanningRuleValue"},"type":"array"}},"title":"ScanningRuleConfiguration"},"ScanningRuleValue":{"properties":{"priority":{"description":"This field allows you to rank scanningRuleType against each other. The lowest number is the most preferable.","minimum":0,"type":"number"},"scanningRuleType":{"$ref":"#/components/schemas/ScanningRuleTypeEnum"}},"required":["priority","scanningRuleType"],"type":"object","title":"ScanningRuleValue","description":"ScanningRuleValue"},"ScanningRuleTypeEnum":{"description":"Type of scanning rule","enum":["ARTICLE","LOCATION"],"type":"string","title":"ScanningRuleTypeEnum"},"AvailableUntilDefinition":{"properties":{"calculationBase":{"$ref":"#/components/schemas/AvailableUntilCalculationBase"},"modifier":{"description":"Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"}},"required":["calculationBase"],"title":"AvailableUntilDefinition","description":"AvailableUntilDefinition"},"AvailableUntilCalculationBase":{"description":"The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result","enum":["EXPIRY","CREATION"],"type":"string","xml":{"name":"AvailableUntilCalculationBase"},"title":"AvailableUntilCalculationBase"},"StockInformationForCreation":{"deprecated":true,"description":"@deprecated This object is deprecated since 30th of November 2023. This object carries information about the current stock of this listing.","properties":{"reserved":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 8th of February 2023.\nReserved can't be overridden by the API, because its internally now handled by open PickJobs (or other upcoming ways to reserve Stock)\nAny Value provided will be ignored upon arrival.","minimum":0,"multipleOf":1,"type":"number"},"stock":{"description":"This the amount of the given article that is in stock for the given facility","minimum":0,"multipleOf":1,"type":"number"}},"required":["stock"],"type":"object","title":"StockInformationForCreation"},"StockPropertyDefinition":{"properties":{"defaultValue":{"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.","type":"string"},"inputType":{"$ref":"#/components/schemas/StockPropertyInputType"},"required":{"description":"Indicates if this property is required.","type":"boolean"}},"required":["inputType","required"],"type":"object","title":"StockPropertyDefinition","description":"StockPropertyDefinition"},"StockPropertyInputType":{"description":"Input Type for this property, used for clients.","enum":["DATE","TEXT"],"type":"string","title":"StockPropertyInputType"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"Listing":{"allOf":[{"$ref":"#/components/schemas/ListingForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"facilityId":{"description":"This is a reference to a facility","type":"string"},"id":{"type":"string"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStock"},"type":"array"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttribute"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead."}},"required":["status","facilityId","id"],"type":"object"}],"xml":{"name":"Listing"},"title":"Listing","description":"Listing"},"ListingForCreation":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"attributes":{"items":{"$ref":"#/components/schemas/ListingAttributeItem"},"maxItems":40,"type":"array"},"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe","deprecated":true,"description":"@deprecated This property (for OutOfStockBehaviour.BACKORDER) is deprecated since 26th of February 2025."},"categoryRefs":{"description":"References to categories the listing belongs to.","items":{"type":"string"},"maxItems":10,"type":"array"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).","nullable":true,"type":"string"},"customAttributes":{"description":"Attributes that can be added to the listing. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"legal":{"$ref":"#/components/schemas/ListingLegal"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockBehaviourByContexts":{"description":"The OutOfStockBehaviourByContexts is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","items":{"$ref":"#/components/schemas/OutOfStockBehaviourByContext"},"maxItems":10,"minItems":1,"type":"array"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig","description":"The outOfStockConfig is in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />"},"partialStocks":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead.","items":{"$ref":"#/components/schemas/PartialStockForCreation"},"type":"array"},"price":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/ListingRecordableAttributeForCreation"},"maxItems":40,"type":"array"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"type":"array"},"scanningRule":{"$ref":"#/components/schemas/ScanningRuleConfiguration"},"stockAvailableUntil":{"$ref":"#/components/schemas/AvailableUntilDefinition"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation","deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />@deprecated This field is deprecated since 11th of September 2023.\nUse /api/stocks endpoints instead."},"stockProperties":{"additionalProperties":{"$ref":"#/components/schemas/StockPropertyDefinition"},"type":"object"},"tenantArticleId":{"description":"This is a reference to an article Id","minLength":1,"type":"string"},"title":{"description":"a title describing the article","minLength":1,"type":"string"},"weight":{"deprecated":true,"description":"This part of the API is deprecated. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Use attributes instead (see article attributes: https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)","minimum":0,"type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"minItems":0,"type":"array"}},"required":["tenantArticleId"],"type":"object","xml":{"name":"ListingForCreation"},"title":"ListingForCreation","description":"ListingForCreation"},"OutOfStockBehaviourByContext":{"additionalProperties":false,"properties":{"context":{"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.\nFor details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context\" target=\"_blank\">context documentation</a>.","items":{"$ref":"#/components/schemas/OutOfStockBehaviourContext","maxItems":5,"minItems":1},"type":"array"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"outOfStockConfig":{"$ref":"#/components/schemas/OutOfStockConfig"},"priority":{"description":"This value gives the priority in the respective OutOfStockBehaviourByContexts. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. The priority can be used to order OutOfStockBehaviourByContexts.","format":"int32","maximum":1000,"minimum":1,"type":"integer"}},"required":["outOfStockBehaviour","context","priority"],"type":"object","title":"OutOfStockBehaviourByContext","description":"OutOfStockBehaviourByContext"},"OutOfStockBehaviourContext":{"additionalProperties":false,"description":"The context of the outOfStockBehaviour. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","properties":{"operator":{"$ref":"#/components/schemas/ContextOperator"},"type":{"$ref":"#/components/schemas/OutOfStockBehaviourContextType"},"values":{"description":"The values of the context. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","items":{"maxItems":100,"minItems":0,"type":"string"},"type":"array"}},"required":["type","values"],"type":"object","title":"OutOfStockBehaviourContext"},"ContextOperator":{"description":"The operator used to define how the context values are evaluated or compared.","enum":["NOT"],"type":"string","title":"ContextOperator"},"OutOfStockBehaviourContextType":{"description":"The context type of the OutOfStockBehaviourContext. This is used to determine the conditions under which the outOfStockBehaviour can be applied.","enum":["FACILITY_GROUP","TAG_REFERENCE"],"type":"string","title":"OutOfStockBehaviourContextType"},"PartialStockForCreation":{"additionalProperties":false,"properties":{"location":{"$ref":"#/components/schemas/Location"},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array"},"stockinformation":{"$ref":"#/components/schemas/StockInformationForCreation"},"tenantPartialStockId":{"description":"The id associated with the partial stock","type":"string"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStockForCreation","description":"PartialStockForCreation"},"Location":{"properties":{"locationRef":{"description":"The id of the location","type":"string"},"scannableCodes":{"description":"Represents barcodes that may be scanned at this location","items":{"type":"string"},"maxItems":50,"type":"array"}},"xml":{"name":"Location"},"title":"Location","description":"Location"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"PartialStock":{"allOf":[{"$ref":"#/components/schemas/PartialStockForCreation"}],"properties":{"eventLastModified":{"description":"The date when the inventory domain comunicated a change in this partial stock","format":"date-time","type":"string"},"stockinformation":{"$ref":"#/components/schemas/StockInformation"}},"required":["tenantPartialStockId","stockinformation"],"type":"object","xml":{"name":"PartialStock"},"title":"PartialStock","description":"PartialStock"},"StockInformation":{"allOf":[{"$ref":"#/components/schemas/StockInformationForCreation"},{"properties":{"available":{"description":"The actual available amount for this stock","minimum":0,"multipleOf":1,"type":"number"},"reserved":{"minimum":0,"multipleOf":1,"type":"number"}}}],"description":"@deprecated This object is deprecated since 11th of September 2023.","required":["available"],"type":"object","title":"StockInformation"},"ListingRecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"$ref":"#/components/schemas/LocaleString"},"key":{"description":"Calculated value from keyLocalized based on passed locale","type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/RecordableAttributeValidation"},"maxItems":1,"minItems":0,"type":"array"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"ListingRecordableAttribute","type":"object","description":"ListingRecordableAttribute"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/listings/{tenantArticleId}":{"patch":{"description":"","operationId":"patchFacilityListing","parameters":[{"description":"ID of facility you want to patch a listing of. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"tenant ID of the articles listing you want to patch","in":"path","name":"tenantArticleId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingPatchActions"}}},"description":"listings for put","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Listing"},"type":"array"}}},"description":"Facility listing was found and successfully patched"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility listing not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Listing version conflict"}},"summary":"Update listing","tags":["Listings"]}}}}
```

## DELETE /api/facilities/{facilityId}/listings/{tenantArticleId}

> Delete listing

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read facility listings.","name":"Listings"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/listings/{tenantArticleId}":{"delete":{"description":"","operationId":"deleteFacilityListing","parameters":[{"description":"ID of facility you want to delete a listing of. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"tenant ID of the articles listing you want to delete","in":"path","name":"tenantArticleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Facility listing was found and successfully deleted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility listing not found"}},"summary":"Delete listing","tags":["Listings"]}}}}
```


# Articles

Every line item of the fulfillmenttools order and the operative entities, like pick jobs or pack jobs, contains an article. This article contains all the basic information about the product of this line item, like a `title`, the identifier `tenantArticleId` or an `imageUrl`. The line item itself holds all meta information, like the ordered amount for an order or the picked amount for a pick job.

{% hint style="warning" %}
Articles are not a separate entity in fulfillmenttools. They're part of a line item, and this line item is part of, for example, an order, pick job, or handover job.
{% endhint %}

## How is the article used?

The article identifies the line item comprehensively within the fulfillmenttools platform. It will be used for routing decisions or reservations. Using the `tenantArticleId`, it's possible to determine, for example, which order line item a pick job line item originated from.

### Facts

* Listings with the same `tenantArticleId` might hold different information about the (same) product.
* Note the difference between articles and [listings](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing).

### Example

In this example, fulfillmenttools receives an order, and we make a decision in which facility the order is routed. For this, the `tenantArticleId` within `article` is important.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F6D0BMyAzBheLAfsKhBhZ%2FUntitled-2025-12-22-0836.png?alt=media&amp;token=7f0db30e-2e0e-4c52-b68d-037db2bf9827" alt="" width="375"><figcaption></figcaption></figure>

1. An `order` with a line item arrives at fulfillmenttools. The line item is an apple and contains the `article` with the `tenantArticleId 4711`.
2. Facility A has apples but with the `tenantArticleId 0815`, this is the wrong facility for this order.
3. Facility B contains the right apples with the `tenantArticleId 4711`, the order will be routed into Facility B.
4. For Facility B a pick job was created. All the information from the article in the order line item will be taken and enriched by the information from the listing.


# Article attributes

fulfillmenttools uses article `attributes` to customize processes and enhance the display of information in client applications (Backoffice, Store Operations app, and so on).

{% hint style="warning" %}
**Attention:** `attributes` aren't the same as [`customAttributes`](https://docs.fulfillmenttools.com/documentation/getting-started/custom-attributes).
{% endhint %}

**Example entry of the `attributes` model:**

```json
{
    "category": "descriptive",
    "type": "STRING",
    "priority": 100,
    "key": "Farbe", // This field is read-only
    "keyLocalized": {
        "de_DE": "Farbe",
        "en_US": "Color"
    },
    "value": "Blau",
    "valueLocalized": {
        "de_DE": "Blau",
        "en_US": "Blue"
    }
}
```

The `priority` property sorts the attributes in a client application. The allowed value ranges from `1` (highest priority) to `1000` (lowest priority). The default value is `1001`.

## Supported categories

<table><thead><tr><th width="303">Category</th><th>Comment</th></tr></thead><tbody><tr><td><code>descriptive</code></td><td>The <code>key</code> and <code>value</code> are shown in fulfillmenttools clients, such as Backoffice. This category can enhance the displayed data to simplify data processing.</td></tr><tr><td><code>pickingSequence</code></td><td>Defines the sequence in which line items are ordered during picking.</td></tr><tr><td><code>miscellaneous</code> (default)</td><td>The fulfillmenttools clients don't currently use this category, except for the <code>BRAND</code> key.</td></tr><tr><td><code>customs</code></td><td>Includes keys such as <code>valuePerUnit</code>, <code>hsCode</code>, and <code>currency</code>. Other keys are also possible for this attribute.</td></tr><tr><td><code>insurance</code></td><td>Defines insurance-related data and can include keys such as <code>valuePerUnit</code> and <code>currency</code>.</td></tr><tr><td><code>shop</code></td><td>Defines the customer shop price and can include keys such as <code>valuePerUnit</code> and <code>currency</code>.</td></tr><tr><td><code>dimensions</code></td><td>Defines dimensions and includes keys such as <code>weightPerUnit</code>, <code>height</code>, <code>width</code>, and <code>length</code>. It's recommended to use the smallest unit as separators aren't permitted. Consistency in unit selection across all articles is required to enable meaningful comparisons.</td></tr><tr><td><code>salesPrice</code></td><td>Defines the price at which supplier facilities sell the listing to other facilities in the network.</td></tr></tbody></table>

{% hint style="info" %}
For the categories `customs`, `insurance`, `shop`, `salesPrice`, and `dimensions`, the `type` field is mandatory. The `type` can be `CURRENCY` ([ISO-4217](https://en.wikipedia.org/wiki/ISO_4217)), `NUMBER`, or `STRING`. For all other categories, the `type` field is optional.
{% endhint %}

## Special categories

### Category dimensions

{% hint style="warning" %}
It's recommended to use the smallest unit as separators aren't permitted. Consistency in unit selection across all articles is required to enable meaningful comparisons.
{% endhint %}

<table data-full-width="true"><thead><tr><th width="249.75">Parameter</th><th>Example</th></tr></thead><tbody><tr><td><strong>Weight</strong> of a single item</td><td><pre class="language-json"><code class="lang-json"><strong>{
</strong>  "category": "dimensions",
  "key":"weightPerUnit",
  "value":"&#x3C;the weight of a single item>",
  "type":"NUMBER"
}
</code></pre></td></tr><tr><td><strong>Height</strong> of a single item</td><td><pre class="language-json"><code class="lang-json">{
  "category": "dimensions",
  "key":"height",
  "value":"&#x3C;the height of a single item>",
  "type":"NUMBER"
}
</code></pre></td></tr><tr><td><strong>Width</strong> of a single item</td><td><pre class="language-json"><code class="lang-json">{
  "category": "dimensions",
  "key":"width",
  "value":"&#x3C;the width of a single item>",
  "type":"NUMBER"
}
</code></pre></td></tr><tr><td><strong>Length</strong> of a single item</td><td><pre class="language-json"><code class="lang-json">{
  "category": "dimensions",
  "key":"length",
  "value":"&#x3C;the length of a single item>",
  "type":"NUMBER"
}
</code></pre></td></tr></tbody></table>

### Category sales price

Users can only supply sales prices to fulfillmenttools via listing attributes. The sales price is particularly relevant for [facilities with a type supplier](https://docs.fulfillmenttools.com/documentation/getting-started/facilities#supplier-facilities). These facilities sell or deliver articles to other facilities. Therefore, it might be necessary to define the price at which these supplier facilities sell their listings to other facilities or facility groups.

In addition, sales prices can also be defined based on tags applied to an order. This allows suppliers to configure different prices depending on the sales channel, customer segment, or any other order‑level context represented by a tag. When an order carries a specific tag, fulfillmenttools can automatically select and apply the corresponding `salesPrice`. This enables suppliers to manage channel‑specific or conditional pricing without maintaining multiple separate listings.

{% hint style="info" %}
An example of creating a listing with a sales price is available in the [Sales price with currency](#sales-price-with-currency) example.
{% endhint %}

Attributes with the category `salesPrice`:

* Can only contain the following keys: `valuePerUnit`, `currency`, and `numberOfDecimalPlaces`.
* The `valuePerUnit` key:
  * This key is mandatory.
  * Its `value` defines the fallback `salesPrice` if no `context` is defined, or the `salesPrice` for the respective facility or facility group if a `context` is defined. The value must not contain commas or dots. If the `numberOfDecimalPlaces` key is not defined, the system uses the default value stored for the respective currency. For example, a value of "400" with a `numberOfDecimalPlaces` of "2" would be interpreted as "4.00".
  * Its `priority` describes the hierarchy (from low to high) in which the system applies the configured prices. The priority must be unique for the `valuePerUnit` key across all attributes with the `salesPrice` category per listing.
* The `currency` key:
  * This key is mandatory.
  * It defines the currency the listing is sold in. If there are multiple currencies for different facilities or facility groups, multiple currency attributes with `contexts` must be defined.
  * It must have unique `key` and `context.value` pairs.
* The `numberOfDecimalPlaces` key:
  * This key is optional. If it is not defined, fulfillmenttools uses the default value stored for the respective currency.
  * To apply a different number of decimal places per currency or facility (or facility group), a context must be defined.

{% hint style="warning" %}
It's not possible to configure multiple sales prices for the same facility or facility group.
{% endhint %}

## Special keys

Special keys are predefined keys that have a special function in fulfillmenttools.

<table><thead><tr><th width="303">Key</th><th>Comment</th></tr></thead><tbody><tr><td><code>%%subtitle%%</code></td><td>Can be used in the context of the <code>descriptive</code> category to show the attribute directly below the line item in fulfillmenttools clients.</td></tr><tr><td><code>BRAND</code></td><td>Can be used to add information about the article's brand. This allows users to filter and search by brand in Backoffice. It's used in the context of the <code>miscellaneous</code> category.</td></tr></tbody></table>

## Article attribute inheritance

Entities inherit article attributes upon their creation within fulfillmenttools. When a user supplies article attributes to order line items, all subsequent entities inherit these attributes. If a user also supplies article attributes to listings, fulfillmenttools uses these as a fallback.

{% hint style="warning" %}
**Limitations**

Each `attributes` object has a character limit of 15,360 characters because fulfillmenttools serializes the entire object as a string. This corresponds to approximately 15 attribute objects with around 1024 characters each. The fulfillmenttools API returns an `HTTP 400` error code if a user attempts to create or update an entity that exceeds this limit.
{% endhint %}

## Examples

### Shop price with currency

The shop price defines the customer-facing price of an article. The attributes array accepts `valuePerUnit` and `currency` keys within the shop category. If no number of decimal places is defined, the default is 2.\
In the example below, the article costs 13.37 EUR.

{% hint style="info" %}
Other categories, such as `insurance` and `customs`, follow the same structure.
{% endhint %}

```json
{
...
    "orderLineItems": [
        {
            "quantity": 2,
            "tenantArticleId": "111112233",
            "title": "T-Shirt",
            "imageUrl": "https://loremflickr.com/320/240/shirt",
            "attributes": [
                {
                    "key": "valuePerUnit",
                    "category": "shop",
                    "type": "NUMBER",
                    "value": "1337"
                },
                {
                    "key": "currency",
                    "category": "shop",
                    "type": "CURRENCY",
                    "value": "EUR"
                }
            ]
        }
    ],
...    
}
```

### Subtitles and descriptive attributes

When creating a listing or an order, users can add attributes on the article.

The following example shows attributes being added to a listing on creation, and the second tab shows a line item with a subtitle and further product information. The `%%subtitle%%` will always show in the first position.

In this case, the item code would be shown as the subtitle in the [Store Operations app](https://docs.fulfillmenttools.com/documentation/apps/store-operations-app) as shown below:

{% tabs %}
{% tab title="Listing code example" %}

<pre class="language-json"><code class="lang-json">{
    "listings": [
        {
            "tenantArticleId": "111222333",
            "title": "Oversized Heavyweight Sweatshirt",
            "imageUrl": "https://loremflickr.com/320/240/sweatshirt",
            "attributes": [
                {
                    "key": "%%subtitle%%",
<strong>                    "value": "7718881",
</strong>                    "category": "descriptive"
                },
                {
                    "key": "Color",
                    "value": "White melange",
                    "category": "descriptive"
                },
                {
                    "key": "valuePerUnit",
                    "category": "shop",
                    "type": "NUMBER",
                    "value": "12000"
                },
                {
                    "key": "currency",
                    "category": "shop",
                    "type": "CURRENCY",
                    "value": "EUR"
                },
                {
                    "key": "Size",
                    "value": "Medium",
                    "category": "descriptive"
                }
            ]
        }
    ]
}     
</code></pre>

{% endtab %}

{% tab title="Order code example" %}

```json
{
...
    "orderLineItems": [
        {
            "quantity": 2,
            "article": {
                "tenantArticleId": "111222333",
                "title": "Oversized Heavyweight Sweatshirt",
                "attributes": [
                    {
                        "key": "%%subtitle%%",
                        "value": "7718881",
                        "category": "descriptive"
                    },
                    {
                        "key": "Color",
                        "value": "White melange",
                        "category": "descriptive"
                    },
                    {
                        "key": "Size",
                        "value": "Medium",
                        "category": "descriptive"
                    }
                ]
            }
        }    
    ],
...
}
```

{% endtab %}
{% endtabs %}

<div><figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fyg8UJySXRyUFfoyvgJA8%2FPicking-SOP-Subtitle-portrait.png?alt=media&amp;token=686d7b3e-2d00-4ed4-8e84-07f42e8e412e" alt="Example of article attributes displayed in a client interface" width="188"><figcaption></figcaption></figure> <figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FGib4ffaC8QAiAR4o9jDi%2FPicking-01-portrait.png?alt=media&amp;token=c904566b-9c02-4b8d-a3c0-0a28a0006da9" alt="" width="188"><figcaption></figcaption></figure></div>

### Sales price with currency

In this example, a user creates a listing in a supplier facility along with sales prices and respective currencies. The code sample reflects the values described in the table below:

| Facility or Facility group | Sales price | Priority |
| -------------------------- | ----------- | -------- |
| Fallback                   | 4.00 EUR    | -        |
| Facility GB                | 2.00 GBP    | 700      |
| Facility group CH          | 3.00 CHF    | 500      |

```http
PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/facilities/{facilityId}/listings
```

```json
{
  "listings": [
    {
      "tenantArticleId": "4711",
      "title": "Adidas Superstar",
      "attributes": [
        {
          "key": "valuePerUnit",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "400"
        },
        {
          "key": "currency",
          "category": "salesPrice",
          "type": "CURRENCY",
          "value": "EUR"
        },
        {
          "key": "numberOfDecimalPlaces",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "2"
        },
        {
          "key": "valuePerUnit",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "300",
          "priority": 500,
          "context": {
            "type": "FACILITY_GROUP",
            "value": "uuid-facility-group-ch"
          }
        },
        {
          "key": "currency",
          "category": "salesPrice",
          "type": "CURRENCY",
          "value": "CHF",
          "context": {
            "type": "FACILITY_GROUP",
            "value": "uuid-facility-group-ch"
          }
        },
        {
          "key": "numberOfDecimalPlaces",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "2",
          "context": {
            "type": "FACILITY_GROUP",
            "value": "uuid-facility-group-ch"
          }
        },
        {
          "key": "valuePerUnit",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "200",
          "priority": 700,
          "context": {
            "type": "FACILITY",
            "value": "uuid-facility-gb"
          }
        },
        {
          "key": "currency",
          "category": "salesPrice",
          "type": "CURRENCY",
          "value": "GBP",
          "context": {
            "type": "FACILITY",
            "value": "uuid-facility-gb"
          }
        },
        {
          "key": "numberOfDecimalPlaces",
          "category": "salesPrice",
          "type": "NUMBER",
          "value": "2",
          "context": {
            "type": "FACILITY",
            "value": "uuid-facility-gb"
          }
        }
      ]
    }
  ]
}
```


# Stock

Stock represents items in a facility and includes information on how much of a product is present, along with metadata and operational data.

Stock is linked to a listing, which contains information about the item's attributes within the facility. Stock tracks only stock-specific information, which differs by item, such as expiry dates or storage locations.

Stock can technically exist without listings. However, we strongly recommend always creating listings for two reasons:

* Listings are required for order routing, as they contain data relevant to routing processes.
* Listings provide the corresponding product information to be displayed in the fulfillmenttools clients.

## Description of stock

Stock represents one or more items with the exact same attributes, for example, items with the same expiry date, lying in the same storage location. You can merge two stocks if all information on the respective stocks is identical, adding up their amounts. However, fulfillmenttools still allows having two separate stocks with identical attributes.

The example below shows a listing with `tenantArticleId` `9999`. Because the stocks for that item are first distributed across two locations and second have different attributes, three stocks were created.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/n6gKwlP7y59QkqrqI31F/image.png" alt=""><figcaption></figcaption></figure>

### Stock properties

Attributes that are relevant for operational processes are handled via [stock properties](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties). Common examples include values such as expiry date or batch number.

### Stock receipt date

The receipt date represents the time and date when stock enters a facility. You can use this information for various purposes, for example, to ensure that picking follows a first-in, first-out strategy. This ensures the timestamp is set when the stock is accepted in the inbound process and not changed afterward.

When the stock is created via [stocks REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stocks), the integration layer must provide the correct time point. If no `receiptDate` is provided, fulfillmenttools defaults to the moment when the stock is created.

### Stock deletion

fulfillmenttools automatically deletes a stock entity when the following conditions are met:

* The stock value reaches `0`.
* The `KEEP_ON_ZERO` [trait](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits) is inactive on the stock (default behavior).

If reservations exist on a stock and the stock value reaches `0` without `KEEP_ON_ZERO` being active, the stock is no longer returned via the fulfillmenttools APIs. The reservation remains tracked in the system and is assigned to a suitable stock as soon as one becomes available.

### Stocks with amount 0

The fact that there is no stock left for an item in a facility can be represented in two ways:

1. Having no stock entities
2. Having stock entities with amount `0`

Stock with amount `0` that's assigned to a storage location can be used to indicate that the product should always be stored there. This is helpful, for example, when using the [Store Operations app](https://docs.fulfillmenttools.com/documentation/apps/store-operations-app) for picking or the [Inventory app](https://docs.fulfillmenttools.com/documentation/apps/inventory-app), including [storage location recommendations](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones#storage-location-recommendations). If stock is set to `0`, fulfillmenttools will remove the stock entity by default. This can be prevented by adding the [trait](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits) `KEEP_ON_ZERO` to a storage location.

### Stock condition

Stock may be delivered to a facility defective or damaged during storage. In that case, the stock condition can be set to `DEFECTIVE`. Before setting a stock's condition to defective, it must first be marked as not [pickable](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits#available-traits) and not [accessible](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits#available-traits). This ensures that the defective stock is no longer considered for sales processes. If rejected items are accepted during goods [receipt](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process/receipts), fulfillmenttools automatically marks the stock as defective and labels it as not pickable and not accessible.

## Using stock endpoints

### Create stock

{% hint style="success" %}

#### Prerequisites

* Have at least one [facility](https://docs.fulfillmenttools.com/documentation/getting-started/facilities) created. Stock is always related to a specific facility.
  {% endhint %}

To create stock, use the stocks endpoint and `POST` the amount of stock for each article for each facility:

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/stocks
```

{% endtab %}

{% tab title="Request" %}

```json
{
    "facilityRef": "{YOUR_FACILITY_REF}",
    "tenantArticleId": "SNEAK-W-4891",
    "value": 100,
    "properties": {
        "batch": "0-1-2-3",
        "expiry": "2026-08-17T09:39:28.966Z"
    }
}
```

{% endtab %}

{% tab title="Response" %}
After creating the stock, we receive a `201 CREATED` response:

```json
{
    "created": "2024-02-02T10:27:55.154Z",
    "facilityRef": "d286e108-698b-4f6c-97b7-21f090f17e46",
    "id": "33fb7ef6-47b5-4fd7-ac07-584293d84af3",
    "lastModified": "2024-02-02T10:27:55.154Z",
    "tenantArticleId": "BLAZER-G-6354",
    "value": 100,
    "scannableCodes": [],
    "scores": [
        {
            "type": "RATING",
            "name": "RECEIPT_DATE",
            "value": 3255
        }
    ],
    "reserved": 0,
    "facilityWideReserved": 0,
    "available": 100,
    "traits": [
        "PICKABLE",
        "ACCESSIBLE"
    ],
    "properties": {
        "batch": "0-1-2-3",
        "expiry": "2023-08-17T09:39:28.966Z"
    },
    "serializedProperties": "{}",
    "receiptDate": "2024-02-02T10:27:55.136Z",
    "version": 1
}
```

{% endtab %}
{% endtabs %}

Besides some other properties, you might have noticed `reserved` and `facilityWideReserved`. When a pick job inside the facility needs this stock or article, the stock will be reserved until it is picked. When the item is picked, the reservation is removed, and the stock amount is decreased.

### Bulk stock create or update <a href="#inventory-stock-sync" id="inventory-stock-sync"></a>

When updating stock, it's recommended to use the bulk `PUT` endpoint to regularly push stock level updates by SKU (`tenantArticleId`) and facility while minimizing the number of calls.

In the following example, all stocks of `tenantArticleId` 4711 are updated.

{% hint style="info" %}
The stock version and ID must be sent for an update. Otherwise, a new stock is created.
{% endhint %}

{% stepper %}
{% step %}
**Search stock for obtaining the ID and version**

To obtain the IDs and version of all the stock that exists for an item, use the stock search endpoint for the respective `tenantArticleId`.

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/stocks/search
```

{% endtab %}

{% tab title="Request" %}

```json
{
  "query": {
    "tenantArticleId": {
      "eq": "4711"
    }
  }
}
```

{% endtab %}
{% endtabs %}

When stock should be updated per facility, the `facilityRef` must be included in the search query.

{% hint style="info" %}
You may need to iterate over multiple pages to retrieve all stocks with the corresponding `tenantArticleId`. See the [Pagination](https://docs.fulfillmenttools.com/documentation/getting-started/general-concepts#pagination) section for more information.
{% endhint %}
{% endstep %}

{% step %}
**Update stock**

To update stock, use the endpoint in the first tab. An example request and response are shown in the following tabs.

You can use the endpoint to create and update stock (see the different input models).

Note that an `id` and `version` are required to update stock, as multiple stocks can exist for the same SKU and facility.

{% tabs %}
{% tab title="Endpoint" %}

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/stocks
```

{% endtab %}

{% tab title="Request" %}

```json
{
  "stocks": [
    {
      "id": "{YOUR_STOCK_ID_1}",
      "value": 100,
      "version": 6
    },
    {
      "id": "{YOUR_STOCK_ID_2}",
      "value": 300,
      "version": 6
    },
    {
      "id": "{YOUR_STOCK_ID_3}",
      "locationRef": "SL-01",
      "properties": {
        "expiry": "2027-01-01T00:00:00.000Z"
      },
      "value": 200,
      "version": 6
    }
  ]
}
```

{% endtab %}

{% tab title="Response" %}
After creating the stock, a `200 OK` response and the status `UPDATED` indicate a successful update.

The response includes additional fields that are automatically set. For example, `receiptDate` is automatically set to the stock's creation date. The `traits` automatically default to `PICKABLE` and `ACCESSIBLE`, meaning that the stock will be available for incoming orders.

```json
[
    {
        "stock": {
            "created": "2025-11-06T13:11:35.738Z",
            "facilityRef": "{YOUR_FACILITY_REF}",
            "id": "{YOUR_STOCK_ID}",
            "lastModified": "2025-11-26T07:54:35.624Z",
            "tenantArticleId": "{YOUR_TENANT_ARTICLE_ID}",
            "value": 100,
            "locationRef": null,
            "scannableCodes": [],
            "scores": [
                {
                    "type": "RATING",
                    "name": "RECEIPT_DATE",
                    "value": 2602
                }
            ],
            "tenantStockId": null,
            "reserved": 0,
            "facilityWideReserved": 0,
            "available": 111,
            "traits": [
                "PICKABLE",
                "ACCESSIBLE"
            ],
            "traitConfig": null,
            "conditions": null,
            "properties": {},
            "serializedProperties": "{}",
            "receiptDate": "2025-11-16T07:46:16.215Z",
            "version": 7,
            "customAttributes": null,
            "availableUntil": null,
            "facility": {
                "facilityRef": "{YOUR_FACILITY_REF}"
            }
        },
        (...),
        "status": "UPDATED"
    }
]
```

{% endtab %}
{% endtabs %}
{% endstep %}
{% endstepper %}

### Versionless stock creation or updates

The `UPDATE_VERSIONLESS` action in the [stock actions](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-endpoints#post-api-stocks-actions) enables versionless creation or update of stock quantities. This lets you update operations without first retrieving the current stock version, reducing the total number of API calls.

The action:

* Supports a maximum of 25 stock entries in a single request.
* Executes with an all-or-nothing behavior. The request succeeds only if all stock records are processed.
* Supports two operation types:
  * [`CREATE`](#create-versionless-stock): Creates a new stock record for a specific `tenantArticleId` and `facilityRef`.
  * [`UPDATE`](#update-versionless-stock): Updates an existing stock record identified by the stock `id`.

#### Create versionless stock

To create versionless stock, use the endpoint in the first tab. An example request and response are shown in the following tabs.

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/stocks/actions
```

{% endtab %}

{% tab title="Request" %}

```json
{
  "action": {
    "name": "UPDATE_VERSIONLESS",
    "stocks": [
      {
        "tenantArticleId": "Article-123", 
        "value": 20,
        "operationType": "CREATE",
        "facilityRef": "CGN-01"
      }
    ]
  }
}
```

{% hint style="info" %}
This example request use minimal information. You can add more fields than this. See the [actions endpoint](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-endpoints#post-api-stocks-actions) for more details.
{% endhint %}
{% endtab %}

{% tab title="Response" %}

```json
{
    "name": "UPDATE_VERSIONLESS",
    "result": {
        "operationResults": [
            {
                "stock": {
                    "created": "2026-11-16T13:54:39.601Z",
                    "facilityRef": "{YOUR_FACILITY_REF}",
                    "id": "{YOUR_STOCK_ID}",
                    "lastModified": "2026-11-16T13:54:39.601Z",
                    "tenantArticleId": "Article-123",
                    "value": 20,
                    "reserved": 0,
                    "facilityWideReserved": 0,
                    "available": 20,
                    "traits": [
                        "PICKABLE",
                        "ACCESSIBLE"
                    ],
                    "receiptDate": "2026-11-16T13:54:39.586Z",
                    "version": 1,
                    "facility": {
                        "facilityRef": "{YOUR_FACILITY_REF}",
                        "tenantFacilityId": null
                    }
                },
                "status": "CREATED"
            }
        ]
    }
}
```

{% endtab %}
{% endtabs %}

#### Update versionless stock

To update versionless stock, use the endpoint in the first tab. An example request and response are shown in the following tabs.

{% hint style="info" %}
You can also update stock that already has a version number using this endpoint.
{% endhint %}

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/stocks/actions
```

{% endtab %}

{% tab title="Request" %}

```json
{
  "action": {
    "name": "UPDATE_VERSIONLESS",
    "stocks": [
      {
        "id": "stock-id-123",
        "value": 20,
        "operationType": "UPDATE"
      }
    ]
  }
}
```

{% hint style="info" %}
This example request uses minimal information. You can add more fields than this. See the [actions endpoint](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-endpoints#post-api-stocks-actions) for more details.
{% endhint %}
{% endtab %}

{% tab title="Response" %}

```json
{
    "name": "UPDATE_VERSIONLESS",
    "result": {
        "operationResults": [
            {
                "stock": {
                    "created": "2026-11-16T13:54:39.601Z",
                    "facilityRef": "{YOUR_FACILITY_REF}",
                    "id": "{YOUR_STOCK_ID}",
                    "lastModified": "2026-11-16T13:56:04.196Z",
                    "tenantArticleId": "Article-123",
                    "value": 20,
                    "reserved": 0,
                    "facilityWideReserved": 0,
                    "available": 20,
                    "traits": [
                        "PICKABLE",
                        "ACCESSIBLE"
                    ],
                    "receiptDate": "2026-11-16T13:54:39.586Z",
                    "version": 2,
                    "facility": {
                        "facilityRef": "{YOUR_FACILITY_REF}",
                        "tenantFacilityId": null
                    }
                },
                "status": "UPDATED"
            }
        ]
    }
}
```

{% endtab %}
{% endtabs %}

The response format matches the [stock upsert API ](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-endpoints#put-api-stocks)structure.

### Delete stock

To delete stock by product, location, or ID, use the stock actions endpoint:

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/stocks/actions
```

* To delete all stocks for a product in a facility, use the `DELETE_BY_PRODUCTS` action.
* To delete all stocks on a storage location in a facility, use the `DELETE_BY_LOCATIONS` action.
* To delete multiple stocks in a facility in one call, use the `DELETE_BY_IDS` action.

### Move stock to location

To move stock to a location, use the action `MOVE_TO_LOCATION`.

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/stocks/actions
```

Note: In the action `options`, `deleteFromStockIfZero` is available. If set to `true`, the stock at the start location is deleted when the value reaches `0` after the move action completes (even when the `KEEP_ON_ZERO` trait is active on the respective location).

### Create safety stock

The `PUT` safety stock endpoint lets us create the safety stock in a bulk operation:

{% tabs %}
{% tab title="Endpoint" %}

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/safetystocks
```

{% endtab %}

{% tab title="Request" %}

```json
{
    "operations": [
        {
            "tenantArticleId": "SNEAK-W-4891",
            "facilityRef": "d286e108-698b-4f6c-97b7-21f090f17e46",
            "value": 10
        }
    ]
}
```

{% endtab %}

{% tab title="Response" %}
The `207 MULTI-STATUS` status code indicates success, the payload shows the status for each entity:

```json
[
    {
        "tenantArticleId": "SNEAK-W-4891",
        "value": 10,
        "status": "CREATED",
        "facilityRef": "d286e108-698b-4f6c-97b7-21f090f17e46"
    }
]
```

{% endtab %}
{% endtabs %}


# Stock endpoints

## The Stock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"}}}}
```

## GET /api/stocks/{stockId}

> Get stock

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stocks/{stockId}":{"get":{"deprecated":false,"description":"","operationId":"getStock","parameters":[{"in":"path","name":"stockId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stock"}}},"description":"Stock"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Get stock","tags":["Stock"]}}}}
```

## GET /api/stocks

> List stocks

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StockPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"stocks":{"items":{"$ref":"#/components/schemas/Stock"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","stocks"],"title":"StockPaginatedResult","type":"object","description":"StockPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stocks":{"get":{"deprecated":false,"description":"","operationId":"getStocks","parameters":[{"in":"query","name":"facilityRef","required":false,"schema":{"type":"string"}},{"in":"query","name":"tenantFacilityId","required":false,"schema":{"type":"string"}},{"in":"query","name":"tenantArticleId","required":false,"schema":{"items":{"type":"string"},"maxItems":500,"type":"array"}},{"in":"query","name":"locationRef","required":false,"schema":{"items":{"type":"string"},"maxItems":500,"type":"array"}},{"description":"The number of items to return.","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"number"}},{"description":"The ID of the last item from the previous page. The next page will start after this ID.","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockPaginatedResult"}}},"description":"Stocks"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List stocks","tags":["Stock"]}}}}
```

## List stock summaries

> Get the accumulated Stock for each Article

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StockSummaries":{"properties":{"stockSummaries":{"items":{"$ref":"#/components/schemas/StockSummary"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","stockSummaries"],"title":"StockSummaries","type":"object","description":"StockSummaries"},"StockSummary":{"properties":{"article":{"$ref":"#/components/schemas/StockSummaryArticle"},"details":{"$ref":"#/components/schemas/StockSummaryDetails"},"includedFacilityRefs":{"description":"ALPHA Status!. The facilityRefs that are included in the stock summary.","items":{"type":"string"},"type":"array"}},"required":["includedFacilityRefs","article","details"],"title":"StockSummary","type":"object","description":"StockSummary"},"StockSummaryArticle":{"properties":{"imageUrl":{"type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["tenantArticleId","title"],"title":"StockSummaryArticle","type":"object","description":"StockSummaryArticle"},"StockSummaryDetails":{"properties":{"available":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","minimum":0,"type":"number"},"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"availableToPromise":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"byTrait":{"$ref":"#/components/schemas/ByTrait"},"channelAdjusted":{"items":{"$ref":"#/components/schemas/ChannelStockAvailability"},"type":"array"},"readyToPick":{"deprecated":true,"description":"This field is deprecated and replaced by new availability concepts. See https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability for more information.","type":"number"},"reserved":{"minimum":0,"type":"number"},"safetyStock":{"minimum":0,"type":"number"},"stockOnHand":{"type":"number"},"totalAmount":{"minimum":0,"type":"number"}},"required":["reserved","totalAmount","available","safetyStock","byTrait","availableForPicking","availableToPromise","readyToPick","availableOnStock","stockOnHand"],"title":"StockSummaryDetails","type":"object","description":"StockSummaryDetails"},"ByTrait":{"properties":{"ACCESSIBLE":{"type":"number"},"PICKABLE":{"type":"number"}},"required":["PICKABLE","ACCESSIBLE"],"title":"ByTrait","type":"object","description":"ByTrait"},"ChannelStockAvailability":{"properties":{"availableForPicking":{"type":"number"},"availableOnStock":{"type":"number"},"channelRef":{"type":"string"}},"required":["channelRef","availableForPicking","availableOnStock"],"title":"ChannelStockAvailability","type":"object","description":"ChannelStockAvailability"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stocks/summaries":{"get":{"deprecated":false,"description":"Get the accumulated Stock for each Article","operationId":"getStockSummaries","parameters":[{"description":"The number of items to return.","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"number"}},{"description":"The stockSummaries.article.tenantArticleId value should be used for pagination.","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"facilityGroupRefs","required":false,"schema":{"items":{"type":"string"},"maxItems":1,"type":"array"}},{"explode":false,"in":"query","name":"facilityServiceTypes","required":false,"schema":{"items":{"enum":["SHIP_FROM_STORE","PICKUP"],"type":"string"},"type":"array"}},{"explode":false,"in":"query","name":"facilityStatus","required":false,"schema":{"items":{"enum":["ONLINE","SUSPENDED","OFFLINE"],"type":"string"},"type":"array"}},{"explode":true,"in":"query","name":"facilityRefs","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"allowStale","required":false,"schema":{"type":"boolean"}},{"explode":true,"in":"query","name":"tenantArticleIds","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"description":"Returns stock summaries using adaptive batching to reduce latency spikes, as a consequence response time will have a more consistent upper bound but page size may be reduced below the maximum - This overrides `size` argument.","in":"query","name":"maxPageSize","required":false,"schema":{"maximum":100,"minimum":1,"type":"number"}},{"description":"The channels to included under \"channelAdjusted\" in the stock summary. Provide up to 50 channelRefs, specify \"UNALLOCATED for unallocated stock.\"","explode":true,"in":"query","name":"channelRefs","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockSummaries"}}},"description":"Stock summaries was loaded & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List stock summaries","tags":["Stock"]}}}}
```

## POST /api/stocks

> Create stock

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StockForCreation":{"properties":{"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"facilityRef":{"deprecated":true,"description":"facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"},{"additionalProperties":{"type":"string"},"type":"object"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantFacilityId":{"deprecated":true,"description":"tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["tenantArticleId","value"],"title":"StockForCreation","type":"object","description":"StockForCreation"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stocks":{"post":{"deprecated":false,"description":"","operationId":"createStock","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stock"}}},"description":"Stock was created."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create stock","tags":["Stock"]}}}}
```

## Update stocks

> Update and create many stocks at once

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StocksForUpsert":{"properties":{"stocks":{"description":"Please be sure to include each stock (by ID) only once, when updating. Otherwise the whole batch is rejected with an error.","items":{"oneOf":[{"$ref":"#/components/schemas/StockForCreation"},{"$ref":"#/components/schemas/StockForUpsertUpdate"},{"not":{"required":["version"]},"properties":{"id":{"type":"string"},"locationRef":{"nullable":true,"type":"string"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["id","value"],"type":"object"}]},"maxItems":500,"type":"array"}},"required":["stocks"],"title":"StocksForUpsert","type":"object","description":"StocksForUpsert"},"StockForCreation":{"properties":{"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"facilityRef":{"deprecated":true,"description":"facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"},{"additionalProperties":{"type":"string"},"type":"object"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantFacilityId":{"deprecated":true,"description":"tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["tenantArticleId","value"],"title":"StockForCreation","type":"object","description":"StockForCreation"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"StockForUpsertUpdate":{"properties":{"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"locationRef":{"nullable":true,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["value","id","version"],"title":"StockForUpsertUpdate","type":"object","description":"StockForUpsertUpdate"},"StockUpsertOperationResult":{"properties":{"status":{"enum":["UPDATED","CREATED","UNCHANGED"],"type":"string"},"stock":{"$ref":"#/components/schemas/Stock"}},"required":["stock","status"],"title":"StockUpsertOperationResult","type":"object","description":"StockUpsertOperationResult"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stocks":{"put":{"deprecated":false,"description":"Update and create many stocks at once","operationId":"upsertStocks","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StocksForUpsert"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StockUpsertOperationResult"},"type":"array"}}},"description":"Stock upsert result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Update stocks","tags":["Stock"]}}}}
```

## PUT /api/stocks/{stockId}

> Update stock

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StockForUpdate":{"properties":{"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"locationRef":{"nullable":true,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["value","version"],"title":"StockForUpdate","type":"object","description":"StockForUpdate"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stocks/{stockId}":{"put":{"deprecated":false,"description":"","operationId":"updateStock","parameters":[{"in":"path","name":"stockId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/StockForUpdate"},{"not":{"required":["version"]},"properties":{"locationRef":{"nullable":true,"type":"string"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["value"],"type":"object"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stock"}}},"description":"Stock"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Update stock","tags":["Stock"]}}}}
```

## DELETE /api/stocks/{stockId}

> Delete stock

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stocks/{stockId}":{"delete":{"deprecated":false,"description":"","operationId":"deleteStock","parameters":[{"in":"path","name":"stockId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Stock was deleted."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Delete stock","tags":["Stock"]}}}}
```

## List stocks (search)

> Search for Stock

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StockSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/StockSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/StockSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"StockSearchPayload","type":"object","description":"StockSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"StockSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StockSearchQuery"},"maxItems":500,"type":"array"},"availableUntil":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by availableUntil"},"conditions":{"allOf":[{"$ref":"#/components/schemas/StockConditionEnumListFilter"}],"description":"Search by conditions"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"locationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by locationRef"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StockSearchQuery"},"maxItems":500,"type":"array"},"properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/DateFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by properties","type":"object"},"receiptDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by receiptDate"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"tenantFacilityId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"tenantFacilityId is handled like facilityRef filter, if you want to search by both you should wrap that filter in an \"or\" filter"},"tenantStockId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantStockId"},"traits":{"allOf":[{"$ref":"#/components/schemas/StockStorageLocationTraitEnumListFilter"}],"description":"Search by traits"},"value":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by value"}},"title":"StockSearchQuery","type":"object","description":"StockSearchQuery"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StockConditionEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StockConditionEnumFilter"}],"description":"Search by conditions"}},"title":"StockConditionEnumListFilter","type":"object","description":"StockConditionEnumListFilter"},"StockConditionEnumFilter":{"properties":{"eq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"},"in":{"description":"Search by conditions","items":{"enum":["DEFECTIVE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by conditions","enum":["DEFECTIVE"],"type":"string"}},"title":"StockConditionEnumFilter","type":"object","description":"StockConditionEnumFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StockStorageLocationTraitEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StockStorageLocationTraitEnumFilter"}],"description":"Search by traits"}},"title":"StockStorageLocationTraitEnumListFilter","type":"object","description":"StockStorageLocationTraitEnumListFilter"},"StockStorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StockStorageLocationTraitEnumFilter","type":"object","description":"StockStorageLocationTraitEnumFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StockSort":{"properties":{"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"locationName":{"enum":["ASC","DESC"],"type":"string"},"tenantArticleId":{"enum":["ASC","DESC"],"type":"string"},"value":{"enum":["ASC","DESC"],"type":"string"}},"title":"StockSort","type":"object","description":"StockSort"},"StockPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"stocks":{"items":{"$ref":"#/components/schemas/Stock"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","stocks"],"title":"StockPaginatedResult","type":"object","description":"StockPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stocks/search":{"post":{"deprecated":false,"description":"Search for Stock","operationId":"searchStock","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List stocks (search)","tags":["Stock"]}}}}
```

## POST /api/stocks/actions

> Call stock action

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StockAction":{"properties":{"action":{"description":"Action to be performed on the stock. If a user has specific facility context limitations, only stocks located in the referenced facilities will be affected","discriminator":{"propertyName":"name"},"oneOf":[{"$ref":"#/components/schemas/StockDeleteByLocations"},{"$ref":"#/components/schemas/StockDeleteByProducts"},{"$ref":"#/components/schemas/StockDeleteByIds"},{"$ref":"#/components/schemas/StockMoveToLocation"},{"$ref":"#/components/schemas/VersionlessUpdateStock"}]},"actions":{"deprecated":true,"description":"Deprecated. Use 'action' with a single action input instead.","items":{"oneOf":[{"$ref":"#/components/schemas/StockDeleteByLocations"},{"$ref":"#/components/schemas/StockDeleteByProducts"},{"$ref":"#/components/schemas/StockDeleteByIds"}]},"maxItems":10,"type":"array"}},"title":"StockAction","type":"object","description":"StockAction"},"StockDeleteByLocations":{"properties":{"locationRefs":{"items":{"type":"string"},"maxItems":500,"type":"array"},"name":{"enum":["DELETE_BY_LOCATIONS"],"type":"string"}},"required":["name","locationRefs"],"title":"StockDeleteByLocations","type":"object","description":"StockDeleteByLocations"},"StockDeleteByProducts":{"properties":{"facilityRef":{"type":"string"},"name":{"enum":["DELETE_BY_PRODUCTS"],"type":"string"},"tenantArticleIds":{"items":{"type":"string"},"maxItems":500,"type":"array"}},"required":["name","facilityRef","tenantArticleIds"],"title":"StockDeleteByProducts","type":"object","description":"StockDeleteByProducts"},"StockDeleteByIds":{"properties":{"ids":{"items":{"type":"string"},"maxItems":500,"type":"array"},"name":{"enum":["DELETE_BY_IDS"],"type":"string"}},"required":["name","ids"],"title":"StockDeleteByIds","type":"object","description":"StockDeleteByIds"},"StockMoveToLocation":{"properties":{"amount":{"type":"number"},"fromStockId":{"type":"string"},"name":{"enum":["MOVE_TO_LOCATION"],"type":"string"},"options":{"$ref":"#/components/schemas/MoveStockToLocationOptions"},"toLocationRef":{"type":"string"}},"required":["name","fromStockId","toLocationRef","amount"],"title":"StockMoveToLocation","type":"object","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />StockMoveToLocation"},"MoveStockToLocationOptions":{"properties":{"deleteFromStockIfZero":{"type":"boolean"}},"title":"MoveStockToLocationOptions","type":"object","description":"MoveStockToLocationOptions"},"VersionlessUpdateStock":{"properties":{"name":{"enum":["UPDATE_VERSIONLESS"],"type":"string"},"stocks":{"description":"Please be sure to include each stock (by ID) only once, when updating. Otherwise the whole batch is rejected with an error.","items":{"discriminator":{"propertyName":"operationType"},"oneOf":[{"$ref":"#/components/schemas/StockForCreationVersionless"},{"$ref":"#/components/schemas/StockForUpdateVersionless"}]},"maxItems":25,"type":"array"}},"required":["name","stocks"],"title":"VersionlessUpdateStock","type":"object","description":"VersionlessUpdateStock"},"StockForCreationVersionless":{"properties":{"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"description":"Selector for the facility. Either a facility reference or a tenant facility ID must be provided.","oneOf":[{"$ref":"#/components/schemas/FacilityRefSelector"},{"$ref":"#/components/schemas/TenantFacilityIdSelector"}]},"facilityRef":{"deprecated":true,"description":"facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"operationType":{"enum":["CREATE"],"type":"string"},"properties":{"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"},{"additionalProperties":{"type":"string"},"type":"object"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantFacilityId":{"deprecated":true,"description":"tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead","type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["tenantArticleId","value","operationType"],"title":"StockForCreationVersionless","type":"object","description":"StockForCreationVersionless"},"FacilityRefSelector":{"properties":{"facilityRef":{"description":"Resolves a facility by its reference. This is the preferred way to resolve a facility.","minLength":1,"type":"string"}},"required":["facilityRef"],"title":"FacilityRefSelector","type":"object","description":"FacilityRefSelector"},"TenantFacilityIdSelector":{"properties":{"tenantFacilityId":{"description":"Resolves a facility by its tenantFacilityId.","minLength":1,"type":"string"}},"required":["tenantFacilityId"],"title":"TenantFacilityIdSelector","type":"object","description":"TenantFacilityIdSelector"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"StockForUpdateVersionless":{"properties":{"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"locationRef":{"nullable":true,"type":"string"},"operationType":{"enum":["UPDATE"],"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"}},"required":["value","id","operationType"],"title":"StockForUpdateVersionless","type":"object","description":"StockForUpdateVersionless"},"StockActionResult":{"properties":{"name":{"enum":["DELETE_BY_LOCATIONS","DELETE_BY_PRODUCTS","DELETE_BY_IDS","MOVE_TO_LOCATION","UPDATE_VERSIONLESS"],"type":"string"},"result":{"oneOf":[{"$ref":"#/components/schemas/StockDeleteActionResult"},{"$ref":"#/components/schemas/StockMoveToLocationActionResult"},{"$ref":"#/components/schemas/StockVersionlessUpsertActionResult"}]}},"required":["name","result"],"title":"StockActionResult","type":"object","description":"StockActionResult"},"StockDeleteActionResult":{"properties":{"ids":{"items":{"type":"string"},"type":"array"}},"required":["ids"],"title":"StockDeleteActionResult","type":"object","description":"StockDeleteActionResult"},"StockMoveToLocationActionResult":{"properties":{"fromStock":{"$ref":"#/components/schemas/Stock"},"toStock":{"$ref":"#/components/schemas/Stock"}},"required":["toStock"],"title":"StockMoveToLocationActionResult","type":"object","description":"StockMoveToLocationActionResult"},"Stock":{"properties":{"available":{"type":"number"},"availableUntil":{"description":"defines until when a stock is included in the stock availability as available and used for routing","format":"date-time","type":"string"},"conditions":{"description":"Describes conditions of a stock\n    *`DEFECTIVE` - stock is defective, not usable for customer orders","items":{"enum":["DEFECTIVE"],"type":"string"},"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facility":{"$ref":"#/components/schemas/StockFacilityReferences"},"facilityRef":{"description":"facility in which the stock is located","type":"string"},"facilityWideReserved":{"deprecated":true,"type":"number"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"locationRef":{"description":"location on which the stock is placed","type":"string"},"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"receiptDate":{"description":"date-time when stock has entered the system, defaults to the creation date","format":"date-time","type":"string"},"reserved":{"deprecated":true,"description":"amount of this stock reserved for customer orders","type":"number"},"scannableCodes":{"description":"scannableCodes such as barcodes that identify this stock","items":{"type":"string"},"type":"array"},"scores":{"description":"stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.","items":{"$ref":"#/components/schemas/Score"},"type":"array"},"serializedProperties":{"description":"properties object serialized as JSON string, sorted alphabetically by key","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock","minLength":1,"type":"string"},"tenantStockId":{"description":"tenantStockId is an optional identifier for the stock in the tenant system.","type":"string"},"traitConfig":{"description":"defines the traits of the stock, overrules the storage location traits","items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"},"traits":{"description":"provide information on how storage locations and stocks are to be handled in operational processes. Can only be set via storageLocation. ","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"type":"array"},"value":{"format":"int32","minimum":0,"type":"integer"},"version":{"type":"number"}},"required":["tenantArticleId","value","facilityRef","facility","available","id","version","created","lastModified","traits","serializedProperties","reserved","facilityWideReserved"],"title":"Stock","type":"object","description":"Stock"},"StockFacilityReferences":{"properties":{"facilityRef":{"description":"facility in which the stock is located","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId in which the stock is located","type":"string"}},"required":["facilityRef"],"title":"StockFacilityReferences","type":"object","description":"StockFacilityReferences"},"Score":{"properties":{"scoreName":{"$ref":"#/components/schemas/ScoreName"},"scoreType":{"$ref":"#/components/schemas/ScoreType"},"scoreValue":{"description":"Describes the performance of the score","type":"number"}},"required":["scoreType","scoreName","scoreValue"],"type":"object","xml":{"name":"Score"},"title":"Score","description":"Score"},"ScoreName":{"description":"Describes the name of the score for humans to identify","enum":["ZONE","EXPIRY_DATE","RECEIPT_DATE","RUNNING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"ScoreName"},"title":"ScoreName"},"ScoreType":{"description":"Describes what kind of score is represented","enum":["RATING","SEQUENCE"],"type":"string","xml":{"name":"ScoreType"},"title":"ScoreType"},"StockVersionlessUpsertActionResult":{"properties":{"operationResults":{"$ref":"#/components/schemas/StockUpsertOperationResult"}},"required":["operationResults"],"title":"StockVersionlessUpsertActionResult","type":"object","description":"StockVersionlessUpsertActionResult"},"StockUpsertOperationResult":{"properties":{"status":{"enum":["UPDATED","CREATED","UNCHANGED"],"type":"string"},"stock":{"$ref":"#/components/schemas/Stock"}},"required":["stock","status"],"title":"StockUpsertOperationResult","type":"object","description":"StockUpsertOperationResult"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stocks/actions":{"post":{"deprecated":false,"description":"","operationId":"performStocksActions","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockActionResult"}}},"description":"Stock action result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Call stock action","tags":["Stock"]}}}}
```


# Stock availability

fulfillmenttools serves as the central repository for stock data. It integrates updates from multiple sources and consolidates these inputs to deliver diverse availability metrics for various use cases. You can query these metrics through the REST API and access them in Backoffice.

## Getting stock availability information

|                                                      | Backoffice                                                                                                                          | REST API                                                                                                                                                                                             |
| ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Stock availability per article on network level**  | [Inventory network overview in the Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory)   | [api/stocks/summaries](https://docs.fulfillmenttools.com/documentation/apis/api-reference/stocks-inventory#get-api-stocks-summaries)                                                                 |
| **Stock availability per article on facility level** | [Inventory facility overview in the Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory) | <p><a href="#request-stocks-by-facility-for-a-specific-product">api/stockdistribution</a><br><br><a href="#inventory-facility-stock-changed-event">InventoryFacilityStockChangedWebHookEvent</a></p> |

## Stock availability values

<table><thead><tr><th width="241.16015625">Availability value</th><th>Meaning</th></tr></thead><tbody><tr><td><strong>Stock on hand</strong> (On hand)</td><td>Describes stock that is physically located in a facility. Stock that is, for example, still booked to the facility but is already in transit to another facility is not included.</td></tr><tr><td><strong>Available on stock</strong> (AOS)</td><td><p>Available on stock describes stock that's available for sale (not earmarked for other purposes). In fulfillmenttools, it refers to stock that's <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits#available-traits">accessible</a>, reduced by:</p><ul><li>Stock that is <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/reservations">reserved</a> for orders</li><li><a href="#safety-stock">Safety stock</a> (stock that's held back for offline sales)</li><li><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock#stock-properties">Expired stock</a> (if defined)</li><li>Stock that has reached its <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing#stock-available-until">availableUntil</a> value (if defined)</li></ul></td></tr><tr><td><strong>Available for picking</strong> (AFP)<br><br></td><td><p>Available for picking describes stock that's available (not earmarked for other purposes) and ready to be picked. In fulfillmenttools, it refers to all stock that is <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits">accessible</a> and <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits">pickable</a>, reduced by:</p><ul><li>Stock that's <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/reservations">reserved</a> for orders</li><li><a href="#safety-stock">Safety stock</a> (stock that's held back for offline sales)</li><li><a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits">Expired stock</a> (if defined)</li><li>stock that has reached its <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing#stock-available-until">availableUntil</a> value (if defined)</li></ul><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>This value is used for incoming orders. It's sometimes referred to as available for shipping.</p></div></td></tr><tr><td><strong>Expected stock</strong></td><td><p>Expected stock is stock expected to arrive or be produced. Expected stock can be communicated via the <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process">inbound process</a>. After an <code>inboundProcess</code> with a <code>purchaseOrder</code> was created, our systems automatically create expected stock for the requested items. Expected stock is visible in the <a href="https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory#stock-availability">stock overview</a> in Backoffice. Once a purchase order is created, its expected stock can be considered in the shop's <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/expected-stock-in-availability">availability</a>.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>This value can be considered for incoming orders. More information can be found under <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/expected-stock-in-availability">Expected stock in availability.</a></p></div></td></tr><tr><td><strong>Safety stock</strong></td><td><p>Safety stock allows guarding offline sales against online-induced stock-outs. It can be defined on the facility level, and decreases the available stock levels ("<a href="#available-for-picking-afp">available for picking</a>" and "<a href="#available-on-stock-aos">available on stock</a>"). This means that if the stock level in a given facility is equal or less than the configured safety stock, the available stock is 0.</p><p>Users can configure the desired safety stock quantity for each listing. Configurations can be made in the <a href="https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory#stock-availability">stock overview</a> in the Backoffice or via <a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/safetystocks">safety stocks REST API</a>.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>More information can be found under <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/safety-stock">Safety stock</a>.</p></div><div data-gb-custom-block data-tag="hint" data-style="warning" class="hint hint-warning"><p>Safety stock is considered in order routing meaning that orders can become <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/unroutable-orders">unroutable</a> if the available stock is equal to or less than the configured safety stock.</p></div></td></tr></tbody></table>

## Inventory facility stock changed event

When stock levels change in a facility, the `INVENTORY_FACILITY_STOCK_CHANGED` event is emitted. It uses the `InventoryFacilityStockChangedWebHookEvent` payload. You can find the [schema in the models page](https://docs.fulfillmenttools.com/documentation/apis/api-reference/models).

Each event reports one `tenantArticleId` in one `facilityRef`. Every quantity in the payload is the aggregated value for that facility only. It does not contain a network-wide aggregate.

You can create an event scope for this event to include more than one facility, see the [Event scope section of the Eventing article](https://docs.fulfillmenttools.com/documentation/getting-started/eventing#event-scopes).

## Future availability

### Creation and management of expected stock

Expected stock is automatically created after a new [inbound process](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process) with a corresponding purchase order is added. Expected stock can only be managed via the purchase order and cannot directly be edited via API. Quantities, attributes, and so on of expected stock can be edited via the requested items of the [purchase order](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process/purchase-order).

### Stock properties and available until

**Available until**

**`availableUntil`** defines until when stock is considered available.

* Calculated automatically for stock and expected stock based on expiry or creation date, with optional modifiers (for example, `-P30D` to shift earlier) if configured in the [listing](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing).
* For expected stock, the creation date of the purchase order is used if `calculationBase` is set to `CREATION`. When a receipt is created, `availableUntil` of the stock is updated based on the creation date of the stock.

{% hint style="warning" %}
When updating a listing with `stockAvailableUntil`, the value will be only added to newly created stock.
{% endhint %}

**Stock properties**

* Stock properties (especially `expiry`) provide the values required for calculating `availableUntil` with `calculationBase` = `EXPIRY`.
* [Listings](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing) define which properties are required.
* For expected stock, `properties` can be specified in the `requestedItems` of the [purchase order](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process/purchase-order). When a `receipt` is created, the `properties` are transferred to the stock.
* If a `defaultValue` is defined for a stock property in the listing, the stock is created with that value. Empty strings provided as default values are ignored.

**Interaction**

* `availableUntil` is the decisive value for availability.
* If both `expiry` and `availableUntil` (with `calculationBase` = `CREATION`) are set, only `availableUntil` applies.
* `availableUntil` defaults to the expiry date if `expiry` `properties` are configured in the stock.

## Stock availability thresholds

Stock availability thresholds let you define your own low stock or critical stock levels for articles, categories, facilities, or facility groups. Whenever a stock level crosses one of these thresholds, you'll get notified automatically.

Instead of periodically checking stock reports yourself, you can set a threshold once, and fulfillmenttools monitors stock levels in the background for as long as the threshold is active.

Typical uses:

* **Replenishment triggers:** Get alerted when an article's available stock in a facility drops below a safety level, so you can reorder before it sells out.
* **Automation:** React programmatically when stock drops into a critical range (for example, pause promotions or notify a supplier).

### How availability thresholds work

A threshold configuration has two parts:

1. A `target`, which is what to monitor. For example, one or more articles, categories, facilities, or facility groups. You can combine these (for example, these 3 articles and these 2 facilities), or leave the target empty to monitor everything.
2. A `threshold` is the level you care about. Each has a name that you choose (for example, `CRITICAL_STOCK` or `LOW_STOCK`) and a numeric limit. You decide whether the limit is measured against [available for picking stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability) or [stock on hand](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability).

Once a configuration is created, every time a targeted article's stock changes, fulfillmenttools checks whether it has moved across one of your levels:

* If a stock level drops to or below a threshold's limit for the first time, that's a `TO_ON` transition, and the alert activates.
* If the stock level later recovers above the limit, that's a `TO_OFF` transition. The alert is "deactivated" because the situation has resolved itself.

If you set several levels (for example, `LOW_STOCK` at 20 units and `CRITICAL_STOCK` at 5 units), fulfillmenttools always reports the most specific one that applies. So stock falling straight from 100 to 3 units reports directly as `CRITICAL_STOCK`, not as `LOW_STOCK` followed by `CRITICAL_STOCK`.

Thresholds compare against a single number per stock measure. They don't currently account for trends (for example, rapid drops). Only the current value relative to your configured limit.

Everything is tracked per listing, per facility. If your target matches several facilities, each facility listing is monitored and alerted independently. One facility running low doesn't affect another facility's alert status.

{% hint style="info" %}
Today, one threshold configuration effectively monitors a single stock measure (either available for picking or stock on hand). If you need to watch both for the same target, create two separate threshold configurations.
{% endhint %}

A configuration with no target (empty target) applies to everything. Use this deliberately, as it will start monitoring your entire network.

### Example

Say you configure a threshold named `LOW_STOCK` with a limit of `10`, targeting article `SNEAKER-001` across all facilities in your Germany facility group, measured against available for picking stock.

* The Berlin facility has 45 available for `SNEAKER-001`, so nothing happens.
* A wave of orders brings Berlin's stock down to 8 available, so a `LOW_STOCK` alert fires `TO_ON` for Berlin.
* The Munich facility still has 60 available, so no alert for Munich as each facility is evaluated independently.
* Restocking brings Berlin back up to 30 available, so a `TO_OFF` alert fires for Berlin, closing out the earlier alert.
* Prague drops to 9 available, but no alert fires for the Prague facility because it's not in the target.

### Create a threshold

You manage threshold configurations via the [availability threshold configuration API](broken://pages/1f496cc9ee9e942e304f90b9a68880f27e643e26). You can create, update, or delete a configuration by specifying its target and its threshold levels. You don't need to poll or schedule anything.

To create a threshold, use the endpoint below:

```http
POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/availability/thresholds
```

If we created a threshold as described in the [example](#example), it would look like the following:

```json
{
  "target": {
    "context": [
      {
        "type": "FACILITY_GROUP",
        "values": [
          "{YOUR_FACILITY_GROUP_ID}"
        ]
      },
      {
        "type": "ARTICLE",
        "values": [
          "SNEAKER-001"
        ]
      }     
    ]
  },
  "tenantThresholdId": "LOW_STOCK_SNEAKER-001",
  "thresholds": [
    {
      "levels": [
        {
          "key": "LOW_STOCK",
          "limit": 10
        }
      ],
      "thresholdOnValue": "AVAILABLE_FOR_PICKING"
    }
  ]
}
```

### Edit a threshold

Changing a configuration resets all active alerts for that configuration, so the next stock change is evaluated against the new settings. If a given stock level was already in a `TO_ON` state before the change, it will be treated as a new transition if it is still below the threshold after the change.

To update a threshold, use the endpoint below:

{% tabs %}
{% tab title="Endpoint" %}

```http
PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/availability/thresholds/{YOUR_THRESHOLD_ID}
```

{% endtab %}

{% tab title="Request" %}

```json
{
  "version": 1,
  "thresholds": [
    {
      "thresholdOnValue": "STOCK_ON_HAND",
      "levels": [
        {
          "key": "LOW_STOCK",
          "limit": 5
        }
      ]
    }
  ]
}
```

The `version` field is required and must match the stored version of the threshold configuration.
{% endtab %}
{% endtabs %}

You can also trigger a full reevaluation of the affected stock availabilities when the `context` or `threshold` changes.

To do this, use the `enforceFullReevaluation=true` parameter:

```http
PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/availability/thresholds/{{thresholdId}}?enforceFullReevaluation=true
```

The reevaluation runs asynchronously and sends `INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED` events for each resulting threshold transition, plus an `INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED_BULK` event.

{% hint style="warning" %}
A reevaluation after a change can send many events in a short time. The `INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED_BULK` event reduces webhook calls. Event consumers must be able to process these large volumes.
{% endhint %}

For each processed stock availability, the reevaluation sends up to two transitions per entry in the thresholds array of the configuration:

* `TO_OFF` for the previous configuration version, if a threshold level was reached.
* `TO_ON` for the updated configuration version, if a threshold level is reached.

{% tabs %}
{% tab title="Event payload" %}
A single webhook call contains the transitions for one `tenantArticleId` in one facility. The following payload shows a configuration that changed from version 1 to version 2 while the stock stayed below both limits.

{% code title="INVENTORY\_FACILITY\_STOCK\_THRESHOLD\_TRANSITIONED" %}

```json
{
  "event": "INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED",
  "eventId": "{YOUR_EVENT_ID}",
  "payload": {
    "tenantArticleId": "{YOUR_TENANT_ARTICLE_ID}",
    "facilityRef": "{YOUR_FACILITY_ID}",
    "facility": {
      "facilityRef": "{YOUR_FACILITY_ID}",
      "tenantFacilityId": null
    },
    "thresholds": [
      {
        "config": {
          "id": "{YOUR_CONFIG_ID}",
          "version": 1,
          "tenantThresholdId": "{YOUR_TENANT_THRESHOLD_ID}"
        },
        "transition": "TO_OFF",
        "triggerTimestamp": "2026-01-01T10:00:00.000Z",
        "thresholdOnValue": "STOCK_ON_HAND",
        "thresholdLevel": {
          "key": "LOW_STOCK",
          "limit": 3,
          "actual": 1
        }
      },
      {
        "config": {
          "id": "{YOUR_CONFIG_ID}",
          "version": 2,
          "tenantThresholdId": "{YOUR_TENANT_THRESHOLD_ID}"
        },
        "transition": "TO_ON",
        "triggerTimestamp": "2026-01-01T10:00:00.000Z",
        "thresholdOnValue": "STOCK_ON_HAND",
        "thresholdLevel": {
          "key": "LOW_STOCK",
          "limit": 4,
          "actual": 1
        }
      }
    ]
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Bulk event payload" %}
The `INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED_BULK` event bundles the transitions of multiple stock availabilities in one webhook call. Each entry of the array has the same structure as the payload of the `INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED` event, for different `tenantArticleId` and `facilityRef` combinations.

{% code title="INVENTORY\_FACILITY\_STOCK\_THRESHOLD\_TRANSITIONED\_BULK" %}

```json
{
  "event": "INVENTORY_FACILITY_STOCK_THRESHOLD_TRANSITIONED_BULK",
  "eventId": "{YOUR_EVENT_ID}",
  "payload": [
	{
  	"tenantArticleId": "{YOUR_TENANT_ARTICLE_ID_1}",
  	"facilityRef": "{YOUR_FACILITY_ID}",
  	"facility": {
    	"facilityRef": "{YOUR_FACILITY_ID}",
    	"tenantFacilityId": null
  	},
  	"thresholds": [
    	{
      	"config": {
        	"id": "{YOUR_CONFIG_ID}",
        	"version": 2,
        	"tenantThresholdId": "{YOUR_TENANT_THRESHOLD_ID}"
      	},
      	"transition": "TO_ON",
      	"triggerTimestamp": "2026-01-01T10:00:00.000Z",
      	"thresholdOnValue": "STOCK_ON_HAND",
      	"thresholdLevel": {
        	"key": "LOW_STOCK",
        	"limit": 4,
        	"actual": 1
      	}
    	}
  	]
	},
	{
  	"tenantArticleId": "{YOUR_TENANT_ARTICLE_ID_2}",
  	"facilityRef": "{YOUR_FACILITY_ID}",
  	"facility": {
    	"facilityRef": "{YOUR_FACILITY_ID}",
    	"tenantFacilityId": null
  	},
  	"thresholds": [
    	{
      	"config": {
        	"id": "{YOUR_CONFIG_ID}",
        	"version": 2,
        	"tenantThresholdId": "{YOUR_TENANT_THRESHOLD_ID}"
      	},
      	"transition": "TO_ON",
      	"triggerTimestamp": "2026-01-01T10:00:00.000Z",
      	"thresholdOnValue": "STOCK_ON_HAND",
      	"thresholdLevel": {
        	"key": "LOW_STOCK",
        	"limit": 4,
        	"actual": 2
      	}
    	}
  	]
	}
  ]
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

As the reevaluation is asynchronous, regular stock changes can occur while it's running. Correct results can only be guaranteed if the following rules are adhered to:

* If `config.version` is higher than the stored version, the event is accepted.
* If `config.version` equals the stored version, the event with the higher `triggerTimestamp` for the given threshold is kept.

{% hint style="info" %}
Transitions that originate from a reevaluation don't create alerts in the Notification center.
{% endhint %}

#### Concurrent updates

An update with `enforceFullReevaluation=true` while a reevaluation of the same threshold configuration is running stops the running reevaluation and starts a new one. The new reevaluation sends only the events for the change from the previous configuration version to the updated one.

An update without `enforceFullReevaluation` while a reevaluation is running stops the reevaluation.

Updating a configuration with `enforceFullReevaluation=true` in quick succession isn't recommended. If a threshold configuration is updated multiple times, it's recommended that you remove data stored from previous configuration versions.

A stock availability matches a threshold configuration when a stock availability change is processed while the configuration exists. Stock availabilities that haven't changed since the configuration was created aren't matched. A reevaluation after a threshold change doesn't process these stock availabilities.

A reevaluation after a context change takes longer. The duration depends on the number of unique stocks across facilities and `tenantArticleId` values.

### View an alert

You can view an alert in two ways, via [Backoffice](#backoffice-users) or [API](#api-consumers).

{% hint style="warning" %}
This isn't automatically viewable. You must opt in first by configuring the [Notification center](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/notification-center) settings.
{% endhint %}

Alerts are informational only. Reaching a threshold doesn't itself block orders, pause listings, or take any other automated action. You (or your configured notification channel) decide how to respond.

#### Backoffice users

When a threshold activates (`TO_ON`), it can be surfaced as:

* An in-app notification in Backoffice
* An email sent to the addresses configured for your tenant or facility

Both channels are opt-in and configured through the [Notification center](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/notification-center) settings.

{% hint style="info" %}
Only the `TO_ON` (stock became critical) transition is treated as notification-worthy. The recovery (`TO_OFF`) is intentionally silent, since the problem resolved itself rarely needs an alert of its own.
{% endhint %}

#### API consumers

Every transition (`TO_ON` and `TO_OFF`) is emitted as a domain event containing the article, the facility, and the threshold level(s) that changed, so you have the full picture even though only `TO_ON` triggers a human-facing notification by default.


# Safety stock

Safety stock is a reserved buffer quantity that protects offline (in-store) sales from being cannibalized by online orders. Stock at or below the configured safety stock level is excluded from availability calculations ([AOS](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability#stock-availability-values) and [AFP](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability#stock-availability-values)) and from order routing — meaning a facility with stock equal to or less than its safety stock will not be considered for fulfilling online orders.

{% hint style="warning" %}
Safety stock is considered during order routing. If all facilities for an article have reached their safety stock level, the order may become unroutable.
{% endhint %}

## Configuration

Safety stock is configured per article and facility. Two levels are supported:

* **Global safety stock**: A single value applied automatically to all facilities for a given article. If a facility has no individual value set, the global value applies. This is only configurable via [API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/safetystocks) by omitting the `facilityRef` in the request.
* **Facility-level safety stock**: A value configured for a specific facility, overriding the global value for that facility. This is configurable via [API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/safetystocks) and [Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory#what-is-safety-stock-and-how-is-it-edited).

{% hint style="info" %}
If both a global and a facility-level safety stock are configured, the facility-level value takes precedence for that facility.
{% endhint %}

## Safety stock in Backoffice

### Display

The stock detail view in the **Network view** shows safety stock at two levels:

* **Article header**: Displays the sum of all effective safety stock values across all facilities, giving a quick network-wide overview of total held-back stock.
* **Network module**: The **Safety stock** column shows the effective value per facility — regardless of whether it originates from a global or facility-level configuration.

### Configuration

Safety stock can be configured directly on the stock detail view:

* **Facility-level value**: Open the **three-dot menu** in the corresponding facility row in the Network module.

## API

Safety stock can also be managed via the [Safety stocks REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/safetystocks) using a bulk `PUT` request to `/api/safetystocks`.

## FAQs

<details>

<summary>What happens when safety stock is reached?</summary>

Once the stock in a facility reaches or falls below the configured safety stock level, that facility's AOS and AFP for that article drop to 0. The facility is no longer considered for order routing.

</details>

<details>

<summary>Which value takes precedence — global or facility-level safety stock?</summary>

The facility-level safety stock always takes precedence over the global value. If no individual value is set, the global value applies.

</details>

<details>

<summary>What does the safety stock value in the article header show?</summary>

It shows the sum of all effective safety stock values across all facilities for that article.

</details>


# Safety stock endpoints

## The SafetyStock object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"SafetyStock":{"properties":{"created":{"format":"date-time","type":"string"},"facilityRef":{"type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantArticleId":{"type":"string"},"value":{"type":"number"},"version":{"type":"number"}},"required":["tenantArticleId","value","created","id","lastModified","version"],"title":"SafetyStock","type":"object","description":"SafetyStock"}}}}
```

## GET /api/safetystocks

> List safety stocks

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SafetyStocksPaginatedResult":{"properties":{"safetyStocks":{"items":{"$ref":"#/components/schemas/SafetyStock"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","safetyStocks"],"title":"SafetyStocksPaginatedResult","type":"object","description":"SafetyStocksPaginatedResult"},"SafetyStock":{"properties":{"created":{"format":"date-time","type":"string"},"facilityRef":{"type":"string"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantArticleId":{"type":"string"},"value":{"type":"number"},"version":{"type":"number"}},"required":["tenantArticleId","value","created","id","lastModified","version"],"title":"SafetyStock","type":"object","description":"SafetyStock"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/safetystocks":{"get":{"deprecated":false,"description":"","operationId":"getSafetyStocks","parameters":[{"description":"The number of items to return.","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"number"}},{"description":"The ID of the last item from the previous page. The next page will start after this ID.","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"in":"query","name":"tenantArticleId","required":false,"schema":{"type":"string"}},{"in":"query","name":"facilityRef","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SafetyStocksPaginatedResult"}}},"description":"Available Safety Stocks"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List safety stocks","tags":["Stock"]}}}}
```

## PUT /api/safetystocks

> Update safety stocks

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SafetyStockBulkOperations":{"properties":{"operations":{"items":{"$ref":"#/components/schemas/SafetyStockBulkOperation"},"maxItems":500,"minItems":1,"type":"array"}},"required":["operations"],"title":"SafetyStockBulkOperations","type":"object","description":"SafetyStockBulkOperations"},"SafetyStockBulkOperation":{"properties":{"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"},"value":{"type":"number"}},"required":["tenantArticleId","value"],"title":"SafetyStockBulkOperation","type":"object","description":"SafetyStockBulkOperation"},"SafetyStockBulkOperationResult":{"properties":{"error":{"$ref":"#/components/schemas/BulkOperationError"},"facilityRef":{"type":"string"},"status":{"enum":["UPDATED","CREATED","FAILED"],"type":"string"},"tenantArticleId":{"type":"string"},"value":{"type":"number"}},"required":["tenantArticleId","facilityRef","value","status"],"title":"SafetyStockBulkOperationResult","type":"object","description":"SafetyStockBulkOperationResult"},"BulkOperationError":{"properties":{"message":{"type":"string"},"type":{"enum":["NOT_FOUND","NOT_ALLOWED","VALIDATION","UNKNOWN"],"type":"string"}},"required":["type","message"],"title":"BulkOperationError","type":"object","description":"BulkOperationError"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/safetystocks":{"put":{"deprecated":false,"description":"","operationId":"bulkUpdateSafetyStock","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SafetyStockBulkOperations"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SafetyStockBulkOperationResult"}}},"description":"Result of the bulk operations"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Update safety stocks","tags":["Stock"]}}}}
```

## DELETE /api/safetystocks/{safetyStockId}

> Delete safety stock

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stocks.","name":"Stock"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/safetystocks/{safetyStockId}":{"delete":{"deprecated":false,"description":"","operationId":"deleteSafetyStock","parameters":[{"in":"path","name":"safetyStockId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the bulk operations"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Delete safety stock","tags":["Stock"]}}}}
```


# Expected stock in availability

In some business scenarios, stock should be available for sale before it has arrived at a facility or has been produced. fulfillmenttools supports two approaches depending on how precisely the expected stock is known at the time of sale.

If a concrete purchase order exists and the delivery date is known, expected stock can be tracked and made available for sale. Reservations can be made on this stock and are automatically shifted to real stock once the delivery has arrived. This article will cover this scenario.

If the delivery date or quantity is not yet known, a purchase order with a large quantity is created to avoid stock limits on incoming customer orders. Once the purchase order is placed or the production schedule is defined, the quantity is adjusted to reflect the actual amount. For more information, see the [Demand-based replenishment article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/expected-stock-in-availability/demand-driven-replenishment).

## Selling and managing expected stock

In some cases, stock should be available for sale before it has even arrived at the site or has been produced. This means that expected stock needs to be tracked and communicated to shop systems. It's also necessary that reservations can be made on expected stock.

### Use case example

A company is selling gift items online and in retail stores. As a special service, the company offers to send the gift directly to the recipient on the day of the birthday. As the delivery date often lies far in the future, it should be possible to take expected stock into account when ordering. Furthermore, some of the gift baskets contain perishable goods. As the company only wants to sell items up to 30 days before their expiration date, this attribute must also be taken into account when customers place orders and reservations are made.

### Implementation in fulfillmenttools

{% stepper %}
{% step %}
**Create listings**

In most set-ups, listings should already be created for all products that are managed via fulfillmenttools' systems. Still, make sure that a listing exists for each product whose expected stocks should be considered. If goods are perishable and/or should only be available for a certain time frame, [stock properties](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties) and/or [stockAvailableUntil](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing#stock-available-until) must be configured. For this use the [facilities listings REST API endpoint](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/facilities/-facilityId-/listings).
{% endstep %}

{% step %}
**Create purchase order**

Create a purchase order for all items that have already been (re-)ordered. After the purchase order has been created, an expected stock is automatically created for each position in `requestedItems`. If [stock properties](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties) such as expiry date or batch number are already known at the time of the order placement they can be defined as well. For this use the [purchase order REST API endpoint](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/purchaseorders).

{% hint style="warning" %}
Don't create purchase orders with `requestedDate.type` "ASAP". As we expect these deliveries to arrive as soon as possible, there is no exact date that our systems can use to check the potential availability of these stocks for incoming orders.
{% endhint %}
{% endstep %}

{% step %}
**Query checkout options endpoints for shop availability**

Query one of the [checkout options endpoints](https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising#checkout-options) to get the future availability for a specific delivery date or time period. In the future availability, all stock is included that:

* Is [pickable and accessible](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits)
* Has already arrived at the site at the start of the picking
* Doesn't exceed its [availableUntil date](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing#stock-available-until) until the (desired) delivery date

Before using the [delivery/earliest REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/checkoutoptions/delivery/earliest) or the [delivery/timeperiod REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/checkoutoptions/delivery/timeperiod) endpoint, the transit times in the [carrier country service mapping](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/carrier-management/carrier-features-and-requirements#carrier-country-service-mapping-ccsm) for the requested carrier(s) must be configured.

{% hint style="warning" %}
Expected stocks are only considered in the checkout options endpoint if the `desiredDeliveryTime` is specified in the request and the mode for `reservationPreferences` is set to "ALAP" (as late as possible).
{% endhint %}

Use the [checkout options REST API endpoints](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/checkoutoptions/collect/earliest).

**Example:**

Request availability for a gift item in the store in Cologne for the delivery date 14 September 2024:

1. **Request:** `POST /api/promises/checkoutoptions/delivery/timepoint​`

* `desiredDeliveryDate`: "2024-09-14"
* `tenantArticleId`: gift-set-01​
* `facilityRef`: facility-CGN​
  * `latestPickingStart` for Cologne: "2024-09-10"

{% hint style="info" %}
If the latest possible picking start for a certain delivery date in a facility is not known, it can be requested via the [checkout options REST API endpoint](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/checkoutoptions). Systems then calculate the `latestPickingStart` based on [cut-off time](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/carrier-management/carrier-features-and-requirements#carrier-capacity-management) of carriers and [fulfillment process buffer](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking/pick-job-target-time).​
{% endhint %}

2. **Availability check:**

After the request has been made, an availability check is performed which validates if the expected stock fulfills all necessary criteria to be considered for the (potential) order. ​

* Is `desiredDeliveryDate` before the `availableUntil` date?​ Items should not have expired until they have reached the customer.
* Is `latestPickingStart` after the requested date of stock​? Items must have arrived in the facility before they can be picked.

3. **Response:**

The response returns all stock in the requested facility that is currently available and will not expire until the desired delivery date plus all expected stock that fulfills the criteria of the availability check.

* Available: 30
  {% endstep %}

{% step %}
**Make reservation**

If an item should already be reserved but has not been ordered yet (for example, a customer placed it in the shopping cart), the [delivery promise REST API endpoint](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/deliverypromise) can be used.\
If an order was placed and the item should be reserved, the [order REST API endpoint](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/orders) can be used.

See the [Reservations article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/reservations) for more information.

{% hint style="warning" %}
Expected stocks are only considered in promising and order routing if the `desiredDeliveryTime` is specified in the request and the mode for `reservationPreferences` is set to `ALAP` (as late as possible).
{% endhint %}
{% endstep %}

{% step %}
**Manage reservations on expected stocks**

Reservations on expected stock can be monitored via the [Stock overview](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory#stock-availability) in Backoffice.

See the [Stock availability article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability) for more information on expected stock.

<figure><img src="https://content.gitbook.com/content/Lrrr5jgTsDuR38gNJIrm/blobs/OxmV9nff6o49TjhYg2id/image" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Create stock after delivery has arrived**

If the delivery of the ordered products has arrived or the production was finished, a receipt needs to be added to the inbound process of the purchase order to create stock. Use the [purchase order REST API endpoint](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/purchaseorders/-purchaseOrderId-) to query the respective `inboundProcessRef` if it is not stored in your systems.

After the stock was created in the facility, reservations are shifted from expected stock to "real" stock. When shifting reservations, an available stock in the facility is chosen, considering the [running sequence](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones#running-sequences-on-storage-locations) (if defined). This means the reservation is not necessarily made on the exact item that has arrived in the delivery.
{% endstep %}
{% endstepper %}

### FAQs

<details>

<summary><strong>What happens if the requested date for a delivery changes?</strong></summary>

If it is known that a delivery will arrive later than planned, the `requestedDate` in the `purchaseOrder` needs to be patched for the correct date. After the purchase order has been updated, our systems check whether reservations on the respective expected stocks can still be fulfilled. If the delivery arrives too late to be considered for a reservation, the reservation is shifted to an alternative stock. If there is no alternative stock available, the reservation is still tracked and will be shifted to a stock as soon as some stock becomes available.

</details>

<details>

<summary><strong>What happens if the supplier can only deliver fewer goods than ordered?</strong></summary>

If it is know that there will be less items in the delivery than ordered, the `requestedItems` in the `purchaseOrder` need to be patched for the correct items and quantities. After the purchase order has been updated, our systems check whether reservations on the respective expected stocks can still be fulfilled. If a reservation on the purchase order cannot be fulfilled anymore, the reservation is shifted to an alternative stock. If there is no alternative stock available, the reservation is still tracked and will be shifted to a stock as soon as some stock becomes available.

</details>

<details>

<summary><strong>What happens if part of the delivery is missing or defective?</strong></summary>

After a delivery has arrived and a [receipt was added to the inbound process](#implementation-in-fulfillmenttools) (step 6), reservations are shifted from expected to "real" stock. If there is not enough stock available in the facility due to some items in the delivery being missing or defective, the reservations will still be tracked and shifted to a stock as soon as some stock becomes available.

</details>

<details>

<summary><strong>What happens if the delivery is delayed?</strong></summary>

If a delivery is delayed, it is no longer considered for new reservations. Existing reservations on the expected stocks are kept until the purchase order has been cancelled. Therefore, we advise users to update the requestedDate or cancel the purchaseOrder as soon as it is known that the delivery will be delayed.

</details>


# Demand-based replenishment

Some businesses replenish stock at fixed intervals or produce goods on demand. In both cases, it's often necessary to accept consumer orders before the purchase order is placed or the production schedule is defined. This page describes how to configure fulfillmenttools to accept orders without being limited by current stock levels in these scenarios.

{% hint style="info" %}
An alternative approach is to configure the out-of-stock behavior using the `restockable` property. For more information, see the [Out of stock behavior and configuration article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/out-of-stock-behavior-and-configuration).
{% endhint %}

The described use case is mapped by creating purchase orders with a very high amount of products and allowing shop systems to access the thereby created expected stock.

{% hint style="info" %}
If you know the stock quantites, follow the steps in the [Expected stock in availiability article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/expected-stock-in-availability#implementation-in-fulfillmenttools).
{% endhint %}

{% stepper %}
{% step %}
**Create listings for products that should be available in large quantities**

In most set-ups, listings should already be created for all products that are managed via fulfillmenttools' systems. Still, make sure that a listing exists for each relevant product. If goods are perishable and/or should only be available for a certain time frame, [stock properties](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties) and/or [stockAvailableUntil](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing#stock-available-until) must be configured.

{% tabs %}
{% tab title="Endpoint" %}

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/listings
```

{% endtab %}

{% tab title="Request" %}

```http
{
  "listings": [
    {
      "tenantArticleId": "4711",
      "title": "Chocolate Santa",
      "titleLocalized": {
        "de_DE": "Schoko Weihnachtsmann",
        "en_US": "Chocolate Santa"
      },
      "stockProperties": {
        "expiry": {
          "inputType": "DATE",
          "required": true
        }
      },
      "stockAvailableUntil": {
        "calculationBase": "EXPIRY",
        "modifier": "-P30D"
      },
      "version": 1
    }
  ]
}
```

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
**Create a purchase order**

A [purchase order](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process/purchase-order) needs to be created and include all items that have not been ordered yet but should be already available for sale and not be limited by current stock levels.

* Choose a high number for the `quantity.value` of `requestedItems`
* Define the date when the delivery is expected to arrive in `requestedDate.value` and set `requestedDate.type` to `TIMEPOINT`
* Include as many items as possible in one purchase order rather than creating one purchase order for each item for that a very high stock should be assumed

{% hint style="warning" %}
Each purchase order is limited to 200 tenantArticleIds.
{% endhint %}

{% tabs %}
{% tab title="Endpoint" %}

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/inboundprocesses/{YOUR_INBOUND_PROCESS_ID}/purchaseorder
```

{% endtab %}

{% tab title="Request example" %}

```json
{
  "orderDate": "2024-08-12T12:59:37.192Z",
  "requestedDate": {
    "type": "TIME_POINT",
    "value": "2024-08-19T12:59:37.192Z"
  },
  "requestedItems": [
    {
      "tenantArticleId": "4711",
      "quantity": {
        "value": 10000
      },
      "stockProperties": {
        "expiry": "2025-02-19T12:59:37.192Z"
      }
    }
  ],
  "facilityRef": "warehouse-cgn"
}

```

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
**Enable shop systems to communicate expected stock in sales availability**

Use one of the below endpoints to query stock availability in your shop's detail pages and in the checkout journey. By that, it's ensured that expected stock is considered in the shop availability.

See the [Availability and Promising section](https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising) for more information on the checkout options endpoints.

{% hint style="warning" %}
Before using the [delivery/earliest REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/checkoutoptions/delivery/earliest) and [delivery/timeperiod REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/promises/checkoutoptions/delivery/timeperiod) endpoints, the transit time in the [carrier country service mapping](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/carrier-management/carrier-features-and-requirements#country-service-mapping) for the requested carrier(s) must be configured.
{% endhint %}
{% endstep %}

{% step %}
**Create a new purchase order**

{% hint style="info" %}
You only need to do this if the quantity delivered is less than the reserved stock.
{% endhint %}

Create another new purchase order with large quantities, like you did in step 2. This ensures that the systems can continue to accept customer orders that should be fulfilled within next production or replenishment cycle.
{% endstep %}

{% step %}
**Patch purchase order with actual quantity**

Once the purchase order was placed or the production schedule was defined, patch requested items in the purchase order with quantities that were actually ordered or planned to be produced. Adjust stock properties such as expiry date if necessary.

{% hint style="info" %}
If there are more reservations than (expected) stock for reasons such as problems during production or defective items in a delivery, our systems try to distribute these abandoned reservations to other stock. If no alternative stock is available, the reservation is still tracked and will be shifted to a stock as soon as some stock becomes available.
{% endhint %}

{% tabs %}
{% tab title="Endpoint" %}

```http
PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/purchaseorders/{YOUR_PURCHASE_ORDER_ID}
```

{% endtab %}

{% tab title="Request example" %}

```json
{
  "version": 2,
  "requestedItems": [
    {
      "tenantArticleId": "4711",
      "quantity": {
        "value": 150
      },
      "stockProperties": {
        "expiry": "2025-02-19T12:59:37.192Z"
      }
    }
  ],
  "facilityRef": "warehouse-cgn"
}

```

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
**Create stock after delivery has arrived or products are produced**

If the ordered products have arrived or production has been completed, a receipt needs to be added to the purchase order's inbound process to create stock.

If you're not sure about which inbound process the purchase order belongs to, use the [purchase order REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/purchaseorders/-purchaseOrderId-) endpoint to query the `inboundProcessRef`.

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/inboundprocesses/{YOUR_INBOUND_PROCESS_ID}/receipts
```

{% endtab %}

{% tab title="Request example" %}

```json
{
  "receivedDate": "2024-08-18T13:40:05.864Z",
  "receivedItems": [
    {
      "tenantArticleId": "4711",
      "acceptedQuantity": {
        "value": 149
      },
      "rejectedQuantity": {
        "value": 1
      },
      "stockProperties": {
        "expiry": "2025-02-19T12:59:37.192Z"
      },
      "comments": [
        {
          "content": "One item was broken."
        }
      ]
    }
  ],
  "status": "FINISHED"
}

```

{% endtab %}
{% endtabs %}
{% endstep %}
{% endstepper %}


# Stock properties

Stock properties allow tracking of specific values on a set of items, a [stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock). A common example for properties are values such as **expiry date or batch identifiers.** Stock properties are represented by a map of key-value pairs.

Often it's useful to limit and enforce which stock properties are tracked for which type of product. For example, it might be required to track the expiry date during goods receipt for certain items. This can be configured in the [listing](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing).

Both keys and values of stock properties must be strings. However, strings can be used as representations of other data types like ISO date strings.

## Expiry date as special stock property

Stock properties allow storing any information on a stock, as key and value can be defined by the user. However, properties with key "expiry" are treated differently in the platform. A property with key "expiry" is treated as the expiry date of the stock. This information is used in the following areas:

* Calculate the [availableUntil](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing#stock-available-until) date of the stock which defines until which point in time the stock can be sold.
* Used in routing and picking to select the best stock for FEFO (First Expired, First Out) strategy.

## Effects of stock properties on storage

The inventory configurations allow users to define the storage principles of their network or facility. If `isMixedStorage` is set to false, stock with the same tenant article ID and different stock properties should not be stored on the same location. Users will receive a modal warning them not to mix different properties on the same location when stowing in the inventory app. However, there is no technical constraint forbidding this behavior.

In addition, if `isMixedStorage` is set to false, storage location recommendations are adapted so that no locations are recommended where the same item with different stockProperties is already stored.

See the [inventory configurations article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations) for more information.


# Stock updates

Stocks represent items in a facility and carry information on how much of an article is present as well as metadata and operational data. Stocks are updated when their value, the reservations placed on them, or any other data changes.

## Stock update overview

The table below gives an overview of all actions triggering stock updates in fulfillmenttools.

{% hint style="info" %}
Not all stock updates are emitted immediately. Some updates are processed asynchronously by background jobs. For inventory reservations, the corresponding stock change event can be delayed by up to one scheduler cycle (approximately 60 seconds).
{% endhint %}

<table data-full-width="false"><thead><tr><th width="117"></th><th>Reservation +</th><th>Reservation -</th><th width="92.2265625">Stock +</th><th width="89.1796875">Stock -</th><th width="91.39453125">Expected stock +</th><th width="103.1953125">Expected stock -</th><th>Events</th></tr></thead><tbody><tr><td>Order assigned to facility</td><td>✔️</td><td></td><td></td><td></td><td></td><td></td><td><code>INVENTORY_FACILITY _STOCK_CHANGED</code></td></tr><tr><td>Order canceled or obsolete, or rerouted</td><td></td><td>✔️</td><td></td><td></td><td></td><td></td><td><code>INVENTORY_FACILITY _STOCK_CHANGED</code></td></tr><tr><td>Purchase order created</td><td></td><td></td><td></td><td></td><td>✔️</td><td></td><td><code>INBOUND_PROCESS_ PURCHASE_ORDER_ CREATED</code></td></tr><tr><td>Receipt was finished</td><td></td><td></td><td>✔️</td><td></td><td></td><td>✔️</td><td><code>INBOUND_DELIVERY_ RECEIVED,</code><br><code>INVENTORY_ STOCKS_CREATED,</code><br><code>INVENTORY_ STOCKS_VALUE_ CHANGED</code></td></tr><tr><td>Interfacility transfer arrives</td><td>✔️<br></td><td></td><td>✔️<br></td><td></td><td></td><td>✔️</td><td><code>INVENTORY_FACILITY _STOCK_CHANGED,</code><br><code>INBOUND_DELIVERY_ RECEIVED,</code><br><code>INVENTORY_ STOCKS_CREATED,</code><br><code>INVENTORY_ STOCKS_VALUE_ CHANGED</code></td></tr><tr><td>Purchase order canceled</td><td></td><td></td><td></td><td></td><td></td><td>✔️</td><td><code>INBOUND_PROCESS_PURCHASE_ORDER_CANCELED</code></td></tr><tr><td>Pick job closed</td><td></td><td>✔️*</td><td>✔️*</td><td>✔️</td><td></td><td></td><td><code>INVENTORY_FACILITY _STOCK_CHANGED,</code><br><code>INVENTORY_ STOCKS_CREATED,</code><br><code>INVENTORY_ STOCKS_VALUE_ CHANGED,</code><br><code>INVENTORY_ STOCKS_DELETED</code></td></tr><tr><td>Pick job restowed</td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td>Pick job restarted</td><td>✔️</td><td></td><td>✔️*</td><td></td><td></td><td></td><td><code>INVENTORY_FACILITY _STOCK_CHANGED,</code><br><code>INVENTORY_ STOCKS_CREATED,</code><br><code>INVENTORY_ STOCKS_VALUE_ CHANGED</code></td></tr><tr><td>Handover job closed</td><td></td><td>✔️**</td><td></td><td>✔️**</td><td></td><td></td><td><code>INVENTORY_FACILITY _STOCK_CHANGED,</code><br><code>INVENTORY_ STOCKS_DELETED,</code><br><code>INVENTORY_ STOCKS_VALUE_CHANGED</code></td></tr><tr><td>Pick job short picked</td><td></td><td></td><td></td><td>✔️***</td><td></td><td></td><td><code>INVENTORY_ STOCKS_DELETED,</code><br><code>INVENTORY_ STOCKS_VALUE_CHANGED,</code><br><code>INVENTORY_FACILITY _STOCK_CHANGED</code></td></tr><tr><td>Stow job line item taken</td><td></td><td></td><td>✔️</td><td>✔️</td><td></td><td></td><td><code>INVENTORY_ STOCKS_CREATED,</code><br><code>INVENTORY_ STOCKS_VALUE_ CHANGED,</code><br><code>INVENTORY_ STOCKS_DEL</code></td></tr><tr><td>Stow job line item stowed</td><td></td><td></td><td>✔️</td><td>✔️</td><td></td><td></td><td><code>INVENTORY_ STOCKS_CREATED,</code><br><code>INVENTORY_ STOCKS_VALUE_ CHANGED,</code><br><code>INVENTORY_ STOCKS_DELETED</code></td></tr></tbody></table>

\* Only if "Is [outboundStockConfiguration](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#outbound-stock-configuration).trackOutboundStock true\
AND outboundStockConfiguration.clearTrigger.event =\
"handoverjob-handed-over\_event-v1" is false

\*\* Only if "Is [outboundStockConfiguration](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#outbound-stock-configuration).trackOutboundStock true\
AND outboundStockConfiguration.clearTrigger.event =\
"handoverjob-handed-over\_event-v1" is true

\*\*\* Only if [facilityStockConfiguration.shortpick](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#short-pick-configuration) config is active


# Out of stock behavior and configuration

The out-of-stock behavior is a property of a `listing` that defines how the system handles orders containing a product that is currently unavailable for immediate shipment. A listing can be configured as backorderable, preorderable, restockable, or both preorderable and restockable.

If different out-of-stock rules are needed for different facility groups or orders, a `context` can be added to the configuration. This allows for more granular control over the behavior. More information is available in the section on [contextual configurations](#make-a-listing-preorderable-and-restockable-with-context).

## Make a listing backorderable

To make a listing backorderable, send a `PATCH` or `PUT` request to update the listing with the following JavaScript Object Notation (JSON) payload.

```http
PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/listings/{tenantArticleId}
```

```json
{
  "actions": [
    {
      "action": "ModifyListing",
      "outOfStockBehaviour": "BACKORDER"
    }
  ],
  "version": 2
}
```

## Make a listing preorderable

To make a listing preorderable, update the listing with the following payload. The `start` field within the `availabilityTimeframe` object specifies the date and time when picking can begin for the pre-ordered items.

```http
PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/listings/{tenantArticleId}
```

```json
{
    "version": 2,
    "actions": [
        {
            "action": "ModifyListing",
            "outOfStockBehaviour": "PREORDER",
            "outOfStockConfig": {
                "preorder": {
                    "availabilityTimeframe": {
                        "start": "2025-12-01T08:45:50.525Z"
                    }
                }
            }
        }
    ]
}
```

## Make a listing restockable

To make a listing restockable, update the listing with the following payload. The `restockableInDays` field defines the number of days until the listing can be replenished in the facility. A value of `0` is interpreted as the item being infinitely restockable.

```http
PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/listings/{tenantArticleId}
```

```json
{
    "version": 2,
    "actions": [
        {
            "action": "ModifyListing",
            "outOfStockBehaviour": "RESTOCK",
            "outOfStockConfig": {
                "restock": {
                    "restockableInDays": 5
                }
            }
        }
    ]
}
```

## Make a listing preorderable and restockable with context

To make a listing restockable and preorderable only in certain contexts, update the respective listing via PATCH or PUT with the below JSON body. In this example, the listing is only preorderable & restockable if its facility belongs to the [facility group](https://docs.fulfillmenttools.com/documentation/getting-started/facilities/facility-groups) with ID "12345" AND the order does not have the [tag](https://docs.fulfillmenttools.com/documentation/getting-started/tags) "click-and-collect". The priority is needed to ensure a clear sequence when considering the configuration in routing.

{% hint style="info" %}
More information on contexts can be found in the [Context article](https://docs.fulfillmenttools.com/documentation/apis/context).
{% endhint %}

```http
PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/listings/{tenantArticleId}
```

```json
{
  "actions": [
    {
      "action": "ModifyListing",
      "outOfStockBehaviourByContexts": [
        {
          "priority": 1,
          "context": [
            {
              "type": "FACILITY_GROUP",
              "values": [
                "12345"  // ID of facility group.
              ]
            },
            {
              "type": "TAG_REFERENCE",
              "operator": "NOT",
              "values": [
                "click-and-collect"
              ]
            }
          ],
          "outOfStockBehaviour": "PREORDER_AND_RESTOCK",
          "outOfStockConfig": {
            "preorder": {
              "availabilityTimeframe": {
                "start": "2025-12-01T08:45:50.525Z"
              }
            },
            "restock": {
              "restockableInDays": 5
            }
          }
        }
      ]
    }
  ],
  "version": 2
}
```

## Define exceptions from out-of-stock behavior

To set exceptions from the out-of-stock behavior the `outOfStockBehaviour` in the `outOfStockBehaviourByContexts` must be set to `NONE`. In that case a `outOfStockConfig` must not be defined.

In the example below, the default behaviour for the listing is that it is restockable in 5 days. If the ordering facility belongs to the facility group **“12345”**, the listing is restockable in 4 days. If the ordering facility is part of the facility group **“6789”**, the listing is not restockable at all.

```http
PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/listings/{tenantArticleId}
```

```json
{
  "actions": [
    {
      "action": "ModifyListing",
      "outOfStockBehaviour": "RESTOCK",
      "outOfStockConfig": {
        "restock": {
          "restockableInDays": 5
        }
      },
      "outOfStockBehaviourByContexts": [
        {
          "priority": 1,
          "context": [
            {
              "type": "FACILITY_GROUP",
              "values": [
                "12345"  // ID of facility group.
              ]
            }
          ],
          "outOfStockBehaviour": "RESTOCK",
          "outOfStockConfig": {
            "restock": {
              "restockableInDays": 4
            }
          }
        },
        {
          "priority": 2,
          "context": [
            {
              "type": "FACILITY_GROUP",
              "values": [
                "6789"
              ]
            }
          ],
          "outOfStockBehaviour": "NONE"
        }
      ]
    }
  ],
  "version": 2
}
```


# External stock change reasons

External stock change reasons represent user-defined reasons for stock movements within a facility. These reasons can optionally be included in stow line items to explain why a specific action was performed.

{% hint style="warning" %}
fulfillmenttools doesn't process or react to external stock change reasons. They exist solely for user-defined purposes.
{% endhint %}

## Working with external stock change reasons

External stock change reasons can be handled in one of two ways:

1. **Managed externally**
   * Reasons are not preconfigured in fulfillmenttools.
   * Users can provide custom reasons directly when creating stow line items.
   * **Note**: Custom reasons provided externally are not validated by fulfillmenttools.
2. **Managed within fulfillmenttools**
   * Reasons are preconfigured via [external stock change reasons REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/externalstockchangereasons).
   * When creating stow line items, preconfigured reasons are linked by specifying either their `id` or `tenantReasonId`.

{% hint style="info" %}
[External stock change reasons REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/externalstockchangereasons)
{% endhint %}

To preconfigure an external stock change reason, POST an external stock change reason, providing:

* `active`: `true` or `false` (if set to false, the reason can no longer be linked in `stowLineItems`)
* Optional `customAttributes`: can contain information of interest to connectors or services outside of fulfillmenttools. fulfillmenttools doesn't process or react to [customAttributes](https://docs.fulfillmenttools.com/documentation/getting-started/custom-attributes).
* `reasonLocalized`: Localized reasons, see [the Localization article.](https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization)
* Optional `tenantReasonId`: External identifier. Can be used, for example, to map reason codes from ERP systems


# Outbound stocks

This guide explains the setup process for outbound stock tracking.

{% hint style="success" %}

#### Prerequisites

* [Picking](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking) must be done with the fulfillmenttools
* [Handover](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/handover) must be done with the fulfillmenttools
  {% endhint %}

## Configuration

### Create an outbound storage location

An outbound storage location is required for items that have been picked and are ready for handover to a shipping provider. The defined location does not need to represent a physical storage space but should map the concept of outbound stock. This location can be created in Backoffice or through the API.

The location must comply with the following requirements:

* `type` must be `BULK_STORAGE`
* The stock at an outbound storage location is unavailable for orders and should not be picked or moved, except for handover. Therefore, it must have the following trait configuration:
  * `ACCESSIBLE: false`
  * `PICKABLE: false`
  * `OUTBOUND: true`
* `name`: A descriptive name, such as "Outgoing Goods", is recommended to clarify its function and prevent users from manually adjusting stock in this location

Below is an example API call to create the storage location.

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/storagelocations
```

{% endtab %}

{% tab title="Request" %}

```json
{
  "name": "Outgoing Goods",
  "tenantLocationId": "outbound-1",
  "type": "BULK_STORAGE",
  "scannableCodes": [],
  "runningSequences": [],
  "traitConfig": [
    {
      "trait": "ACCESSIBLE",
      "enabled": false
    },
    {
      "trait": "PICKABLE",
      "enabled": false
    },
    {
      "trait": "OUTBOUND",
      "enabled": true
    }
  ]
}
```

{% endtab %}
{% endtabs %}

A successful request returns an `HTTP 201 Created` response containing the created storage location.

The `id` from the response of the created storage location is required for the next step.

### Enable the configuration

The `FacilityInventoryConfiguration` must be created or updated to enable outbound tracking. The example below assumes a `FacilityInventoryConfiguration` is already present. If it's not already present, use the `POST` endpoint. Ensure that previous settings in the configuration are not overwritten.

Configure the following fields in the `outboundStockConfiguration` object:

* `trackOutboundStock`: Activates or deactivates the feature without deleting previously defined settings.
* `locationRef`: References the `id` of the outbound storage location created in the previous step.
* `clearTrigger`: Specifies when the stock should be deleted in the respective facility.
  * `event`:
    * Use `pick-job-closed_event-v1` if the stock should be deleted after picking.
    * Use `handoverjob-handed-over_event-v1` if the stock should be deleted after being handed over to another party, such as a carrier.
  * `tagFilter`:
    * Can be configured to allow for further granularity.
    * Each entry in the `tagFilter` array represents a condition, and all conditions must be fulfilled.
      * Each value in the `allowedValues` array represents a possible value, one of which must be matched.
      * If the event is a pick job event, the conditions will be evaluated against the tag array in the pick job.
      * If the event is a handover job event, the conditions will be evaluated against the tag array in the handover job.

{% tabs %}
{% tab title="Endpoint" %}

```http
PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/configurations/inventory
```

{% endtab %}

{% tab title="Request" %}

```json
{
  "version": 2,
  "outboundStockConfiguration": {
    "trackOutboundStock": true,
    "locationRef": "{YOUR_LOCATION_REF}",
    "clearTrigger": [
        {
            "event": "handoverjob-handed-over_event-v1"
        },
        {
            "event": "pick-job-closed_event-v1",
            "tagFilter": [
              {
                "tagId": "order-type",
                "allowedValues": [
                  "production"
                ]
              }
            ]
        }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

A successful request returns either an `HTTP 200 OK` or `HTTP 201 Created` response containing the updated or created configuration.

### Verify the configuration

After these steps, outbound location tracking for the facility is enabled. To verify the setup, complete a pick job in this facility and observe the stock changes at the outbound location using the stocks endpoint.


# Categories

Categories can be used to mark [listings](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing) as belonging to a specific group. A listing can belong to one to many categories. The `categoryRef` on the listing allows assigning categories to a listing. Categories can be used, for example, to define discounts for certain article groups.

Listings can be assigned to an article category by:

1. Creating a category via [API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/categories)
2. Referencing the ID of the category in the respective listing(s)

Categories can be created, edited and deleted via [REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/categories). Categories that are assigned to one or more listings cannot be deleted.

{% hint style="info" %}
For a complete overview of the category endpoints, refer to the [API documentation for Categories](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/categories).
{% endhint %}

## Create a category

To create a category, send a `POST` request to the following endpoint with the category data in the request body.

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/categories
```

**Example request body**

```json
{
  "nameLocalized": {
    "de_DE": "Lebensmittel",
    "en_US": "groceries"
  },
  "tenantCategoryId": "G-01"
}
```

A successful request returns a `201 CREATED` response with a body that includes the `id` of the newly created category.

**Example response body**

```json
{
    "lastModified": "2025-04-25T09:06:54.737Z",
    "version": 1,
    "nameLocalized": {
        "de_DE": "Lebensmittel",
        "en_US": "groceries"
    },
    "tenantCategoryId": "G-01",
    "id": "1f6fe169-893f-4e95-8ac0-38c9e6eca068",
    "created": "2025-04-25T09:06:54.737Z",
    "name": "groceries"
}
```


# Category endpoints

## The Category object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Category":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version","created","lastModified"],"title":"Category","type":"object","description":"Category"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"}}}}
```

## GET /api/categories/{categoryId}

> Get category

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read categories.","name":"Categories"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Category":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version","created","lastModified"],"title":"Category","type":"object","description":"Category"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/categories/{categoryId}":{"get":{"deprecated":false,"description":"","operationId":"getCategory","parameters":[{"in":"path","name":"categoryId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Get category","tags":["Categories"]}}}}
```

## GET /api/categories

> List categories

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read categories.","name":"Categories"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Category":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version","created","lastModified"],"title":"Category","type":"object","description":"Category"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/categories":{"get":{"deprecated":false,"description":"","operationId":"getCategories","parameters":[{"description":"The number of items to return.","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"number"}},{"description":"The ID of the last item from the previous page. The next page will start after this ID.","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List categories","tags":["Categories"]}}}}
```

## POST /api/categories

> Create category

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read categories.","name":"Categories"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CategoryForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"}},"required":["nameLocalized"],"title":"CategoryForCreation","type":"object","description":"CategoryForCreation"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"Category":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version","created","lastModified"],"title":"Category","type":"object","description":"Category"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/categories":{"post":{"deprecated":false,"description":"","operationId":"createCategory","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create category","tags":["Categories"]}}}}
```

## DELETE /api/categories/{categoryId}

> Delete category

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read categories.","name":"Categories"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Category":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version","created","lastModified"],"title":"Category","type":"object","description":"Category"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/categories/{categoryId}":{"delete":{"deprecated":false,"description":"","operationId":"deleteCategory","parameters":[{"in":"path","name":"categoryId","required":true,"schema":{"type":"string"}},{"in":"query","name":"forceDeletion","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Delete category","tags":["Categories"]}}}}
```

## List categories (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for Category

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read categories.","name":"Categories"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CategorySearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/CategorySearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/CategorySort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"CategorySearchPayload","type":"object","description":"CategorySearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"CategorySearchQuery":{"properties":{"nameLocalized":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringFilter"},{"$ref":"#/components/schemas/KeyExistsFilter"}]},"description":"Search by nameLocalized","type":"object"},"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/CategorySearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/LocalizedStringSearchFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/CategorySearchQuery"},"maxItems":500,"type":"array"},"tenantCategoryId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantCategoryId"}},"title":"CategorySearchQuery","type":"object","description":"CategorySearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"KeyExistsFilter":{"properties":{"exists":{"description":"Search all entities which have or do not have this key defined","type":"boolean"}},"title":"KeyExistsFilter","type":"object","description":"KeyExistsFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"LocalizedStringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"LocalizedStringSearchFilter","type":"object","description":"LocalizedStringSearchFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"CategorySort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"id":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantCategoryId":{"enum":["ASC","DESC"],"type":"string"}},"title":"CategorySort","type":"object","description":"CategorySort"},"CategoryPaginatedResult":{"properties":{"categories":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","categories"],"title":"CategoryPaginatedResult","type":"object","description":"CategoryPaginatedResult"},"Category":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version","created","lastModified"],"title":"Category","type":"object","description":"Category"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/categories/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for Category","operationId":"searchCategory","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategorySearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List categories (search)","tags":["Categories"]}}}}
```

## PUT /api/categories/{categoryId}

> Replace category

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read categories.","name":"Categories"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CategoryForUpdate":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version"],"title":"CategoryForUpdate","type":"object","description":"CategoryForUpdate"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"Category":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleStringConstrained"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"tenantCategoryId":{"description":"unique identifier for categories used in the customer systems","maxLength":256,"minLength":2,"pattern":"^[A-Za-z0-9_-]+$","type":"string"},"version":{"type":"number"}},"required":["nameLocalized","version","created","lastModified"],"title":"Category","type":"object","description":"Category"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/categories/{categoryId}":{"put":{"deprecated":false,"description":"","operationId":"replaceCategory","parameters":[{"in":"path","name":"categoryId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryForUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Replace category","tags":["Categories"]}}}}
```


# Reservations

A reservation is made after an order has been assigned to a facility. The reservation reserves an existing or future stock for a customer. If no stock is available, the reservation is saved and assigned to the first available stock.

## Creating reservations

A reservation is created when an [order](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/orders) is placed or a [delivery promise](https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising/delivery-promise) is made to a consumer. fulfillmenttools continuously evaluates existing reservations redistributes them when necessary. During reservation creation, the system identifies the most suitable stock — a process called [candidate selection](#stock-candidate-selection).

### Stock candidate selection

When realizing or reassigning a reservation, fulfillmenttools finds the best stock to place it on based on various criteria.

A **stock** qualifies as a candidate if:

* Available quantity is greater than 0 (quantity minus existing reservations).
* Has `PICKABLE` and `ACCESSIBLE` traits. Both [inventory traits](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits) are enabled by default.
* [`availableUntil`](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability#stock-properties-and-available-until) is later than the current time (if the order has no desired delivery day) or the order's delivery date.

An **expected stock** qualifies as a candidate if the order has a desired delivery date and:

* Available quantity is greater than 0.
* Arrival date of the stock ([`purchaseOrder`](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process/purchase-order)`.requestedDate`) is before the [latest possible pick start](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking/latest-picking-start).
* Not delayed (`purchaseOrder.requestedDate` is in the future).

**Ranking:**

* **Stock** candidates: ranked by picking sequence location score if configured (highest first), then `availableUntil` (earliest expiring first), then `receiptDate` (oldest first).
* **Expected stock** candidates: ranked by expected date (latest first), then `availableUntil` (earliest expiring first).
* Expected stock is ranked higher than regular stock to avoid blocking inventory that could serve other demand.

## Redistributing reservations

After a reservation has been assigned to an (expected) stock, fulfillmenttools continuously ensures that the reservations can still be fulfilled. If reservations can't be fulfilled anymore, fulfillmenttools will try to redistribute them to possible (expected) [stock candidate selection](#stock-candidate-selection).

The system reevaluates reservations whenever stock or expected stock changes, for example, when:

* **Stock is updated**
* **Stock is deleted**
* **Stock becomes non-pickable or non-accessible**: This could mean the stock was relocated within the facility to a location without the pickable or accessible trait.
* **Expected stock arrival date changes:** If users are notified of changes to a delivery's arrival date, we recommend adjusting the requested date in the purchase order. This will trigger a check to ensure that all reservations can still be fulfilled.
* **Expected stock quantity changes:** If users are notified of changes to the requested items in a delivery, we recommend updating the purchase order to reflect those changes. This will trigger a check to ensure that all reservations can still be fulfilled.
* **A purchase order is canceled**

{% hint style="warning" %}
When a reservation is removed from expected stock (for example, because an order was canceled), the system doesn't use this newly released expected stock to resolve any existing over‑reservations automatically.
{% endhint %}

{% hint style="info" %}
Reservations in a facility can be manually rechecked and optimized, for example, to determine whether reservations can be reassigned to a later-arriving expected stock.

This functionality is intended for troubleshooting and is available only upon request. If you encounter reservation issues, [contact our Support team](https://ocfulfillment.atlassian.net/servicedesk/customer/portal/1/group/11/create/39) to trigger this process.​
{% endhint %}

### Exceptions to automatic reassignment

Reservations aren't automatically moved if:

* **Expected stock becomes delayed:** In this case, users are expected to update the requested date of the purchase order via the [API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/purchaseorders/-purchaseOrderId-) or cancel the purchase order (via [API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/purchaseorders/-purchaseOrderId-) or [Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/inbound#how-to-cancel-an-inbound-process)).
* **Stock expires or reaches its available until date:** In this case, users are expected to mark expired stock as non-pickable, non-accessible, or delete it completely. This can be done via the [stock API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/stocks/-stockId-) or Backoffice.

## Over-reservations

If no stock is available when a reservation is created, an over-reservation is automatically created. It's automatically assigned once stock meeting the reservation criteria becomes available.

In Backoffice, over-reservations appear alongside all other reservations in the [Stock overview view](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/inventory). Facilities with over-reservations show an info icon and tooltip.

An over-reservation is calculated when the sum of reserved and safety stock exceeds the available pickable and accessible stock. An over-reservation is only reported when other reservations exist. If safety stock alone exceeds the available stock but there are no reservations, an over-reservation isn't shown.

{% hint style="info" %}
The order remains available for picking during the defined timeframe. If a short‑pick is reported, the system can re‑route the order or allow a manual reassignment.
{% endhint %}

## Reservation prioritization

When stock becomes available at a facility, reservations are handled in a clear, defined order.

### 1. Over-reservations (reservations without stock)

Over-reservations are handled first.

Sorting:

* Reservations of orders that must be picked earliest
* Largest reservation quantity (For example, a reservation for 5 items is prioritized over one for 2 items.). This is done to avoid orders being shipped in multiple shipments.

### 2. Reservations on expected stock

Only applies if `expectedStock.generateFromRoutingPlan = true`.

Sorting:

* Earliest `availableFrom`
* Largest reservation quantity

{% hint style="info" %}
For details, refer to [the Global Inventory Hub configurations article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations).
{% endhint %}

### 3. Tie-breaker

If several reservations qualify at the same time, the reservation with the earliest pick start is improved first.

## Removing reservations

Reservations are removed when fulfillment progresses or is canceled. By default, reservations are automatically removed after the related pick job is closed, aborted, rerouted, or canceled.

There are three independent release paths:

<table><thead><tr><th width="209.49609375">Path</th><th width="320.6640625">Trigger</th><th>Scope</th></tr></thead><tbody><tr><td><strong>Facility unassignment</strong></td><td>Routing plan unassigned (due to reroute or cancellation).</td><td>All reservations for the routing plan.</td></tr><tr><td><strong>Operational release</strong></td><td><p>Pick job closed/aborted/rerouted, or handover job completed/aborted.</p><p>Use the <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#reserved-stock-configuration">reserved stock configuration</a> to define a different removal event.</p></td><td>All reservations for the routing plan.</td></tr><tr><td><strong>Action API</strong></td><td>If a facility doesn't use operational entities (such as pick or handover jobs), reservations can be removed via the <a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/reservations/actions">REST API</a>.</td><td>Individual reservations by ID, order reference, routing plan reference, or predicate. See <a href="#reservations-actions">reservation actions for more information</a>.</td></tr></tbody></table>

{% hint style="info" %}
Stock can be marked as outbound first and removed later using the [outbound stock configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/outbound-stocks).
{% endhint %}

## Use case examples

### Reservation completed without issues (happy path)

A customer places an order online. Physical stock is available, and all conditions are met.

**Starting situation**

<table data-header-hidden><thead><tr><th width="374"></th><th></th></tr></thead><tbody><tr><td><strong>Order</strong></td><td>Online shop order</td></tr><tr><td><strong>Order delivery date</strong></td><td>15 February 2026</td></tr><tr><td><strong>Stock</strong></td><td>50 units, pickable and accessible</td></tr><tr><td><strong>Expected stock</strong></td><td>0</td></tr><tr><td><strong>Stock expiry date</strong></td><td>31 March 2026 (after delivery date)</td></tr><tr><td><strong>Configuration</strong></td><td>Default configuration</td></tr></tbody></table>

**Timeline**

<table><thead><tr><th width="115.91015625">Timeline</th><th width="327.4296875">Event</th><th>Action</th></tr></thead><tbody><tr><td>1</td><td>The consumer places an order, and it's assigned to a facility. Valid stock is checked.</td><td>Stock is pickable, accessible, and valid until 31 March 2026. All conditions met. A reservation is created on the physical stock.</td></tr><tr><td>2</td><td>Pick job is started</td><td>Users begin picking the reserved items.</td></tr><tr><td>3</td><td>Pick job is closed</td><td>Reservations and stock are automatically removed.</td></tr></tbody></table>

**Result**

The reservation is completed without manual intervention.

### Delayed delivery (expected stock)

**Starting situation**

<table data-header-hidden><thead><tr><th width="374"></th><th></th></tr></thead><tbody><tr><td><strong>Order</strong></td><td>Online shop order</td></tr><tr><td><strong>Order delivery date</strong></td><td>20 February 2026</td></tr><tr><td><strong>Stock</strong></td><td>0</td></tr><tr><td><strong>Expected stock</strong></td><td>Purchase order: 100 units, planned arrival 12 February 2026</td></tr><tr><td><strong>Stock expiry date</strong></td><td>-</td></tr><tr><td><strong>Configuration</strong></td><td>Default configuration</td></tr></tbody></table>

**Timeline**

<table><thead><tr><th width="115.91015625">Timeline</th><th width="327.4296875">Event</th><th>Action</th></tr></thead><tbody><tr><td>1</td><td>Order is received</td><td>System finds no physical stock. Expected stock arriving on 12 February qualifies (arrival before pick start). A reservation is placed on the expected stock.</td></tr><tr><td>2</td><td>Supplier reports delay: new arrival 25 February 2026</td><td>The new date is in the future, but now falls after the order's delivery date (20 February). Expected stock is now treated as delayed.</td></tr><tr><td>3</td><td>Reservation can no longer be fulfilled in time</td><td>The reservation on the expected stock is not automatically redistributed. It remains in place but can no longer be fulfilled as-is.</td></tr><tr><td>4</td><td>User resolves the situation manually</td><td>The info icon and tooltip in Backoffice indicate the facility has over-reservations. The user must update the purchase order or adjust the stock manually in Backoffice.</td></tr><tr><td>5</td><td>Pick job is started and closed</td><td>Users begin picking the reserved items. Reservations and stock are automatically removed after the pick job is finished.</td></tr></tbody></table>

{% hint style="warning" %}
Important: The system doesn't automatically reassign reservations on delayed expected stock. A manual action is required. For example, correct the purchase order date, update the stock in the facility, or reroute the order.
{% endhint %}

**Result**

The reservation is held until the delayed delivery arrives. If it arrives too late, the order's promised delivery date will be missed. To ensure on-time fulfillment, manual intervention is needed.

**What should I do as a user?**

* Update the purchase order in the system to reflect the new arrival date.
* Check whether an alternative source or another facility can fulfill the order.
* Notify the customer of the delay and update the delivery date if needed.

### Over-reservation

**Starting situation**

<table data-search="false"><thead><tr><th width="374"></th><th></th></tr></thead><tbody><tr><td><strong>Order</strong></td><td>Two orders of 10 units each (Order A and Order B)</td></tr><tr><td><strong>Order delivery date A</strong></td><td>18 February 2026 (earlier)</td></tr><tr><td><strong>Order delivery date B</strong></td><td>22 February 2026 (later)</td></tr><tr><td><strong>Stock</strong></td><td>0</td></tr><tr><td><strong>Expected stock</strong></td><td>0</td></tr><tr><td><strong>Stock expiry date</strong></td><td>-</td></tr><tr><td><strong>Configuration</strong></td><td>Default configuration</td></tr></tbody></table>

**Timeline**

<table><thead><tr><th width="115.91015625">Timeline</th><th width="327.4296875">Event</th><th>Action</th></tr></thead><tbody><tr><td>1</td><td>Both orders are received</td><td>No stock available. System creates over-reservations for both orders. These appear in Backoffice with an info icon.</td></tr><tr><td>2</td><td>New goods receipt: 10 units arrive</td><td>System detects available stock. Prioritization begins.</td></tr><tr><td>3</td><td>System prioritizes over-reservations</td><td>Order A has the earlier delivery date and is served first. Order A receives a reservation for the 10 units.</td></tr><tr><td>4</td><td>Order B remains an over-reservation</td><td>No further stock available. Order B remains over-reserved until additional stock arrives.</td></tr><tr><td>5</td><td>Another new goods receipt: 10 units</td><td>Order B is now also assigned stock. Over-reservation is resolved.</td></tr><tr><td>6</td><td>Pick jobs are started and closed</td><td>Users begin picking the reserved items. Reservations and stock are automatically removed after the pick jobs are finished.</td></tr></tbody></table>

**Result**

Over-reservations are resolved automatically as soon as matching stock becomes available. Priority is based on the earliest delivery date. So, no manual action needed.

**What do I see in Backoffice?**

* Facilities with over-reservations show an info icon with a tooltip.
* Over-reservations appear in the reservations list alongside all other reservations.
* Once the stock arrives, the over-reservation is automatically resolved.

## Using the reservations endpoints

### Search reservations

To search for reservations, execute the following POST request with a JSON body:

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/reservations/search
```

{% endtab %}

{% tab title="Request body" %}

```json
{
    "query": {
        "tenantArticleId": {
            "eq": "11111"
        },
        "facilityRef": {
            "eq": "d083f631-9f4c-463b-85d4-9414fb19239f"
        },
        "relatedRefs": {
            "routingPlanRefs": {
                "contains": {
                    "eq": "85d25d89-f8a7-4600-9082-0d8b2d89a6af"
                }
            }
        }
    }
}
```

The example above searches for reservations matching a specific `tenantArticleId`, `facilityRef`, and `routingPlanRef`.
{% endtab %}
{% endtabs %}

{% hint style="info" %}
You can also search the [order API](broken://pages/cdb530a0c41f60bad0543bc5002190446a266d9e) by tenant article ID to cross reference reservations on items.
{% endhint %}

### Reservations actions

The reservation actions endpoint uses the following fields to define its scope:

* The `reservationSelector` field selects reservations at a high level, for example, by order.
* The `reservationPredicate` field refines the selection made by the `reservationSelector`. This allows for more granular control, such as removing reservations for only specific line items within an order.
* The response provides insights into the success of the operations to remove reservations and reduce stock.

#### Remove reservations and reduce stock

To remove reservations and the corresponding reserved stock, use the `REMOVE_RESERVATIONS_REDUCE_STOCKS` action.

Execute the following POST request with the specified JSON body:

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/reservations/actions
```

{% endtab %}

{% tab title="Request body" %}

```json
{
    "name": "REMOVE_RESERVATIONS_REDUCE_STOCKS",
    "reservationSelector": {
        "orderRefs": [
            "order-id-01"
        ],
        "reservationPredicate": {
            "and": [
                {
                    "facilityRef": {
                        "eq": "facility-id-01"
                    }
                },
                {
                    "tenantArticleId": {
                        "eq": "tenantarticleid-01"
                    }
                }
            ]
        }
    }
}
```

{% endtab %}

{% tab title="Response body" %}
A successful request returns a `200 OK` response with the following body.

```json
[
    {
        "reservation": {
            "id": "reservation-id-01"
        },
        "status": "DELETED",
        "stockOperations": [
            {
                "status": "REDUCED",
                "stock": {
                    "id": "stock-id-01",
                    "version": 1
                }
            }
        ]
    }
]
```

{% endtab %}
{% endtabs %}

#### Remove reservations and keep stock

To remove only the reservations without reducing stock, use the `REMOVE_RESERVATIONS_KEEP_STOCKS` action. In this transaction, no stock is reduced.

Execute the following POST request with the specified JSON body:

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/reservations/actions
```

{% endtab %}

{% tab title="Request body" %}

```json
{
    "name": "REMOVE_RESERVATIONS_KEEP_STOCKS",
    "reservationSelector": {
        "orderRefs": [
            "order-id-01"
        ],
        "reservationPredicate": {
            "and": [
                {
                    "facilityRef": {
                        "eq": "facility-id-01"
                    }
                },
                {
                    "tenantArticleId": {
                        "eq": "tenantarticleid-01"
                    }
                }
            ]
        }
    }
}
```

{% endtab %}

{% tab title="Response body" %}
A successful request returns a `200 OK` response with the following body.

```json
[
    {
        "reservation": {
            "id": "reservation-id-01"
        },
        "status": "DELETED"
    }
]
```

{% endtab %}
{% endtabs %}


# Reservations endpoints

## The Reservation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Reservation":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"host":{"$ref":"#/components/schemas/ReservationHost"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"quantity":{"type":"number"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/RelatedRefs"}]},"tenantArticleId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","facilityRef","host","id","quantity","relatedRefs","tenantArticleId"],"title":"Reservation","type":"object","description":"Reservation"},"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"},"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"}}}}
```

## Get reservation

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints handle reservations.","name":"Reservations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Reservation":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"host":{"$ref":"#/components/schemas/ReservationHost"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"quantity":{"type":"number"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/RelatedRefs"}]},"tenantArticleId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","facilityRef","host","id","quantity","relatedRefs","tenantArticleId"],"title":"Reservation","type":"object","description":"Reservation"},"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"},"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/reservations/{reservationId}":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"getReservation","parameters":[{"in":"path","name":"reservationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reservation"}}},"description":"Reservation details"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Get reservation","tags":["Reservations"]}}}}
```

## List reservations (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for Reservation

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints handle reservations.","name":"Reservations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReservationSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/ReservationSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/ReservationSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"ReservationSearchPayload","type":"object","description":"ReservationSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"ReservationSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/ReservationRelatedRefsFilter"}],"description":"Nested search by relatedRefs"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"ReservationSearchQuery","type":"object","description":"ReservationSearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"ReservationRelatedRefsFilter":{"properties":{"orderRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by orderRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"transferRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by transferRefs"}},"title":"ReservationRelatedRefsFilter","type":"object","description":"ReservationRelatedRefsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ReservationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ReservationSort","type":"object","description":"ReservationSort"},"ReservationPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"reservations":{"items":{"$ref":"#/components/schemas/Reservation"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","reservations"],"title":"ReservationPaginatedResult","type":"object","description":"ReservationPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Reservation":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"host":{"$ref":"#/components/schemas/ReservationHost"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"quantity":{"type":"number"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/RelatedRefs"}]},"tenantArticleId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","facilityRef","host","id","quantity","relatedRefs","tenantArticleId"],"title":"Reservation","type":"object","description":"Reservation"},"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"},"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/reservations/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for Reservation","operationId":"searchReservation","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReservationSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReservationPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List reservations (search)","tags":["Reservations"]}}}}
```

## Call reservations action

> This part of the API is in Alpha status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />REMOVE\_RESERVATIONS\_KEEP\_STOCKS: Removes reservations without modifying stock levels.\
> \
> &#x20;     REMOVE\_RESERVATIONS\_AND\_REDUCE\_STOCKS:  Removes reservations and reduces stock levels accordingly.<br>

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints handle reservations.","name":"Reservations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReservationAction":{"properties":{"name":{"description":"Which action to perform","enum":["REMOVE_RESERVATIONS_REDUCE_STOCKS","REMOVE_RESERVATIONS_KEEP_STOCKS"],"type":"string"},"reservationSelector":{"allOf":[{"$ref":"#/components/schemas/ReservationActionSelector"}],"minProperties":1}},"required":["name","reservationSelector"],"title":"ReservationAction","type":"object","description":"ReservationAction"},"ReservationActionSelector":{"properties":{"orderRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"reservationPredicate":{"$ref":"#/components/schemas/ReservationSearchQuery"},"reservationRefs":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"tenantOrderIds":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"}},"title":"ReservationActionSelector","type":"object","description":"ReservationActionSelector"},"ReservationSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ReservationSearchQuery"},"maxItems":500,"type":"array"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/ReservationRelatedRefsFilter"}],"description":"Nested search by relatedRefs"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"ReservationSearchQuery","type":"object","description":"ReservationSearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"ReservationRelatedRefsFilter":{"properties":{"orderRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by orderRefs"},"pickJobRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by pickJobRefs"},"routingPlanRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by routingPlanRefs"},"transferRefs":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by transferRefs"}},"title":"ReservationRelatedRefsFilter","type":"object","description":"ReservationRelatedRefsFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"ReservationActionResult":{"properties":{"reservation":{"$ref":"#/components/schemas/StrippedReservation"},"status":{"enum":["DELETED"],"type":"string"},"stockOperations":{"items":{"$ref":"#/components/schemas/ReservationActionStockOperation"},"type":"array"}},"required":["status","reservation"],"title":"ReservationActionResult","type":"object","description":"ReservationActionResult"},"StrippedReservation":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"StrippedReservation","type":"object","description":"StrippedReservation"},"ReservationActionStockOperation":{"properties":{"status":{"enum":["REDUCED","DELETED"],"type":"string"},"stock":{"$ref":"#/components/schemas/ReservationStock"}},"required":["status","stock"],"title":"ReservationActionStockOperation","type":"object","description":"ReservationActionStockOperation"},"ReservationStock":{"properties":{"id":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"title":"ReservationStock","type":"object","description":"ReservationStock"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/reservations/actions":{"post":{"deprecated":false,"description":"This part of the API is in Alpha status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />REMOVE_RESERVATIONS_KEEP_STOCKS: Removes reservations without modifying stock levels.\n\n      REMOVE_RESERVATIONS_AND_REDUCE_STOCKS:  Removes reservations and reduces stock levels accordingly.\n","operationId":"performReservationActions","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReservationAction"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ReservationActionResult"},"type":"array"}}},"description":"List of reservation removal results with stock operations"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Call reservations action","tags":["Reservations"]}}}}
```

## List reservations

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints handle reservations.","name":"Reservations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReservationsPaginatedResult":{"properties":{"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"reservations":{"items":{"$ref":"#/components/schemas/Reservation"},"type":"array"},"total":{"minimum":0,"type":"number"}},"required":["total","pageInfo","reservations"],"title":"ReservationsPaginatedResult","type":"object","description":"ReservationsPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Reservation":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"host":{"$ref":"#/components/schemas/ReservationHost"},"id":{"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"quantity":{"type":"number"},"relatedRefs":{"allOf":[{"$ref":"#/components/schemas/RelatedRefs"}]},"tenantArticleId":{"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","facilityRef","host","id","quantity","relatedRefs","tenantArticleId"],"title":"Reservation","type":"object","description":"Reservation"},"ReservationHost":{"properties":{"reference":{"type":"string"},"type":{"enum":["STOCK","EXPECTED_STOCK","NONE"],"type":"string"}},"required":["reference","type"],"title":"ReservationHost","type":"object","description":"ReservationHost"},"RelatedRefs":{"properties":{"orderRefs":{"items":{"type":"string"},"type":"array"},"pickJobRefs":{"items":{"type":"string"},"type":"array"},"processRefs":{"items":{"type":"string"},"type":"array"},"routingPlanRefs":{"items":{"type":"string"},"type":"array"},"transferRefs":{"items":{"type":"string"},"type":"array"}},"title":"RelatedRefs","type":"object","description":"RelatedRefs"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/reservations":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"getPaginatedReservations","parameters":[{"description":"The number of items to return.","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"number"}},{"description":"The cursor to start after. The value is provided in the `pageInfo.endCursor` field of the response.","in":"query","name":"after","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReservationsPaginatedResult"}}},"description":"Reservation details"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List reservations","tags":["Reservations"]}}}}
```


# Inbound process

An inbound process maps all processes around incoming goods in a store or warehouse. This can include delivery of goods but also interfacility transfers or similar processes. Whenever a purchase order or a receipt is created, a corresponding inbound process is automatically created as well.

An overview of all inbound process can be found in the [inbound view](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/inbound) of Backoffice and in the [inventory app](https://docs.fulfillmenttools.com/documentation/apps/inventory-app). The process of checking and accepting incoming goods is represented via [receipts](#receipt).

The inbound process has sub-entities, which can be created and modified as part of the inbound process, or alternatively via their own endpoints.

## Sub-entities of inbound process

### Purchase order

A purchase order represents an order of goods for a facility. It is created by the ordering facility and contains information about the planned delivery date, the type, quantity and characteristics of the ordered items, as well as the name of the supplier. This information is represented by the below properties:

* `facilityRef`: reference of the ordering facility
* `requestedDate`: can be either set to "ASAP" (if the delivery is expected to arrive as soon as possible) or to a specific date & time
* `requestedItems`: contains information on the ordered items. Information on expiry dates or batch number can be specified in the [stock properties](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties).
* `supplier`: holds the name of the supplier. Displayed in the [inbound view](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/inbound) of Backoffice and in the [inventory app](https://docs.fulfillmenttools.com/documentation/apps/inventory-app).

After a purchase order has been created, [expected stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability) for the requested items is created. When desired, the expected stock can already be [used for incoming customer orders](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/expected-stock-in-availability).

### Receipt

A receipt represents the acceptance of goods in a facility. It contains information on the time of receipt and on accepted and rejected items. This information is represented by the below properties:

* `facilityRef`: reference of the receiving facility
* `receivedItems`: contains information on accepted and rejected items. Information on expiry dates or batch number can be specified in the [stock properties](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties).
* `comment:` can optionally contain information on received items

After a receipt was created, stock for the received items is created. If there were reservations on the expected stock, they are shifted to stock in the facility.

{% hint style="success" %}
**Rejected items in receipt**

Rejected items can be marked separately during goods receipt. The stock created from rejected items receives the condition "defective" and is not marked as "pickable" and "accessible". Thus, it will not be available for sale.
{% endhint %}

## Status of the inbound process

The inbound process itself as well as its sub-entities can have different status. Our clients show the status that are most relevant to the user in the [inbound view](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/inbound) and in the [inventory app](https://docs.fulfillmenttools.com/documentation/apps/inventory-app).

The inbound process status is a calculated status that depends on the status and content of its sub-entities.

<table data-search="false"><thead><tr><th>Status</th><th>Meaning</th><th>Entity</th></tr></thead><tbody><tr><td><code>OPEN</code></td><td>Delivery has not arrived yet</td><td><code>inboundProcess</code></td></tr><tr><td><code>PARTIAL_DELIVERY</code></td><td>Items in the delivery were missing</td><td><code>inboundProcess</code></td></tr><tr><td><code>CLOSED</code></td><td>All items that were announced via purchase order have arrived (either as accepted or rejected quantity) or purchase order was canceled.</td><td><code>inboundProcess</code></td></tr><tr><td><code>ON_HOLD</code></td><td>Inbound process should be paused for now. Can be set manually via Backoffice or via <a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/inboundprocesses/-inboundProcessId-">REST API</a>.</td><td><code>inboundProcess</code></td></tr><tr><td><code>OPEN</code></td><td>No functional meaning.</td><td><code>purchaseOrder</code></td></tr><tr><td><code>CANCELED</code></td><td>No further deliveries are expected. Can be set manually via Backoffice or via <a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/purchaseorders/-purchaseOrderId-">REST API</a>.</td><td><code>purchaseOrder</code></td></tr><tr><td><code>OPEN</code></td><td>Goods have arrived in a facility or will arrive soon.</td><td><code>receipt</code></td></tr><tr><td><code>IN_PROGRESS</code></td><td>Goods receipt for (one part of the) delivery has been started.</td><td><code>receipt</code></td></tr><tr><td><code>FINISHED</code></td><td>Goods receipt for (one part of the) delivery has been finished.</td><td><code>receipt</code></td></tr></tbody></table>

## Validation in inbound process

### Measurement unit validation in inbound processes <a href="#unit-validation-in-inbound-processes" id="unit-validation-in-inbound-processes"></a>

If there is a [measurement unit](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/measurement-units) key defined for a [listing](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing) that is part of the inboundProcess, each new line item in the requested items of the purchase order and in the received items of the receipt is validated against it: All quantities must match the unit of the listing.

This means that when creating an `inboundProcess` with a purchaseOrder with unit "xyz" and changing the listing.measurementUnitKey to something else ("qwe") the `inboundProcess.purchaseOrder` must now be patched/replaced to reflect the correct unit again before a receipt can be created. This is intentional and ensures the consistency of new stock levels in the facility.

{% hint style="warning" %}
In general, it's not advised to change the unit of a product in a facility without careful consideration. However, in some cases it might be desired to start with no unit on the listing (= no validation) and transition to stricter rules later.
{% endhint %}

{% hint style="info" %}
See the [Measurement units article](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/measurement-units) for more information.
{% endhint %}

### Stock property validation in inbound processes <a href="#unit-validation-in-inbound-processes" id="unit-validation-in-inbound-processes"></a>

If there are [stock properties](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties) defined for a [listing](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing) that is part of the inbound process, each new line item in the requested items of the purchase order and in the received items of the receipt is validated against it. The validation for requested and received items behaves slightly different as it is not expected that the exact properties of all items are known before they have arrived.

#### Validation for requested items

* All stock properties that are part of the requested items must also be defined in the stockProperties of the listing.
* Not all stock properties that are part of the listing must also be present in the requested items.
* This means, it is allowed to create a purchase order without stock properties in the requested items even though the included listing has stock properties defined.

#### Validation for receivedItems

* All stock properties that are part of the received items must also be defined in the stock properties of the listing.
* Not all stock properties that are part of the listing must also be present in the requested items. Only stock properties defined as **required** in the listing need to be present in both listing and receivedItems. This is because creating a stock without providing a value for a required property is forbidden and will fail.

## 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:

```http
POST https://{YOUR_TENANT_NAME}.fulfillmenttools.com/api/inboundprocesses
```

{% code title="Request body (JSON)" %}

```json
{
  "facilityRef": "CGN-01",
  "scannableCodes": ["12345"],
  "tenantInboundProcessId": "AB-01"
}
```

{% endcode %}

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

{% code title="Response (201 Created)" %}

```json
{
    "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
}
```

{% endcode %}


# Incoming goods and storage

The [inbound process](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process) and [stow job](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stow-jobs) are required to map the ordering, receipt, and storage of goods. The ordering of goods for facilities is mapped via a [purchase order](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process/purchase-order). The [receipt](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process/receipts) of these goods is communicated to the fulfillmenttools systems via a [receipt](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process/receipts). Purchase order and receipt both belong to an inbound process. Stow jobs are used for both storage of incoming goods as well as resolving of dispute cases or excess stock.

{% hint style="info" %}
More information can be found in the [Stow jobs](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stow-jobs) and [Inbound process](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process) articles.
{% endhint %}

## Use case examples

### Announcement and arrival of incoming goods

An admin wants to inform the fulfillmenttools systems that new goods will arrive and update inventory once the goods have arrived.

1. **An admin orders goods for a facility.**
   1. Create an inbound process using [`POST/api/inboundprocesses`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/inboundprocesses) and remember the`inboundProcessId`.
   2. Add a purchase order to the inbound process that was created in step 1 using [`PUT/api/inboundprocesses/{inboundProcessId}/purchaseorder`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/inboundprocesses/-inboundProcessId-/purchaseorder).

{% hint style="info" %}
Alternatively, a purchase order can be directly created via [`POST/api/purchaseorders`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/purchaseorders). In that case, an inbound process will be created automatically.
{% endhint %}

2. **The ordered goods physically arrive in the facility and are put in a goods receiving area.**
   1. Add a receipt to the inbound process using [`POST/api/inboundprocesses/{inboundProcessId}/receipts`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/inboundprocesses/-inboundProcessId-/receipts).
   2. Items that were received during goods receipt in good condition should be listed under `receivedItems.acceptedQuantity`. [Stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock) will be created automatically for these items.
   3. Rejected items can be marked separately during goods receipt. The [stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock) created from rejected items receives the [condition](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock#stock-condition) "defective" and is not marked as ["pickable" and "accessible"](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits). Thus, it will not be available for sale.
   4. Stock will be created on the[ storage location](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones) indicated in the `storageLocationRef` of the receipt.

### Storage of goods from goods receipt

An admin wants to instruct employees to store goods that have arrived as part of a goods delivery.

* Stow jobs can be used to map the instruction to move items from the goods receiving area to their respective storage locations.
* Create one stow job for each user that should work on the task.
* Create one stow line item for each stock that should be stored.
* Use the [storage location recommendations endpoint](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/stocks/-stockId-/locationrecommendations) to receive recommendations for the target location of each stock.

### Resolving of dispute cases and/or excess stock

An admin wants to instruct employees to handle dispute cases from goods receipt such as broken or damaged items. In addition, stock that was mistakenly created during the rough goods receipt should be deleted.

* Stow jobs can be used to map the instruction to book stock out of the systems.
* Create one stow job for each user that should work on the task.
* Create one stow line item for each stock that should be examined.

### Document reasons for stock changes during storage

Stock accepted during goods receipt is adapted during the storage process. Therefore, users want to document reasons for these changes.

* External stock change reasons can be used to document reasons for stock changes on the stow line item.
* External stock change reasons can be used in two ways:
  * Managed within the platform: Reasons are pre-configured so that workers can choose from a fixed list of reasons during the storage process.
  * Managed externally: There are no pre-configured reasons so that workers can document any reason (e.g., in a free-text field) during the storage process.

### Unhappy case – More items tracked in receipt than actually received

Stock was accepted during (goods) receipt. However, during storage, the user notices that less than the documented quantity has actually arrived. In the below example, 100 items were tracked during goods receipt but only 90 items arrived.

1. Create a `stowJob` for stowing the items from the goods receipt
2. Finish the stow line item with the 90 items that have arrived
3. Add a new `stowLineItem` with type `DISCARD` to the stow job
4. Remove the 10 wrongly booked items from the inbound location
5. Close the `stowJob`

### Unhappy case – Less items tracked in receipt than actually received

Stock was accepted during (goods) receipt. However, during storage, the user notices that more than the documented quantity has actually arrived. In the below example, 100 items were tracked during goods receipt but 110 items arrived.

1. Create a `stowJob` for stowing the items from the goods receipt
2. Finish the stow line item with the 100 items that have arrived
3. Add a new `stowLineItem` with type `UNREGISTERED` to the stow job
4. Relocate the additional 10 items from the inbound location to the target location
5. Close the `stowJob`


# Purchase order

The `purchaseOrder` is a sub-entity of the `inboundProcess` which maps all processes around incoming goods in a store or warehouse. Whenever a `purchaseOrder` is created, a corresponding `inboundProcess` is automatically created.

Create a `purchaseOrder` by executing the following POST call with the JSON body.

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/purchaseorders
```

{% code title="Request" %}

```http
{
  "facilityRef": "CGN-01",
  "orderDate": "2025-03-12T14:15:39.683Z",
  "requestedDate": {
    "type": "TIME_POINT",
    "value": "2025-03-16T14:15:39.683Z"
  },
  "requestedItems": [
    {
      "quantity": {
        "unit": "pieces",
        "value": 100
      },
      "tenantArticleId": "22222"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "fulfillmenttools"
  }
}
```

{% endcode %}

A successful request returns a `201 CREATED` response with the newly created `purchaseOrder` object in the body:

{% code title="Response (201 CREATED)" %}

```json
{
    "status": "OPEN",
    "cancelled": false,
    "orderDate": "2025-03-12T14:15:39.683Z",
    "requestedDate": {
        "type": "TIME_POINT",
        "value": "2025-03-16T14:15:39.683Z"
    },
    "requestedItems": [
        {
            "tenantArticleId": "22222",
            "quantity": {
                "unit": "pieces",
                "value": 100
            }
        }
    ],
    "supplier": {
        "name": "fulfillmenttools"
    },
    "id": "38378d4e-585c-49e1-883f-1ac4faf289ad",
    "created": "2025-03-12T14:56:56.381Z",
    "lastModified": "2025-03-12T14:56:56.381Z",
    "version": 1,
    "facilityRef": "CGN-01",
    "inboundProcessRef": "2d965d89-0ef9-49a0-8380-53c2fde06134"
}
```

{% endcode %}

A `purchaseOrder` can also be created in the following ways:

* **Simultaneously with an inbound process:** Include the `purchaseOrder` data when creating a new `inboundProcess`.

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/inboundprocesses
```

* **Adding to an existing inbound process:** Add a `purchaseOrder` to an `inboundProcess` that has already been created.

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/inboundprocesses/{YOUR_INBOUND_PROCESS_ID}/purchaseorder
```

<br>


# Purchase order endpoints

## The PurchaseOrder object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"PurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified","version","facilityRef","inboundProcessRef"],"title":"PurchaseOrder","type":"object","description":"PurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"}}}}
```

## POST /api/purchaseorders

> Create purchase order

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PurchaseOrderForCreation":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"minLength":1,"type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"}},"required":["orderDate","requestedDate","requestedItems","facilityRef"],"title":"PurchaseOrderForCreation","type":"object","description":"PurchaseOrderForCreation"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"PurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified","version","facilityRef","inboundProcessRef"],"title":"PurchaseOrder","type":"object","description":"PurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/purchaseorders":{"post":{"deprecated":false,"description":"","operationId":"createPurchaseOrder","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"Created Purchase Order entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create purchase order","tags":["Inbound"]}}}}
```

## GET /api/purchaseorders/{purchaseOrderId}

> Get purchase order

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified","version","facilityRef","inboundProcessRef"],"title":"PurchaseOrder","type":"object","description":"PurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/purchaseorders/{purchaseOrderId}":{"get":{"deprecated":false,"description":"","operationId":"getPurchaseOrder","parameters":[{"in":"path","name":"purchaseOrderId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"Purchase Order entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Get purchase order","tags":["Inbound"]}}}}
```

## Updates purchase order

> Partially updates a Purchase Order using a selection of fields

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PurchaseOrderForPartialUpdate":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"orderDate":{"format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}]},"requestedItems":{"items":{"$ref":"#/components/schemas/InboundLineItem"},"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"version":{"type":"number"}},"required":["version"],"title":"PurchaseOrderForPartialUpdate","type":"object","description":"PurchaseOrderForPartialUpdate"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"PurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified","version","facilityRef","inboundProcessRef"],"title":"PurchaseOrder","type":"object","description":"PurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/purchaseorders/{purchaseOrderId}":{"patch":{"deprecated":false,"description":"Partially updates a Purchase Order using a selection of fields","operationId":"patchPurchaseOrder","parameters":[{"in":"path","name":"purchaseOrderId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderForPartialUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"Updated Purchase Order entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Updates purchase order","tags":["Inbound"]}}}}
```

## PUT /api/purchaseorders/{purchaseOrderId}

> Update purchase order

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PurchaseOrderForUpdate":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/InputRequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","version"],"title":"PurchaseOrderForUpdate","type":"object","description":"PurchaseOrderForUpdate"},"InputRequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type"],"title":"InputRequestedDate","type":"object","description":"InputRequestedDate"},"InboundLineItem":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"quantity":{"$ref":"#/components/schemas/Quantity"},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}]},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"title":"InboundLineItem","type":"object","description":"InboundLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"InboundProcessPurchaseOrderSupplier":{"properties":{"name":{"description":"Name of the supplier.","type":"string"}},"title":"InboundProcessPurchaseOrderSupplier","type":"object","description":"InboundProcessPurchaseOrderSupplier"},"PurchaseOrder":{"properties":{"cancelled":{"deprecated":true,"description":"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.","type":"boolean"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"orderDate":{"description":"Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.","format":"date-time","type":"string"},"requestedDate":{"allOf":[{"$ref":"#/components/schemas/RequestedDate"}],"description":"Time and date at which the order is expected to arrive. Use 'ASAP' for deliveries with unknown date, but be aware that some features will not include these orders."},"requestedItems":{"description":"Line items which are expected to be delivered.","items":{"$ref":"#/components/schemas/InboundLineItem"},"maxItems":200,"type":"array"},"status":{"enum":["OPEN","CANCELED"],"type":"string"},"supplier":{"$ref":"#/components/schemas/InboundProcessPurchaseOrderSupplier"},"transfer":{"allOf":[{"$ref":"#/components/schemas/InboundProcessPurchaseOrderTransfer"}],"description":"Includes data about transfer between different facilities in the tenant's network."},"version":{"type":"number"}},"required":["orderDate","requestedDate","requestedItems","status","cancelled","id","created","lastModified","version","facilityRef","inboundProcessRef"],"title":"PurchaseOrder","type":"object","description":"PurchaseOrder"},"RequestedDate":{"properties":{"type":{"enum":["ASAP","TIME_POINT"],"type":"string"},"value":{"format":"date-time","type":"string"}},"required":["type","value"],"title":"RequestedDate","type":"object","description":"RequestedDate"},"InboundProcessPurchaseOrderTransfer":{"properties":{"id":{"type":"string"}},"required":["id"],"title":"InboundProcessPurchaseOrderTransfer","type":"object","description":"InboundProcessPurchaseOrderTransfer"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/purchaseorders/{purchaseOrderId}":{"put":{"deprecated":false,"description":"","operationId":"upsertPurchaseOrder","parameters":[{"in":"path","name":"purchaseOrderId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderForUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}},"description":"Updated/created Purchase Order entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Update purchase order","tags":["Inbound"]}}}}
```


# Receipts

A receipt that describes that goods are received

The `receipt` is a sub-entity of the `inboundProcess` which maps all processes around incoming goods in a store or warehouse. Whenever a `receipt` is created, a corresponding `inboundProcess` is automatically created.

Create a `receipt` by executing the following POST call with the JSON body:

### Create receipt

To create , use our API endpoints.

{% tabs %}
{% tab title="Create new receipt (creates new inbound process)" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/receipts
```

{% endtab %}
{% endtabs %}

Example request body:

{% code title="request.json" %}

```json
{
  "facilityRef": "CGN-01",
  "comments": [],
  "receivedDate": "2025-03-16T14:15:39.683Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "value": 100
      },
      "comments": [],
      "rejectedQuantity": {
        "value": 0
      },
      "storageLocationRef": "2f45a441-6247-4b7d-babe-83fca0ff4bf7",
      "tenantArticleId": "22222"
    }
  ],
  "status": "OPEN"
}
```

{% endcode %}

{% hint style="info" %}
If the request is successful, the API returns a `201 CREATED` response with a body similar to the example below.
{% endhint %}

{% code title="Response (example)" %}

```json
{
  "comments": [],
  "receivedDate": "2025-03-16T14:15:39.683Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "value": 100
      },
      "comments": [],
      "rejectedQuantity": {
        "value": 0
      },
      "storageLocationRef": "Inbound-01",
      "tenantArticleId": "22222",
      "stockProperties": {}
    }
  ],
  "status": "OPEN",
  "id": "6e963526-09af-45f1-9ac7-add78e3e2607",
  "inboundProcessRef": "7060a93e-e0d5-4dd4-8478-50acbd07189b",
  "created": "2025-03-12T16:16:28.543Z",
  "lastModified": "2025-03-12T16:16:28.543Z",
  "version": 1
}
```

{% endcode %}

Alternatively, a `receipt` can be created simultaneously when creating the respective `inboundProcess` via:

```http
POST https://{YOUR_TENANT_NAME}.fulfillmenttools.com/api/inboundprocesses
```

or can be added to an existing `inboundProcess` via:

```http
PUT https://{YOUR_TENANT_NAME}.fulfillmenttools.com/api/inboundprocesses/{YOUR_INBOUND_PROCESS_ID}/receipts
```


# Receipt endpoints

## The Receipt object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"}}}}
```

## GET /api/receipts/{receiptId}

> Get receipt

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/receipts/{receiptId}":{"get":{"deprecated":false,"description":"","operationId":"getReceipt","parameters":[{"in":"path","name":"receiptId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get receipt","tags":["Inbound"]}}}}
```

## PUT /api/receipts/{receiptId}

> Update receipt

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundReceiptForUpdate":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForUpdate"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","version"],"title":"InboundReceiptForUpdate","type":"object","description":"InboundReceiptForUpdate"},"InboundReceiptCommentForUpdate":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForUpdate","type":"object","description":"InboundReceiptCommentForUpdate"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForUpdate":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receival of this item","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForUpdate","type":"object","description":"InboundReceiptLineItemForUpdate"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/receipts/{receiptId}":{"put":{"deprecated":false,"description":"","operationId":"putReceipt","parameters":[{"in":"path","name":"receiptId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundReceiptForUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Update receipt","tags":["Inbound"]}}}}
```

## PATCH /api/receipts/{receiptId}

> Update receipt

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"InboundReceiptForPatch":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForUpdate"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["version"],"title":"InboundReceiptForPatch","type":"object","description":"InboundReceiptForPatch"},"InboundReceiptCommentForUpdate":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForUpdate","type":"object","description":"InboundReceiptCommentForUpdate"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForUpdate":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receival of this item","items":{"$ref":"#/components/schemas/InboundReceiptCommentForUpdate"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForUpdate","type":"object","description":"InboundReceiptLineItemForUpdate"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/receipts/{receiptId}":{"patch":{"deprecated":false,"description":"","operationId":"patchReceipt","parameters":[{"in":"path","name":"receiptId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundReceiptForPatch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Update receipt","tags":["Inbound"]}}}}
```

## POST /api/receipts

> Create receipt

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReceiptForCreation":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItemForCreation"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"}},"required":["receivedDate","receivedItems","comments","facilityRef"],"title":"ReceiptForCreation","type":"object","description":"ReceiptForCreation"},"InboundReceiptCommentForCreation":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptCommentForCreation","type":"object","description":"InboundReceiptCommentForCreation"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItemForCreation":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptCommentForCreation"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItemForCreation","type":"object","description":"InboundReceiptLineItemForCreation"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/receipts":{"post":{"deprecated":false,"description":"","operationId":"createReceipt","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":"Created inbound receipt"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create receipt","tags":["Inbound"]}}}}
```

## DELETE /api/receipts/{receiptId}

> Delete receipt

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read inbound processes and receipts.","name":"Inbound"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Receipt":{"properties":{"asnRef":{"description":"enables mapping a receipt to one of the ASNs in this inbound process","type":"string"},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"created":{"format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"inboundProcessRef":{"type":"string"},"lastModified":{"format":"date-time","type":"string"},"receivedDate":{"description":"date-time of the arrival of the items in the facility","format":"date-time","type":"string"},"receivedItems":{"description":"list of item that arrived in the facility","items":{"$ref":"#/components/schemas/InboundReceiptLineItem"},"maxItems":200,"type":"array"},"status":{"description":"status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.","enum":["OPEN","IN_PROGRESS","FINISHED"],"type":"string"},"version":{"type":"number"}},"required":["receivedDate","receivedItems","comments","id","inboundProcessRef","version","created","lastModified"],"title":"Receipt","type":"object","description":"Receipt"},"InboundReceiptComment":{"properties":{"attachments":{"deprecated":true,"description":"attachments such as photos or documents","items":{"$ref":"#/components/schemas/InboundAttachmentLink"},"type":"array"},"content":{"description":"text content of the comment","type":"string"},"documentSetRef":{"description":"reference to the documentSet that contains the attachments. Read-only field","type":"string"},"id":{"type":"string"},"userRef":{"description":"user that added the comment, is anonymized according to specified rules","type":"string"}},"required":["content"],"title":"InboundReceiptComment","type":"object","description":"InboundReceiptComment"},"InboundAttachmentLink":{"properties":{"inboundAttachmentRef":{"type":"string"}},"required":["inboundAttachmentRef"],"title":"InboundAttachmentLink","type":"object","description":"InboundAttachmentLink"},"InboundReceiptLineItem":{"properties":{"acceptedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was accepted in this receipt. If its larger than 0, Stock will be created when this receipt is FINISHED."},"comments":{"description":"comments regarding the receipt itself","items":{"$ref":"#/components/schemas/InboundReceiptComment"},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"type":"string"},"rejectedQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"}],"description":"quantity of the stock that was rejected in this receipt. If it is larger than 0, Stock will be created with condition \"defective\" when this receipt is FINISHED."},"stockProperties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"stock properties that will be set on the created stock"},"storageLocationRef":{"description":"storage location on which stock was placed","type":"string"},"tenantArticleId":{"description":"tenantArticleId of the stock that was received","type":"string"}},"required":["tenantArticleId","acceptedQuantity","rejectedQuantity","comments"],"title":"InboundReceiptLineItem","type":"object","description":"InboundReceiptLineItem"},"Quantity":{"properties":{"unit":{"description":"Unit of measurement for the requested quantity. Must match the measurementUnitKey defined in the corresponding listing, if set.","type":"string"},"value":{"description":"The amount, provided in the unit of the quantity.","format":"int32","minimum":0,"type":"integer"}},"required":["value"],"title":"Quantity","type":"object","description":"Quantity"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/receipts/{receiptId}":{"delete":{"deprecated":false,"description":"","operationId":"deleteReceipt","parameters":[{"in":"path","name":"receiptId","required":true,"schema":{"type":"string"}},{"in":"query","name":"version","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receipt"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Delete receipt","tags":["Inbound"]}}}}
```


# Storage locations and zones

[Storage locations](#storage-location) and [zones](#zones) help locate items easily during the fulfillment process. You can use them independently or together.

## Storage location

A storage location is a physical place where you can store [stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock). Since more than one product may be stored in the same location, multiple stock items can be connected to a single storage location.

Depending on the facility type, a storage location can represent different concepts, for example, the showcase area, the supply room in stores, a compartment on the shelf, or a pallet space in warehouses.

Storage locations represent the available storage space in a facility. You can assign stock to a facility, or to a specific storage location by linking the stock to the location.

* Storage locations can be grouped in [zones](#zones).
* Storage locations can be assigned [traits](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits), which they in turn inherit to all stocks linked to them.

### Running sequences on storage locations

​You can order storage locations in a (running) sequence by defining the previous and next location.

Depending on the sequence type that was defined, the sequence is considered in picking or stowing.

{% hint style="warning" %}
The running sequence defined for a storage location takes priority over the running sequence set at the listing or order line item level.
{% endhint %}

### Storage location types

Storage locations can have the type `SINGLE_STORAGE` or `BULK_STORAGE`.

#### Single storage

On locations with type `SINGLE_STORAGE`, you can store multiple items of the same product (for example, 100 apples). If a product is already placed on a single-storage location, you can't stow a different product in the same location.

#### Bulk storage

On locations with type `BULK_STORAGE`, you can store different products, for example, 100 apples and 100 bananas.

### Storage location recommendations

#### Working principle

A recommendation is requested for an existing [stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock) based on its stock ID. The product (`tenantArticleId`), [stock properties](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties) (for example, expiry, batch), and current [storage location](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/storage-locations) are considered.

Only storage locations in the current facility that are [accessible](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits) and not the current storage location are considered for further evaluation.

1. The priority is a storage location with the same product and the same [properties](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties). This ensures that stocks which are treated the same by other processes are kept together.
2. Alternatively, if [mixed storage](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#unmixed-storage-configuration) is enabled, fulfillmenttools considers storage locations with the same product but different properties.

In both cases, if multiple storage locations are found, the locations with the least combined stock are preferred. The idea is to spread stock evenly across storage locations and avoid overloading some locations.

If no storage locations are found via the rules described in (1) or (2), nothing is recommended.

{% hint style="success" %}
**"Keep on zero" for storage location recommendations**

When using storage location recommendations, it can help to set the [keep on zero](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits) trait on storage locations. When the trait is set, fulfillmenttools doesn't delete stocks with value 0 from the location. As a result, fulfillmenttools still knows an item is supposed to be stowed in the location even after stock levels drop to 0.
{% endhint %}

The diagram below covers common problems when investigating why an expected location isn't recommended when stowing.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F7fJqqkGsg3D0zUkGiprf%2FStorage%20location%20recommendations%20decision%20flow.png?alt=media&amp;token=e8cda26f-37ea-4fb9-8f0d-ca5f1afe45ae" alt=""><figcaption></figcaption></figure>

### Create a storage location

Storage locations are always related to a specific facility. So, to create a storage location, you need to first [create a facility](https://docs.fulfillmenttools.com/documentation/getting-started/facilities).

The example below creates a disabled storage location with the `ACCESSIBLE` trait. This means that stock in this location will not be considered for incoming orders and can't be picked.

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/storagelocations
```

{% tabs %}
{% tab title="Request body" %}

```json
{
    "tenantLocationId": "qa-location-01",
    "name": "QA on Hold 01",
    "type": "SINGLE_STORAGE",
    "runningSequences": [],
    "scannableCodes": [],
    "traitConfig": [
        {
            "trait": "ACCESSIBLE",
            "enabled": false
        }
    ]
}
```

{% endtab %}

{% tab title="Response body" %}

```json
{
    "name": "QA on Hold 01",
    "tenantLocationId": "qa-location-01",
    "type": "SINGLE_STORAGE",
    "traits": [
        "PICKABLE",
        "ACCESSIBLE"
    ],
    "traitConfig": [
        {
            "trait": "ACCESSIBLE",
            "enabled": true
        }
    ],
    "scannableCodes": [],
    "runningSequences": [],
    "facilityRef": "{YOUR_FACILITY_ID}",
    "version": 1,
    "lastModified": "2026-03-05T16:46:46.052Z",
    "id": "{YOUR_STORAGE_LOCATION_ID}",
    "created": "2026-03-05T16:46:46.052Z"
}
```

{% endtab %}
{% endtabs %}

## Zones

A zone represents a physical area in the facility. Zones and storage locations can exist separately. When you use both, we recommend assigning [storage locations](#storage-location) to the zone they are in.

You can create a zone using the `/api/facilities/{facilityId}/zones` endpoint. Then, assign storage locations to that zone using the `zoneRef` field on the [storage location endpoint](#create-a-storage-location).

Products get linked to a zone only because their stock sits in one of those storage locations. A listing itself has no zone field.

A user can be assigned to one or more zones, set via `assignedZones` on their [assigned facility](https://docs.fulfillmenttools.com/documentation/apis/api-reference/user-management#post-api-users-userid-assignedfacilities). You can then filter pick jobs by zone using the `zoneRefs` query-string parameter. A pick job can contain items from several zones at once, as only one pick job will be created. The pick job lists all the zones it touches in `pickingZones`. Each line item also carries its own zone, via `zoneRef` inside its `partialStockLocations`. See also the [Zone picking section of the Picking article](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking).

{% hint style="info" %}
Filtering pick jobs by zone decides which jobs show up in a list. It doesn't split a job into smaller pieces, and it doesn't hide items from a user once they open the job.
{% endhint %}

Below is an example of what a pick job with zones looks like:

```json
{
  "id": "01a08610-7794-707d-ac47-e1c6e31b0b35",
  "status": "OPEN",
  "pickingZones": [
    { "zoneRef": "zoneA" },
    { "zoneRef": "zoneB" },
    { "zoneRef": "zoneC" }
  ],
  "pickLineItems": [
    {
      "id": "line-A",
      "article": { "tenantArticleId": "A" },
      "quantity": 1,
      "picked": 0,
      "partialStockLocations": [
        { "stockRef": "stock-A", "quantity": 1, "zoneRef": "zoneA" }
      ]
    },
    {
      "id": "line-B",
      "article": { "tenantArticleId": "B" },
      "quantity": 1,
      "picked": 0,
      "partialStockLocations": [
        { "stockRef": "stock-B", "quantity": 1, "zoneRef": "zoneB" }
      ]
    },
    {
      "id": "line-C",
      "article": { "tenantArticleId": "C" },
      "quantity": 1,
      "picked": 0,
      "partialStockLocations": [
        { "stockRef": "stock-C", "quantity": 1, "zoneRef": "zoneC" }
      ]
    }
  ]
}
```

### Create a zone

To create a zone, use the endpoint below. As a zone is part of a facility, you must create a facility first.

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/zones
```

{% tabs %}
{% tab title="Request body" %}

```json
{
  "name": "Holding",
  "score": 0
}
```

{% endtab %}

{% tab title="Response body" %}

```json
{
    "name": "Holding",
    "score": 0,
    "facilityRef": "{YOUR_FACILITY_ID}",
    "lastModified": "2026-03-05T16:50:55.153Z",
    "version": 1,
    "id": "{YOUR_ZONE_ID}",
    "created": "2026-03-05T16:50:55.153Z"
}
```

{% endtab %}
{% endtabs %}

### Add a storage location to a zone

To add a storage location to a zone, you can either create the storage location with the zone already included, or update an existing storage location to include a new zone.

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/storagelocations
```

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/storagelocations/{YOUR_STORAGE_LOCATION_ID}
```

{% tabs %}
{% tab title="Request body" %}

```json
{
    "tenantLocationId": "qa-location-01",
    "name": "QA on Hold 01",
    "type": "SINGLE_STORAGE",
    "runningSequences": [],
    "scannableCodes": [],
    "zoneRef": "{YOUR_ZONE_ID}",
    "traitConfig": [
        {
            "trait": "ACCESSIBLE",
            "enabled": true
        }
    ]
}
```

{% endtab %}

{% tab title="Response body" %}

```json
{
    "name": "QA on Hold 01",
    "tenantLocationId": "qa-location-01",
    "type": "SINGLE_STORAGE",
    "traits": [
        "PICKABLE",
        "ACCESSIBLE"
    ],
    "traitConfig": [
        {
            "trait": "ACCESSIBLE",
            "enabled": true
        }
    ],
    "scannableCodes": [],
    "runningSequences": [],
    "zoneRef": "{YOUR_ZONE_ID}",
    "facilityRef": "{YOUR_FACILITY_ID}",
    "version": 1,
    "lastModified": "2026-09-14T10:19:00.357Z",
    "id": "01a09f6d-5f70-7648-805f-e3e8e75ce360",
    "created": "2026-09-14T10:19:00.357Z"
}
```

{% endtab %}
{% endtabs %}


# Storage locations endpoints

## The StorageLocation object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"}}}}
```

## List storage locations (search)

> Search for StorageLocation

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StorageLocationSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/StorageLocationSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/StorageLocationSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"StorageLocationSearchPayload","type":"object","description":"StorageLocationSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"StorageLocationSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StorageLocationSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StorageLocationSearchQuery"},"maxItems":500,"type":"array"},"referenced":{"allOf":[{"$ref":"#/components/schemas/StorageLocationReferencedFilter"}],"description":"Nested search by referenced"},"scannableCodes":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by scannableCodes"},"tenantLocationId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantLocationId"},"traits":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTraitEnumListFilter"}],"description":"Search by traits"},"type":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTypeEnumFilter"}],"description":"Search by type"},"zoneRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by zoneRef"}},"title":"StorageLocationSearchQuery","type":"object","description":"StorageLocationSearchQuery"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"StorageLocationReferencedFilter":{"properties":{"stock":{"allOf":[{"$ref":"#/components/schemas/StorageLocationReferencedStockFilter"}],"description":"Nested search by stock"}},"title":"StorageLocationReferencedFilter","type":"object","description":"StorageLocationReferencedFilter"},"StorageLocationReferencedStockFilter":{"properties":{"hasStocks":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Whether the storage locations has any stocks on it."},"sumOfValues":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"The sum of all stock values in this storage location, i.e. how much stock is stored in this location."}},"title":"StorageLocationReferencedStockFilter","type":"object","description":"StorageLocationReferencedStockFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StorageLocationTraitEnumListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StorageLocationTraitEnumFilter"}],"description":"Search by traits"}},"title":"StorageLocationTraitEnumListFilter","type":"object","description":"StorageLocationTraitEnumListFilter"},"StorageLocationTraitEnumFilter":{"properties":{"eq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"in":{"description":"Search by traits","items":{"enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by traits","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string"}},"title":"StorageLocationTraitEnumFilter","type":"object","description":"StorageLocationTraitEnumFilter"},"StorageLocationTypeEnumFilter":{"properties":{"eq":{"description":"Search by type","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"},"in":{"description":"Search by type","items":{"enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by type","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string"}},"title":"StorageLocationTypeEnumFilter","type":"object","description":"StorageLocationTypeEnumFilter"},"StorageLocationSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"name":{"enum":["ASC","DESC"],"type":"string"},"tenantLocationId":{"enum":["ASC","DESC"],"type":"string"},"zoneRef":{"enum":["ASC","DESC"],"type":"string"}},"title":"StorageLocationSort","type":"object","description":"StorageLocationSort"},"StorageLocationPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"storageLocations":{"items":{"$ref":"#/components/schemas/StorageLocation"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","storageLocations"],"title":"StorageLocationPaginatedResult","type":"object","description":"StorageLocationPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/storagelocations/search":{"post":{"deprecated":false,"description":"Search for StorageLocation","operationId":"searchStorageLocation","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageLocationSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageLocationPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List storage locations (search)","tags":["Storage locations"]}}}}
```

## GET /api/facilities/{facilityId}/storagelocations/{storageLocationId}

> Get facility storage location

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/storagelocations/{storageLocationId}":{"get":{"description":"","operationId":"getFacilityStorageLocation","parameters":[{"description":"ID of facility from which you want to get the storage locations. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"the ID of the storageLocation","in":"path","name":"storageLocationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StorageLocation"},"type":"array"}}},"description":"Facility was found & you are allowed to get the storage locations. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"Get facility storage location","tags":["Storage locations"]}}}}
```

## GET /api/facilities/{facilityId}/storagelocations

> List facility storage locations

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/storagelocations":{"get":{"description":"","operationId":"getFacilityStorageLocations","parameters":[{"description":"ID of facility from which you want to get the storage locations. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"limit result to storage locations with scannable code","in":"query","name":"scannableCode","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StorageLocation"},"type":"array"}}},"description":"Facility was found & you are allowed to get the storage locations. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"List facility storage locations","tags":["Storage locations"]}}}}
```

## Update facility storage location

> Replaces the current storage locations of this Facility with the provided in the body.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/storagelocations/{storageLocationId}":{"put":{"description":"Replaces the current storage locations of this Facility with the provided in the body.","operationId":"putFacilityStorageLocation","parameters":[{"description":"ID of facility from whom you want to put the storage locations","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"the ID of the storageLocation","in":"path","name":"storageLocationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageLocationForReplacement"}}},"description":"Patch set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageLocation"}}},"description":"Storage location was found & you were allowed to update it."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility or Storage Location not found"}},"summary":"Update facility storage location","tags":["Storage locations"]}}}}
```

## Create facility storage location

> Creates a new storage location in this facility.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/storagelocations":{"post":{"description":"Creates a new storage location in this facility.","operationId":"postFacilityStorageLocations","parameters":[{"description":"ID of facility from whom you want to create the storage location","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageLocationForCreation"}}},"description":"Patch set","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageLocation"}}},"description":"The storage location was successfully created."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"Create facility storage location","tags":["Storage locations"]}}}}
```

## Update facility storage location

> Adds new storage locations, updates existing ones and keeps the previously present ones in the database.\
> \
> 1\. If a storage location exists in the patch action but not in the database it is added.\
> 2\. If a storage location exists both in the patch action and in the database it is updated and the contents merged.\
> 3\. If a storage location exists only in the database, it is left untouched.<br>

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StorageLocationPatchActions":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ModifyStorageLocationAction"},"minItems":1,"type":"array"},"version":{"description":"The version of the facility where we want to patch the storage locations to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version","actions"],"type":"object","xml":{"name":"StorageLocationPatchActions"},"title":"StorageLocationPatchActions","description":"StorageLocationPatchActions"},"ModifyStorageLocationAction":{"allOf":[{"$ref":"#/components/schemas/AbstractModificationAction"},{"additionalProperties":false,"properties":{"action":{"description":"Use value 'ModifyStorageLocation', because you want to modify a storage location","enum":["ModifyStorageLocation"],"type":"string"},"customAttributes":{"description":"Attributes that can be added to the storage location. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"deprecated":true,"description":"The traits of this storage location. Do not use this to write traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs.","type":"string"}},"required":["action"],"type":"object"}],"xml":{"name":"ModifyStorageLocationAction"},"title":"ModifyStorageLocationAction","description":"ModifyStorageLocationAction"},"AbstractModificationAction":{"discriminator":{"propertyName":"action"},"properties":{"action":{"description":"","enum":["AddAllowedValueToTag","ModifyFacility","ModifyListing","ModifyRetainedOfflineStock","ModifyListingReactivationAfter","ModifyUser","ModifyCarrier","ModifyShortpick","ModifyRoutingPlan","ModifyFence","ModifyRating","ModifyTimingMode","ModifyGlobalRoutingConfiguration","ModifyOrderSplit","ModifyPrioritization","ModifyFeature","ModifyPartialStock","AddTagsToProcess","AssignFacilityToProcess","UpdateGdprCleanupDateAction","ModifyStorageLocation","UnlockOrder"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"AbstractModificationAction"},"title":"AbstractModificationAction","description":"AbstractModificationAction"},"StorageLocationSequenceItem":{"properties":{"nextStorageLocationRef":{"description":"The next storage from which to pick up after this one","type":"string"},"previousStorageLocationRef":{"description":"The previous storage from which to pick up after this one","type":"string"},"score":{"deprecated":true,"description":"Running sequence score - read-only","type":"number"},"type":{"$ref":"#/components/schemas/StorageLocationSequenceType"}},"required":["type"],"type":"object","xml":{"name":"StorageLocationSequenceItem"},"title":"StorageLocationSequenceItem","description":"StorageLocationSequenceItem"},"StorageLocationSequenceType":{"description":"Describes the type of a storage location sequence type\n  * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.\n  * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.","enum":["PICKING_SEQUENCE","RESTOW_SEQUENCE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationSequenceType"},"StorageLocationTraitConfig":{"description":"The configuration of the traits of this storage location","items":{"properties":{"enabled":{"type":"boolean"},"trait":{"$ref":"#/components/schemas/StorageLocationTrait"}},"required":["trait","enabled"],"type":"object"},"type":"array","title":"StorageLocationTraitConfig"},"StorageLocationTrait":{"description":"Describes what kind of actions this stock is available for\n  * `PICKABLE`- The stock is available for picking\n  * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n  * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n  * `OUTBOUND`- The stock is intended for outbound processes\n  * `IN_MOTION`- The stock is in motion, used by StowJobs.","enum":["PICKABLE","ACCESSIBLE","KEEP_ON_ZERO","OUTBOUND","IN_MOTION"],"type":"string","xml":{"name":"StorageLocationTrait"},"title":"StorageLocationTrait"},"StorageLocationType":{"description":"Describes the kind of a storage location:\n  * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here\n  * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here","enum":["SINGLE_STORAGE","BULK_STORAGE"],"type":"string","xml":{"name":"StorageLocationType"},"title":"StorageLocationType"},"StorageLocation":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForReplacement"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"facilityRef":{"description":"The id of the facility reference.","type":"string"},"id":{"description":"The id of this storage location","type":"string"},"schemaVersion":{"type":"number"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"zoneName":{"deprecated":true,"description":"Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs","type":"string"}},"required":["id","facilityRef","traits"],"type":"object","xml":{"name":"StorageLocation"},"title":"StorageLocation","description":"StorageLocation"},"StorageLocationForReplacement":{"allOf":[{"$ref":"#/components/schemas/StorageLocationForCreation"}],"properties":{"version":{"format":"int64","type":"integer"}},"required":["version"],"type":"object","xml":{"name":"StorageLocationForReplacement"},"title":"StorageLocationForReplacement","description":"StorageLocationForReplacement"},"StorageLocationForCreation":{"allOf":[{"$ref":"#/components/schemas/CustomAttributesResource"}],"properties":{"information":{"description":"A free text information about this storage location, max length 1024","maxLength":1024,"type":"string"},"name":{"description":"The name of this storage location","maxLength":15,"type":"string"},"runningSequences":{"description":"The Sequence item/s of this location","items":{"$ref":"#/components/schemas/StorageLocationSequenceItem"},"maxItems":10,"type":"array"},"scannableCodes":{"description":"Barcodes representing this storage location","items":{"type":"string"},"maxItems":5,"type":"array"},"tenantLocationId":{"description":"The internal tenant id for this location","type":"string"},"traitConfig":{"$ref":"#/components/schemas/StorageLocationTraitConfig"},"traits":{"description":"The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.","items":{"$ref":"#/components/schemas/StorageLocationTrait"},"type":"array"},"type":{"$ref":"#/components/schemas/StorageLocationType"},"zoneName":{"description":"The name of the Zone to which this storage location belongs","type":"string"},"zoneRef":{"description":"The id of the Zone to which this storage location belongs","type":"string"}},"required":["name","runningSequences","scannableCodes","type"],"type":"object","xml":{"name":"StorageLocationForCreation"},"title":"StorageLocationForCreation","description":"StorageLocationForCreation"},"CustomAttributesResource":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"}},"title":"CustomAttributesResource","type":"object","description":"CustomAttributesResource"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/storagelocations/{storageLocationId}":{"patch":{"description":"Adds new storage locations, updates existing ones and keeps the previously present ones in the database.\n\n1. If a storage location exists in the patch action but not in the database it is added.\n2. If a storage location exists both in the patch action and in the database it is updated and the contents merged.\n3. If a storage location exists only in the database, it is left untouched.\n","operationId":"patchFacilityStorageLocation","parameters":[{"description":"ID of facility you want to patch the storage locations","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"the ID of the storageLocation","in":"path","name":"storageLocationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageLocationPatchActions"}}},"description":"Patch set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageLocation"}}},"description":"Storage location was found & you were allowed to update it."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility or Storage location not found"}},"summary":"Update facility storage location","tags":["Storage locations"]}}}}
```

## DELETE /api/facilities/{facilityId}/storagelocations/{storageLocationId}

> Delete facility storage location

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/storagelocations/{storageLocationId}":{"delete":{"description":"","operationId":"deleteFacilityStorageLocation","parameters":[{"description":"ID of facility from whom you want to delete the storage location","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"ID of the storageLocation you want to delete","in":"path","name":"storageLocationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Storage location was found & you were allowed to delete it."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility or storage location not found"}},"summary":"Delete facility storage location","tags":["Storage locations"]}}}}
```


# Zone endpoints

## The Zone object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Zone":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"description":"The id of this zone","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["name","score","version","id","facilityRef"],"title":"Zone","type":"object","description":"Zone"}}}}
```

## List zones (search)

> Search for Zone

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ZoneSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/ZoneSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/ZoneSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"ZoneSearchPayload","type":"object","description":"ZoneSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"ZoneSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ZoneSearchQuery"},"maxItems":500,"type":"array"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"name":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by name"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/ZoneSearchQuery"},"maxItems":500,"type":"array"}},"title":"ZoneSearchQuery","type":"object","description":"ZoneSearchQuery"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"ZoneSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"}},"title":"ZoneSort","type":"object","description":"ZoneSort"},"ZonePaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"},"zones":{"items":{"$ref":"#/components/schemas/Zone"},"type":"array"}},"required":["pageInfo","zones"],"title":"ZonePaginatedResult","type":"object","description":"ZonePaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"Zone":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"description":"The id of this zone","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["name","score","version","id","facilityRef"],"title":"Zone","type":"object","description":"Zone"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/zones/search":{"post":{"deprecated":false,"description":"Search for Zone","operationId":"searchZone","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZonePaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List zones (search)","tags":["Storage locations"]}}}}
```

## GET /api/facilities/{facilityId}/zones/{zoneId}

> Get facility zone

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Zone":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"description":"The id of this zone","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["name","score","version","id","facilityRef"],"title":"Zone","type":"object","description":"Zone"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/zones/{zoneId}":{"get":{"deprecated":false,"description":"","operationId":"getFacilityZone","parameters":[{"description":"ID of facility. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"ID of the zone","in":"path","name":"zoneId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zone"}}},"description":"Zone was found & you are allowed to get it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"Get facility zone","tags":["Storage locations"]}}}}
```

## GET /api/facilities/{facilityId}/zones

> List facility zones

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Zone":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"description":"The id of this zone","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["name","score","version","id","facilityRef"],"title":"Zone","type":"object","description":"Zone"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/zones":{"get":{"deprecated":false,"description":"","operationId":"getFacilityZones","parameters":[{"description":"ID of facility. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"The number of items to return.","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"number"}},{"description":"The ID of the last item from the previous page. The next page will start after this ID.","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Zone"},"type":"array"}}},"description":"Facility was found & you are allowed to get the zones. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"List facility zones","tags":["Storage locations"]}}}}
```

## Update facility zone

> Replaces the current zone of this Facility with the provided in the body.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ZoneForReplacement":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["name","score","version"],"title":"ZoneForReplacement","type":"object","description":"ZoneForReplacement"},"Zone":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"description":"The id of this zone","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["name","score","version","id","facilityRef"],"title":"Zone","type":"object","description":"Zone"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/zones/{zoneId}":{"put":{"deprecated":false,"description":"Replaces the current zone of this Facility with the provided in the body.","operationId":"putFacilityZone","parameters":[{"description":"ID of facility. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"ID of the zone","in":"path","name":"zoneId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneForReplacement"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zone"}}},"description":"Zone was found & you are allowed to update it."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility not found"}},"summary":"Update facility zone","tags":["Storage locations"]}}}}
```

## Create facility zone

> Creates a new zone in this facility.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ZoneForCreation":{"properties":{"customAttributes":{"description":"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.","nullable":true,"type":"object"},"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"}},"required":["name","score"],"title":"ZoneForCreation","type":"object","description":"ZoneForCreation"},"Zone":{"properties":{"created":{"description":"The date this entity was created by fulfillmenttools. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"The id of the facility reference. The given ID has to be present in the system.","type":"string"},"id":{"description":"The id of this zone","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"name":{"description":"The name of this zone","type":"string"},"score":{"description":"The score of this zone","type":"number"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["name","score","version","id","facilityRef"],"title":"Zone","type":"object","description":"Zone"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/zones":{"post":{"deprecated":false,"description":"Creates a new zone in this facility.","operationId":"postFacilityZone","parameters":[{"description":"ID of facility. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zone"}}},"description":"The zone was successfully created."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Zone not found"}},"summary":"Create facility zone","tags":["Storage locations"]}}}}
```

## DELETE /api/facilities/{facilityId}/zones/{zoneId}

> Delete facility zone

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read storage locations and zones.","name":"Storage locations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/facilities/{facilityId}/zones/{zoneId}":{"delete":{"deprecated":false,"description":"","operationId":"deleteFacilityZone","parameters":[{"description":"ID of facility. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{tenant-facility-id}).","in":"path","name":"facilityId","required":true,"schema":{"type":"string"}},{"description":"ID of the zone","in":"path","name":"zoneId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Zone was found & you were allowed to delete it."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Facility or storage location not found"}},"summary":"Delete facility zone","tags":["Storage locations"]}}}}
```


# Inventory traits

Traits provide information on how [storage locations](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones) and [stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock) are to be handled in operational and order processes. Traits can be set both on storage locations and stocks. If set on storage locations, they affect the handling of both storage locations and the [stock](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock) located on them. Each stock placed on a location (by assigning it a `locationRef`) will inherit the traits of its storage location if nothing is specified in the stock's traitConfig.

Traits can, for example, be used to mark a location and its stock as pickable or to [lock locations](#locking-storage-locations-or-stocks) along with their stock. When only using stocks (and no locations) traits can be used to mark stock as pickable or lock it.

## Available traits

By default, each storage location has the traits `PICKABLE` and `ACCESSIBLE`, unless otherwise specified.

<table><thead><tr><th>Trait</th><th width="103" data-type="checkbox">Default</th><th>Description</th><th data-hidden>Function</th></tr></thead><tbody><tr><td><code>PICKABLE</code></td><td>true</td><td>Stock on these locations can be picked for fulfilling orders.<br>Only stock marked as <code>PICKABLE</code> can be considered for incoming orders.</td><td><p>Stock on these locations is used to fulfill orders.<br>For example, stock may be offered in an online shop (after adjusting the quantity for other factors like reservations, channel-, and safety-stock).</p><p>To represent this stock class, you need both traits. This allows you to temporarily block access to the location by removing the <code>ACCESSIBLE</code> trait while keeping it assigned to the picking storage area.</p></td></tr><tr><td><code>ACCESSIBLE</code></td><td>true</td><td>The <code>ACCESSIBLE</code> trait indicates that stock can be removed from and new stock can be put on this location. Removing the <code>ACCESSIBLE</code> trait from a location locks it for picking and triggers a notification during stowing processes. Only stock marked as <code>ACCESSIBLE</code> can be considered for incoming orders.</td><td>The <code>ACCESSIBLE</code> trait indicates that stock can be removed from and new stock can be put on this location. Removing the <code>ACCESSIBLE</code> trait from a location locks the location for all operational processes.</td></tr><tr><td><code>KEEP_ON_ZERO</code></td><td>false</td><td>Normally, stocks are deleted when they reach <code>0</code> through operations like picking or stock movements. To change this behavior, add the <code>KEEP_ON_ZERO</code> trait to the location. See <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock#stocks-with-amount-0">stock entities with amount 0</a>.</td><td>By</td></tr><tr><td><code>OUTBOUND</code></td><td>false</td><td>The <code>OUTBOUND</code> trait marks storage locations for items that have already been picked and are ready to be handed over to a shipping provider. When configured in the <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/configurations#outbound-stock-configuration">outbound inventory tracking</a>, stocks and reservations are automatically booked to the defined outbound location after picking has been completed.</td><td></td></tr><tr><td><code>IN_MOTION</code></td><td>false</td><td>The <code>IN_MOTION</code> trait marks stock that is currently being moved as part of a stow job. This stock should be filtered out during a stock update via the <a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/stocks">stocks REST API endpoints</a>.</td><td></td></tr></tbody></table>

## Interacting with traits

Each trait has a default value. When nothing else is specified, the enabled traits are processed on both the storage location itself and the stocks on it. The default value (whether it is enabled or not) can be overwritten **individually** for each trait by setting it in the `traitsConfig` field on the storage location or on the stock. Traits set on stocks overwrite the traits set on storage locations. All unspecified traits keep their defaults. This means that if a trait is enabled via the trait config, `PICKABLE` and `ACCESSIBLE` are set by default unless explicitly set to false.

{% hint style="warning" %}
The `traitConfig` should be used to write to traits. Don't use the trait array for that purpose.
{% endhint %}

The `traitConfig` can specify each trait as enabled, disabled or unset. The final trait config is determined in a cascading manner:

<table><thead><tr><th width="185">Trait</th><th width="125">Default</th><th width="167">Storage location</th><th>Stock</th><th>Final config</th></tr></thead><tbody><tr><td><code>ACCESSIBLE</code></td><td>true</td><td>false</td><td>true</td><td><strong>true</strong></td></tr><tr><td><code>PICKABLE</code></td><td>true</td><td>true</td><td>false</td><td><strong>false</strong></td></tr><tr><td><code>KEEP_ON_ZERO</code></td><td></td><td>true</td><td></td><td><strong>true</strong></td></tr></tbody></table>

### Locking storage locations or stocks

To lock a storage location including the items placed on it, the `ACCESSIBLE` trait must be removed. As a consequence, the items on the location are not considered for incoming orders (i.e. picking). It is still possible to remove items from the location or put new items on it. Additionally, users are notified about the locked status when moving items from the location via [App](https://docs.fulfillmenttools.com/documentation/apps/inventory-app) or [Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/facility-view/inventory/storage-locations). Similarly, stocks can be locked by removing the `ACCESSIBLE` trait from them.

To unlock the storage location, the `ACCESSIBLE` trait must be set (again).

### Traits in order routing and fulfillment

Storage locations and stock with the traits `PICKABLE` and `ACCESSIBLE` or with no traits are considered for fences and ratings during [order routing](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing) and calculating [stock availability](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability).

The following storage locations and stocks are ignored in order routing and fulfillment:

* With an empty array of traits
* With only the trait `PICKABLE`
* With only the trait `ACCESSIBLE`


# Measurement units

In fulfillmenttools, each article (identified by a tenantArticleId in a facility) is tracked per unit. A unit commonly represents a physical unit, like `g` or `kg,` or for countable goods, something like `pieces` or `pcs`. Since each product is kept in a single measurement unit, operations like adding or moving stock don't need to validate or convert units between stock items.

Units can be defined in the `measurementUnitKey` in the [listing](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing). The defined key will be displayed in the clients, for example, during picking if no measurement unit is defined for the key. It's not required to define units for articles. When no unit is set in the [listing](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing), no validation occurs, and our clients will default to localized versions of `pieces`.

You might want to change the `measurementUnitKey` for items that are sold by weight, for example, fruits and vegetables, or by length, for example, fabric.

## Implementation

To create a new measurement unit for your tenant, use the endpoint below:

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/measurementunits
```

{% endtab %}

{% tab title="Request" %}

```json
{
    "key": "KILOGRAM",
    "nameLocalized": { "en_US": "KILO" },
    "abbreviationLocalized": { "en_US": "kg" },
    "requiresMeasurement": true
}
```

{% endtab %}
{% endtabs %}

To then use this measurement unit in a listing, use the endpoint below:

{% tabs %}
{% tab title="Endpoint" %}

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/facilities/{YOUR_FACILITY_ID}/listings
```

{% endtab %}

{% tab title="Request" %}

```json
{
    "listings": [
        {
            "tenantArticleId": "Bison-food",
            "price": 50.00,
            "title": "Bison food",
            "scannableCodes": ["Bison-food"],
            "measurementUnitKey": "KILOGRAM"
        }
    ]
}
```

{% endtab %}
{% endtabs %}

The measurement unit will then display in the clients for that listing.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fnn5HmQc2BFbdIYVAQLep%2FMeasurement%20unit%20displayed%20in%20Backoffice.png?alt=media&amp;token=eb5bdab2-d178-45e6-b560-01059f33b6f1" alt=""><figcaption></figcaption></figure>

## Unit validation in inbound processes

When using the [inbound process](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inbound-process), it's recommended to define units for each product in its respective facility listing.

Since no automatic conversion between units occurs, it's essential to specify the correct unit when new goods are accepted into the system. This eliminates a common source of critical errors in stock levels.

When a `measurementUnitKey` is set on the corresponding [listing](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing), each new line item in the purchase order's requested items and the receipt's received items is validated against it. All quantities must match the unit of the listing.

{% hint style="info" %}
Attention: When creating an `inboundProcess` with a `purchaseOrder` with unit `xyz` and changing the `listing.measurementUnitKey` to something else (`qwe`), the `inboundProcess.purchaseOrder` must now be patched/replaced to reflect the correct unit again before a receipt can be created in the Inventory app.

This is intentional and ensures consistency in new stock levels at the facility. In general, it's not advisable to change a product's unit in a facility without careful consideration. In some cases, it may be desired to start with no unit on the `listing` (= no validation) and transition to stricter rules later.
{% endhint %}


# Measurement units endpoints

## The MeasurementUnit object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"MeasurementUnit":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MeasurementUnitForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"abbreviation":{"description":"Translated abbreviation of the measurement unit","type":"string"},"id":{"type":"string"},"name":{"description":"Translated name of the measurement unit","type":"string"}},"required":["id"],"type":"object","title":"MeasurementUnit","description":"MeasurementUnit"},"MeasurementUnitForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"abbreviationLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Abbreviation of the unit. Maximum 4 chars long."},"key":{"description":"Descriptor for the measurement unit","type":"string"},"requiresMeasurement":{"description":"Indicates that the given unit need to be measured.","type":"boolean"}},"required":["nameLocalized","abbreviationLocalized","key"],"type":"object","title":"MeasurementUnitForCreation","description":"MeasurementUnitForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"}}}}
```

## List measurement units

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read measurement units.","name":"Measurement units"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MeasurementUnits":{"properties":{"measurementUnits":{"items":{"$ref":"#/components/schemas/MeasurementUnit"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"MeasurementUnits","description":"MeasurementUnits"},"MeasurementUnit":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MeasurementUnitForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"abbreviation":{"description":"Translated abbreviation of the measurement unit","type":"string"},"id":{"type":"string"},"name":{"description":"Translated name of the measurement unit","type":"string"}},"required":["id"],"type":"object","title":"MeasurementUnit","description":"MeasurementUnit"},"MeasurementUnitForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"abbreviationLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Abbreviation of the unit. Maximum 4 chars long."},"key":{"description":"Descriptor for the measurement unit","type":"string"},"requiresMeasurement":{"description":"Indicates that the given unit need to be measured.","type":"boolean"}},"required":["nameLocalized","abbreviationLocalized","key"],"type":"object","title":"MeasurementUnitForCreation","description":"MeasurementUnitForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/measurementunits":{"get":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"getAllMeasurementUnits","parameters":[{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of measurementUnits to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"key of the measurementUnit","in":"query","name":"key","required":false,"schema":{"type":"string"}},{"description":"Provide the localized names for the measurementUnit. If not provided the default locale is used., for example de_DE.","in":"query","name":"locale","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeasurementUnits"}}},"description":"The found measurementUnit."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"List measurement units","tags":["Measurement units"]}}}}
```

## Get measurement unit

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read measurement units.","name":"Measurement units"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MeasurementUnit":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MeasurementUnitForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"abbreviation":{"description":"Translated abbreviation of the measurement unit","type":"string"},"id":{"type":"string"},"name":{"description":"Translated name of the measurement unit","type":"string"}},"required":["id"],"type":"object","title":"MeasurementUnit","description":"MeasurementUnit"},"MeasurementUnitForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"abbreviationLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Abbreviation of the unit. Maximum 4 chars long."},"key":{"description":"Descriptor for the measurement unit","type":"string"},"requiresMeasurement":{"description":"Indicates that the given unit need to be measured.","type":"boolean"}},"required":["nameLocalized","abbreviationLocalized","key"],"type":"object","title":"MeasurementUnitForCreation","description":"MeasurementUnitForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/measurementunits/{measurementUnitId}":{"get":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"getMeasurementUnitByID","parameters":[{"in":"path","name":"measurementUnitId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeasurementUnit"}}},"description":"The found measurementUnit."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get measurement unit","tags":["Measurement units"]}}}}
```

## Create measurement unit

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read measurement units.","name":"Measurement units"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MeasurementUnitForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"abbreviationLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Abbreviation of the unit. Maximum 4 chars long."},"key":{"description":"Descriptor for the measurement unit","type":"string"},"requiresMeasurement":{"description":"Indicates that the given unit need to be measured.","type":"boolean"}},"required":["nameLocalized","abbreviationLocalized","key"],"type":"object","title":"MeasurementUnitForCreation","description":"MeasurementUnitForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"MeasurementUnit":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MeasurementUnitForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"abbreviation":{"description":"Translated abbreviation of the measurement unit","type":"string"},"id":{"type":"string"},"name":{"description":"Translated name of the measurement unit","type":"string"}},"required":["id"],"type":"object","title":"MeasurementUnit","description":"MeasurementUnit"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/measurementunits":{"post":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"createMeasurementUnit","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeasurementUnitForCreation"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeasurementUnit"}}},"description":"Successfully created the measurementUnit."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Create measurement unit","tags":["Measurement units"]}}}}
```

## Update measurement unit

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read measurement units.","name":"Measurement units"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MeasurementUnitForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"abbreviationLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Abbreviation of the unit. Maximum 4 chars long."},"key":{"description":"Descriptor for the measurement unit","type":"string"},"requiresMeasurement":{"description":"Indicates that the given unit need to be measured.","type":"boolean"}},"required":["nameLocalized","abbreviationLocalized","key"],"type":"object","title":"MeasurementUnitForCreation","description":"MeasurementUnitForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"MeasurementUnit":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/MeasurementUnitForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"abbreviation":{"description":"Translated abbreviation of the measurement unit","type":"string"},"id":{"type":"string"},"name":{"description":"Translated name of the measurement unit","type":"string"}},"required":["id"],"type":"object","title":"MeasurementUnit","description":"MeasurementUnit"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/measurementunits/{measurementUnitId}":{"put":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"updateMeasurementUnit","parameters":[{"in":"path","name":"measurementUnitId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeasurementUnitForCreation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeasurementUnit"}}},"description":"Successfully updated the measurementUnit."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Update measurement unit","tags":["Measurement units"]}}}}
```

## Delete measurement unit

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update and read measurement units.","name":"Measurement units"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/measurementunits/{measurementUnitId}":{"delete":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"deleteMeasurementUnit","parameters":[{"in":"path","name":"measurementUnitId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully deleted the measurementUnit."},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Delete measurement unit","tags":["Measurement units"]}}}}
```


# Stow jobs

{% hint style="info" %}
This feature is only supported in the backend and usable via our [stow job REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/stowjobs).
{% endhint %}

Stow jobs represent the intention or instruction to change the storage location and/or the amount of stock in a facility. They support employees in a store or warehouse to execute one or several of the below tasks:

* Relocate items within a warehouse
* Stow items from a goods receipt
* Discard expired or broken items
* Create stock for items that are not registered yet

While the stow job itself holds general information such as the facility or priority of the job, the stow line item contains information on the items to be moved, their quantity, location, and more. Stow line items cannot exist without a stow job.

## Stow line items

A stow job can have 0 to n stow line items. While the stow job itself holds general information such as the facility or priority of the job, the stow line item contains information on the items to be moved, their quantity, location, and more. Stow line items cannot exist without a stow job.

The individual stow line items of a stow job can be started and completed in any order. Multiple line items can be in progress at the same time.

### Instructive and operational data

#### Instructive data

Instructive data in the stow line item contains all information that an admin might want to write into a job so that her employees have all necessary information for performing the task. This covers data on the item to be moved such as scannable codes and information on the items, quantity, and locations that should be changed. The instructive data is divided into:

* `takeFrom`, covering everything relevant for taking items at the start of the job and
* `stowTo`, covering everything relevant for stowing the items or discarding them.

#### Operational data

Operational data in the stow line item contains all information that is updated during the execution of the job. The operational data is divided into:

* `taken`, containing information on where (which stock or location) the item was taken from and how much was taken and
* `stowed`, containing information on where (which stock or location) the item was stowed and how much was stowed.

`taken` must always be provided either before or at the same time as `stowed`. If `taken` is provided separately from `stowed` a transfer stock is created internally representing the amount of goods which is currently in transit. The purpose of this stock is to keep the facility wide stock levels to change during the movement of goods.

### Stowing types

Depending on the type of action that should be performed during the stow job, different types can be defined in the `takeFrom` and `stowTo` objects of the stow line item. The following types are available:

* **LOCATION**: Should be used if items should be taken from or stowed to a specific location but the exact stock that is chosen does not matter.
* **STOCK**: Should be used if items should be taken from or stowed to a specific location and the exact stock that is chosen matters. This could, for example, be the case if there are multiple expiry dates for the same item on one location. Can also be used if storage locations are not active on a tenant.
* **UNREGISTERED**: Should be used if new stock should be created for an item. This could, for example, be the case if items are found in a store that have not yet been booked into the systems. Can only be set as type for `takeFrom`. No stock or storage location can be set in the `takeFrom` object when using this type since a new stock will be created.
* **DISCARD**: Should be used if stock should be booked out of the systems and be discarded. This could, for example, be the case if items are broken or damaged. Can only be set as type for `stowTo`. No stock or storage location can be set in the `stowTo` object when using this type since the stock will be deleted.

{% hint style="info" %}
Stow line items can be updated using the `ModifyStowLineItemsAction`.
{% endhint %}

## **Stowing status**

A stow job can have one of the following status: `OPEN`, `IN_PROGRESS`, `CANCELED`, `CLOSED`, or `PAUSED`. Status can be set externally via action (no status is set implicitly).

The stow job can only be set to a finalized state (`CLOSED`, `CANCELED`) if all stow line items are in a "coherent" state: Either nothing was taken or stowed, or the same amount was taken and stowed. This is done to prevent losing track of in-transit stock.

{% hint style="warning" %}
A stow job must be in status `IN_PROGRESS` for items to be taken or stowed.
{% endhint %}

The following state transfers are allowed:

<table><thead><tr><th width="183" align="center">From ⬇️ / To ➡️</th><th align="center">Open</th><th align="center">In progress</th><th align="center">Canceled</th><th align="center">Closed</th><th align="center">Paused</th></tr></thead><tbody><tr><td align="center">O<strong>pen</strong></td><td align="center">yes</td><td align="center">yes</td><td align="center">yes</td><td align="center">yes</td><td align="center">yes</td></tr><tr><td align="center">I<strong>n progress</strong></td><td align="center">allowed if nothing was stowed already</td><td align="center">yes</td><td align="center">yes</td><td align="center">yes</td><td align="center">yes</td></tr><tr><td align="center">C<strong>anceled</strong></td><td align="center">no</td><td align="center">no</td><td align="center">yes</td><td align="center">no</td><td align="center">no</td></tr><tr><td align="center">C<strong>losed</strong></td><td align="center">no</td><td align="center">no</td><td align="center">no</td><td align="center">yes</td><td align="center">no</td></tr><tr><td align="center">P<strong>aused</strong></td><td align="center">allowed if nothing was stowed already</td><td align="center">yes</td><td align="center">yes</td><td align="center">yes</td><td align="center">yes</td></tr></tbody></table>

## Stock updates via stow jobs

* Stock is updated after a stow line item was taken.

{% hint style="warning" %}
The target stock or location will not be updated until the items were stowed.
{% endhint %}

* Stock that has been already taken but has not been stowed or discarded yet is referenced in the `heldItems` object of the stow line item. In addition, the stock gets the ["IN\_MOTION" trait](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/inventory-traits) which makes it identifiable as a stock that is currently being moved and should not be updated.
* An **internet connection** is needed for starting and closing the job. However, stowing actions can also be performed without an internet connection. Results will be synced as soon as a connection is available.

### **External stock change reasons**

There are **reasons why stock is moved within a facility**. Especially when goods are **found, lost, or expire** it is important to know why stock quantity changed or why stock was moved. Therefore, stow line items can optionally contain information on why the action was performed. It is possible to configure multiple reasons per stow line item, e.g., "expired" and "broken". Reasons are solely defined by the user. The fulfillmenttools platform does not react on stock change reasons.

{% hint style="info" %}
Reasons must be configured via [stock change reasons REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/externalstockchangereasons) before they can be used in stow jobs.
{% endhint %}

## Create a stow job

To create a `stow job`, make a `POST` request to the `/api/stowjobs` endpoint.

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/stowjobs
```

The request body must contain the details of the job.

* If a listing is already defined for an article, it can be referenced by providing only the `tenantArticleId`. The remaining attributes are taken from the listing, but they can be overridden by including them in the request.
* The `stowTo` array can contain one or more objects if the items are being moved to different destination storage locations.

```json
{
    "facilityRef": "YOUR_FACILITY_REF",
    "priority": 0,
    "shortId": "YOUR_SHORT_ID",
    "status": "OPEN",
    "stowLineItems": [
        {
            "article": {
                "tenantArticleId": "string"
            },
            "stowTo": [
                {
                    "quantity": 2,
                    "storageLocationRef": "DESTINATION_STORAGE_LOCATION_REF",
                    "type": "LOCATION"
                }
            ],
            "takeFrom": {
                "quantity": 2,
                "storageLocationRef": "SOURCE_STORAGE_LOCATION_REF",
                "type": "LOCATION"
            }
        }
    ],
    "targetTime": "1970-01-01T00:00:00.000Z"
}
```

A successful request returns a HTTP `201 Created` status code and a response body representing the created `stow job`:

```json
{
    "id": "71523fea-d80f-45e2-a128-9af163352db3",
    "created": "2024-12-16T12:00:38.362Z",
    "lastModified": "2024-12-16T12:00:38.362Z",
    "version": 1,
    "facilityRef": "YOUR_FACILITY_REF",
    "status": "OPEN",
    "stowLineItems": [
        {
```

## Use case example

### **Relocate items between locations**

An admin wants items from a goods receipt to be stowed or items to be relocated.

1. Create stow job using [POST `/api/stowjobs`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs)
   1. set status to `OPEN`
   2. use `takeFrom.type` `LOCATION` and `stowTo.type` `LOCATION`
2. Job is started by worker. Set status to `IN_PROGRESS` using [StartStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).
3. Items are taken from start location. Set `TAKEN` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions). A `takenStockRef` must be set to in order to define which stock should be reduced.
4. Items are stowed to target location. Set `STOWED` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).
   1. A `stowedStockRef` and `stowedStorageLocationRef` must be sent but can also be null.
   2. If a `stowedStockRef` is provided, the moved stock is added to the specified stock. If null, a new stock is created.
   3. If a `stowedStorageLocationRef` is provided, the stock will be created on that location. If null, a stock is created without a reference to any location.
5. Repeat step "3." & "4." until everything is stowed.
6. Set status to `CLOSED` via [CloseStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).

### Create stock for items that are not registered yet

An admin wants new stock to be booked to location.

1. Create stow job using [POST `/api/stowjobs`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs)
   1. set status to `OPEN`
   2. use `takeFrom.type` `UNREGISTERED` and `stowTo.type` `LOCATION`
2. If new stock should have properties or traits, it can be defined in the `stockInformation` of the `takeFrom` object.
3. Job is started by worker. Set status to `IN_PROGRESS` using [StartStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).
4. Items are taken up by the worker. Set `TAKEN` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions). A `takenStockRef` must be sent but can be null since a new stock will be created based on data in `taken.takenQuantity` and `takeFrom.stockInformation`.
5. Follow steps "4." to "6." from [above](#relocate-items-between-locations).

### **Discard stock**

Admin wants stock to be discarded.

1. Create stow job using [POST `/api/stowjobs`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs)
   1. set status to `OPEN`
   2. use `takeFrom.type` `LOCATION` and `stowTo.type` `DISCARD`
2. Job is started by worker. Set status to `IN_PROGRESS` using [StartStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).
3. Items are taken from start location. Set `TAKEN` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions). A `takenStockRef` must be set to in order to define which stock should be reduced.
4. Items are discarded. Set `STOWED` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions). A `stowedStockRef` must be sent but can be null since the stock is deleted after stowing was completed.
5. Set status to `CLOSED` via [CloseStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).

### Add a reason for changing a stow line item

Admin wants stock to be discarded and worker specifies a reason for discarding, e.g., "BROKEN".

1. Create stow job using [POST `/api/stowjobs`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs)
   1. set status to `OPEN`
   2. use `takeFrom.type` `LOCATION` and `stowTo.type` `DISCARD`
2. Job is started by worker. Set status to `IN_PROGRESS` using [StartStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).
3. Items are taken from start location. Set `TAKEN` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions). A `takenStockRef` must be set to in order to define which stock should be reduced.
4. Items are discarded and worker defined reason for discarding stock. Set `STOWED` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).
   1. A `stowedStockRef` must be sent but can be null since the stock is deleted after stowing was completed.
   2. The reasons array of the corresponding stow line item can have one or multiple reasons. Each reason must be one of the following:
   3. An object containing `id: <id>` of a preconfigured (active) [external stock change reason](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/external-stock-change-reasons).
   4. An object containing `tenantReasonId: <tenantReasonId>` of an (active) preconfigured external stock change reason.
   5. An object containing `reasonLocalized: <LocalizedString>`. See [Localization](https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization) for the format of `LocalizedString`. For this option, the reason does not need to be preconfigured. The object can optionally contain a `tenantReasonId`, if there is no preconfigured [external stock change reason](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/external-stock-change-reasons) with that Id.
5. Set status to `CLOSED` via [CloseStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).
6. Follow the steps above.

### **Relocate items between stocks**

Admin wants a specific stock to be relocated. This could, for example, be the case if there are multiple expiry dates for the same item on one location.

1. Create stow job using [POST `/api/stowjobs`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs)
   1. set status to `OPEN`
   2. use `takeFrom.type` `STOCK` and `stowTo.type` `STOCK`
2. Job is started by worker. Set status to `IN_PROGRESS` using [StartStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).
3. Items are taken. Set `TAKEN` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions). A `takenStockRef` must be set to in order to define which stock should be reduced.
4. Items are stowed. Set `STOWED` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions). A `stowedStockRef` must be sent but can also be null.

{% hint style="warning" %}
If no `stowedStockRef` is defined, a new stock will be created.
{% endhint %}

5. Repeat step "3." & "4." until everything is stowed.
6. Set status to `CLOSED` via [CloseStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).

### Change the priority of a stow job

The `priority` can be defined on `stowJob` level. Any value can be set meaning users can define their own logic. Priority can be set using [PATCH `/api/stowjobs/{stowJobId}`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/stowjobs/-stowJobId-).

### Relocate items from one to multiple locations

Admin wants items to be moved from one location to multiple other locations. This could, for example, be the case if items should be stored after a goods receipt was completed.

1. Create stow job using [POST `/api/stowjobs`](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs)
   1. set status to `OPEN`
   2. use `takeFrom.type` `LOCATION` and `stowTo.type` `LOCATION`
   3. define all target locations along with the respective quantities in the `stowTo` array
   4. Job is started by worker. Set status to `IN_PROGRESS` using [StartStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).
2. Items are taken from start location. Set `TAKEN` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions). A `takenStockRef` must be set to in order to define which stock should be reduced.
3. Items are stowed to target location. Set `STOWED` information in operative data via [ModifyStowLineItems action](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).
   1. Define the ID of the `stowTo` object that should be updated.
   2. It is necessary to send the complete `stowTo` array, even if only one object should be updated.
   3. A `stowedStockRef` and `stowedStorageLocationRef` must be sent but can also be null.
   4. If a `stowedStockRef` is provided, the moved stock is added to the specified stock. If null, a new stock is created.
   5. If a `stowedStorageLocationRef` is provided, the stock will be created on that location. If null, a stock is created without a reference to any location.
4. Repeat step "3." & "4." until everything is stowed.
5. Set status to `CLOSED` via [CloseStowJobAction](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/stowjobs/-stowJobId-/actions).


# Stow job endpoints

## The StowJob object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"StowJob":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":20,"type":"array"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"id":{"description":"Auto-generated, unique primary identifier of the stow job","type":"string"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItem"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["facilityRef","status","stowLineItems","id","version"],"title":"StowJob","type":"object","description":"StowJob"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"StowLineItem":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"heldStockRef":{"description":"Reference to a stock holding the goods after a take and before a stow has taken place","type":"string"},"id":{"description":"The ID of the stowLineItem. It is generated automatically during creation and serves as primary identifier of the entity","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonOutput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToWithId"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFrom"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom","id"],"title":"StowLineItem","type":"object","description":"StowLineItem"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"},"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"},"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"}}}}
```

## Get stow job

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stow jobs.","name":"Stowing"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StowJob":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":20,"type":"array"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"id":{"description":"Auto-generated, unique primary identifier of the stow job","type":"string"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItem"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["facilityRef","status","stowLineItems","id","version"],"title":"StowJob","type":"object","description":"StowJob"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"StowLineItem":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"heldStockRef":{"description":"Reference to a stock holding the goods after a take and before a stow has taken place","type":"string"},"id":{"description":"The ID of the stowLineItem. It is generated automatically during creation and serves as primary identifier of the entity","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonOutput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToWithId"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFrom"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom","id"],"title":"StowLineItem","type":"object","description":"StowLineItem"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"},"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"},"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stowjobs/{stowJobId}":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"getStowJob","parameters":[{"in":"path","name":"stowJobId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StowJob"}}},"description":"Requested Stow Job entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get stow job","tags":["Stowing"]}}}}
```

## List stow jobs

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stow jobs.","name":"Stowing"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StowJobPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"stowJobs":{"items":{"$ref":"#/components/schemas/StowJob"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","stowJobs"],"title":"StowJobPaginatedResult","type":"object","description":"StowJobPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"StowJob":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":20,"type":"array"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"id":{"description":"Auto-generated, unique primary identifier of the stow job","type":"string"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItem"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["facilityRef","status","stowLineItems","id","version"],"title":"StowJob","type":"object","description":"StowJob"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"StowLineItem":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"heldStockRef":{"description":"Reference to a stock holding the goods after a take and before a stow has taken place","type":"string"},"id":{"description":"The ID of the stowLineItem. It is generated automatically during creation and serves as primary identifier of the entity","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonOutput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToWithId"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFrom"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom","id"],"title":"StowLineItem","type":"object","description":"StowLineItem"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"},"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"},"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stowjobs":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"getStowJobs","parameters":[{"description":"The number of items to return.","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"number"}},{"description":"The ID of the last item from the previous page. The next page will start after this ID.","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"in":"query","name":"sort","required":false,"schema":{"enum":["LAST_MODIFIED_ASC","LAST_MODIFIED_DESC"],"type":"string"}},{"in":"query","name":"facilityRef","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"tenantArticleId","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"locationRef","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"explode":false,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"type":"array"}},{"in":"query","name":"stockRef","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"shortId","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"priority","required":false,"schema":{"items":{"type":"number"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StowJobPaginatedResult"}}},"description":"Paginated result containing the matching Stow Job entities"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List stow jobs","tags":["Stowing"]}}}}
```

## Create stow job

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stow jobs.","name":"Stowing"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StowJobForCreation":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationById"},{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUser"}]},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItemForCreation"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"}},"required":["facilityRef","status","stowLineItems"],"title":"StowJobForCreation","type":"object","description":"StowJobForCreation"},"AssignedUserForCreationById":{"description":"Create a assigned user by giving a valid id","properties":{"userId":{"description":"userId of the user should be assigned","type":"string"}},"required":["userId"],"title":"AssignedUserForCreationById","type":"object"},"AssignedUserForCreationByName":{"description":"Create a assigned user by giving a valid name","properties":{"username":{"description":"username of the user should be assigned","type":"string"}},"required":["username"],"title":"AssignedUserForCreationByName","type":"object"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"StowLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"reasons":{"description":"The reasons for the stow operation. Each reason can either be a stand-alone reason, or a preconfigured reasons by specifying the tenantReasonId and/or the id of the reason. If tenantReasonId and id are specified, they have to match.","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonInput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToForCreation"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFromForCreation"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom"],"title":"StowLineItemForCreation","type":"object","description":"StowLineItemForCreation"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonInput":{"properties":{"reasonLocalized":{"description":"List of localized reason strings. If provided, no preconfiguration is necessary. Cannot be provided in combination with id or existing tenantReasonId.","type":"object"},"id":{"description":"ID of reason. Use to enrich with preconfigured reason","type":"string"},"tenantReasonId":{"description":"tenantReasonId of reason. If no reasonLocalized provided, a preconfigured reason with the tenantReasonId must be present","type":"string"}},"title":"ExternalStockChangeReasonInput","type":"object","description":"ExternalStockChangeReasonInput"},"StowLineItemStowToForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowToForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemStowToForCreation","type":"object","description":"StowLineItemStowToForCreation"},"StowedStowLineItemStowToForCreation":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed. Will be set to the current time if not provided.","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowToForCreation","type":"object","description":"StowedStowLineItemStowToForCreation"},"StowLineItemTakeFromForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFromForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFromForCreation","type":"object","description":"StowLineItemTakeFromForCreation"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFromForCreation":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFromForCreation","type":"object","description":"TakenStowLineItemTakeFromForCreation"},"StowJob":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":20,"type":"array"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"id":{"description":"Auto-generated, unique primary identifier of the stow job","type":"string"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItem"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["facilityRef","status","stowLineItems","id","version"],"title":"StowJob","type":"object","description":"StowJob"},"StowLineItem":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"heldStockRef":{"description":"Reference to a stock holding the goods after a take and before a stow has taken place","type":"string"},"id":{"description":"The ID of the stowLineItem. It is generated automatically during creation and serves as primary identifier of the entity","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonOutput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToWithId"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFrom"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom","id"],"title":"StowLineItem","type":"object","description":"StowLineItem"},"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"},"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"},"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stowjobs":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"createStowJob","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StowJobForCreation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StowJob"}}},"description":"Created Stow Job entity"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The syntax of the request content was correct, but it was unable to process the contained instructions, possibly due to semantic errors."}},"summary":"Create stow job","tags":["Stowing"]}}}}
```

## List stow jobs (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for StowJob

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stow jobs.","name":"Stowing"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StowJobSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/StowJobSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/StowJobSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"StowJobSearchPayload","type":"object","description":"StowJobSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"StowJobSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StowJobSearchQuery"},"maxItems":500,"type":"array"},"created":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"default":{"after":"-P1W"},"description":"Search entries by created. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/StowJobSearchQuery"},"maxItems":500,"type":"array"},"priority":{"allOf":[{"$ref":"#/components/schemas/NumberFilter"}],"description":"Search by priority"},"shortId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by shortId"},"status":{"allOf":[{"$ref":"#/components/schemas/StowJobStatusTypeEnumFilter"}],"description":"Search by status"},"stowLineItems":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsListFilter"}],"description":"Nested list search by stowLineItems"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"}},"title":"StowJobSearchQuery","type":"object","description":"StowJobSearchQuery"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"NumberFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"in":{"items":{"type":"number"},"maxItems":25,"type":"array"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"type":"number"},"maxItems":25,"type":"array"}},"title":"NumberFilter","type":"object","description":"NumberFilter"},"StowJobStatusTypeEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"}},"title":"StowJobStatusTypeEnumFilter","type":"object","description":"StowJobStatusTypeEnumFilter"},"StowJobStowLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsListFilter","type":"object","description":"StowJobStowLineItemsListFilter"},"StowJobStowLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsArticleFilter"}],"description":"Nested search by article"},"heldStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by heldStockRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"stowTo":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToListFilter"}],"description":"Nested list search by stowTo"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromFilter"}],"description":"Nested search by takeFrom"}},"title":"StowJobStowLineItemsFilter","type":"object","description":"StowJobStowLineItemsFilter"},"StowJobStowLineItemsArticleFilter":{"properties":{"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"}},"title":"StowJobStowLineItemsArticleFilter","type":"object","description":"StowJobStowLineItemsArticleFilter"},"StowJobStowLineItemsStowToListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"StowJobStowLineItemsStowToListFilter","type":"object","description":"StowJobStowLineItemsStowToListFilter"},"StowJobStowLineItemsStowToFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsStowToStowedFilter"}],"description":"Nested search by stowed"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsStowToFilter","type":"object","description":"StowJobStowLineItemsStowToFilter"},"StowJobStowLineItemsStowToStowedFilter":{"properties":{"stowedStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStockRef"},"stowedStorageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by stowedStorageLocationRef"}},"title":"StowJobStowLineItemsStowToStowedFilter","type":"object","description":"StowJobStowLineItemsStowToStowedFilter"},"StowJobStowLineItemsTakeFromFilter":{"properties":{"storageLocationRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by storageLocationRef"},"taken":{"allOf":[{"$ref":"#/components/schemas/StowJobStowLineItemsTakeFromTakenFilter"}],"description":"Nested search by taken"},"type":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by type"}},"title":"StowJobStowLineItemsTakeFromFilter","type":"object","description":"StowJobStowLineItemsTakeFromFilter"},"StowJobStowLineItemsTakeFromTakenFilter":{"properties":{"takenStockRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by takenStockRef"}},"title":"StowJobStowLineItemsTakeFromTakenFilter","type":"object","description":"StowJobStowLineItemsTakeFromTakenFilter"},"StowJobSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"},"customAttributes":{"additionalProperties":true,"maxProperties":1,"minProperties":1,"type":"object"},"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"StowJobSort","type":"object","description":"StowJobSort"},"StowJobPaginatedResult":{"properties":{"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"stowJobs":{"items":{"$ref":"#/components/schemas/StowJob"},"type":"array"},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","stowJobs"],"title":"StowJobPaginatedResult","type":"object","description":"StowJobPaginatedResult"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"StowJob":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":20,"type":"array"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"Non-human-readable reference to the facility where the stow job is executed","type":"string"},"id":{"description":"Auto-generated, unique primary identifier of the stow job","type":"string"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"priority":{"description":"Priority level of the job","type":"number"},"shortId":{"description":"Readable identifier for display purposes, not unique.","type":"string"},"status":{"description":"The status of the stowJob","enum":["OPEN","IN_PROGRESS","CLOSED","CANCELED","PAUSED"],"type":"string"},"stowLineItems":{"description":"The line items that should be stowed","items":{"$ref":"#/components/schemas/StowLineItem"},"type":"array"},"targetTime":{"description":"The time by which the job should be completed. Use for prioritization and scheduling","format":"date-time","type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["facilityRef","status","stowLineItems","id","version"],"title":"StowJob","type":"object","description":"StowJob"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"StowLineItem":{"properties":{"article":{"$ref":"#/components/schemas/StowLineItemArticle"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"heldStockRef":{"description":"Reference to a stock holding the goods after a take and before a stow has taken place","type":"string"},"id":{"description":"The ID of the stowLineItem. It is generated automatically during creation and serves as primary identifier of the entity","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonOutput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToWithId"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFrom"}],"description":"Instructions on how and where to take the item from"}},"required":["article","stowTo","takeFrom","id"],"title":"StowLineItem","type":"object","description":"StowLineItem"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonOutput":{"properties":{"reasonLocalized":{"description":"Localized reason strings","type":"object"},"tenantReasonId":{"description":"tenantReasonId of reason","type":"string"}},"required":["reasonLocalized"],"title":"ExternalStockChangeReasonOutput","type":"object","description":"ExternalStockChangeReasonOutput"},"StowLineItemStowToWithId":{"properties":{"id":{"description":"The ID of the stowTo instruction","type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowTo"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type","id"],"title":"StowLineItemStowToWithId","type":"object","description":"StowLineItemStowToWithId"},"StowedStowLineItemStowTo":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowTo","type":"object","description":"StowedStowLineItemStowTo"},"StowLineItemTakeFrom":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFrom"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFrom","type":"object","description":"StowLineItemTakeFrom"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFrom":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFrom","type":"object","description":"TakenStowLineItemTakeFrom"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stowjobs/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for StowJob","operationId":"searchStowJob","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StowJobSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StowJobPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List stow jobs (search)","tags":["Stowing"]}}}}
```

## Update stow job

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stow jobs.","name":"Stowing"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StowJobForPatch":{"properties":{"assignedUsers":{"description":"The users that are assigned to the stow job","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationById"},{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUser"}]},"maxItems":20,"type":"array"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"priority":{"description":"Information for user about which job should be started first","type":"number"},"targetTime":{"format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms","type":"number"}},"required":["version"],"title":"StowJobForPatch","type":"object","description":"StowJobForPatch"},"AssignedUserForCreationById":{"description":"Create a assigned user by giving a valid id","properties":{"userId":{"description":"userId of the user should be assigned","type":"string"}},"required":["userId"],"title":"AssignedUserForCreationById","type":"object"},"AssignedUserForCreationByName":{"description":"Create a assigned user by giving a valid name","properties":{"username":{"description":"username of the user should be assigned","type":"string"}},"required":["username"],"title":"AssignedUserForCreationByName","type":"object"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stowjobs/{stowJobId}":{"patch":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"Patch StowJob","parameters":[{"in":"path","name":"stowJobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StowJobForPatch"}}},"required":true},"responses":{"200":{"description":"Stow Job successfully patched"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The syntax of the request content was correct, but it was unable to process the contained instructions, possibly due to semantic errors."}},"summary":"Update stow job","tags":["Stowing"]}}}}
```

## Call stow job action

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read stow jobs.","name":"Stowing"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StartStowJobAction":{"description":"Sets the status of the stowjob to IN_PROGRESS","properties":{"name":{"description":"The name of the action that should be performed","enum":["START_STOW_JOB"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name"],"title":"StartStowJobAction","type":"object"},"PauseStowJobAction":{"description":"Sets the status of the stowjob to PAUSED","properties":{"name":{"description":"The name of the action that should be performed","enum":["PAUSE_STOW_JOB"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name"],"title":"PauseStowJobAction","type":"object"},"CancelStowJobAction":{"description":"Sets the status of the stowjob to CANCELED","properties":{"name":{"description":"The name of the action that should be performed","enum":["CANCEL_STOW_JOB"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name"],"title":"CancelStowJobAction","type":"object"},"ReopenStowJobAction":{"description":"Sets the status of the stowjob to OPEN","properties":{"name":{"description":"The name of the action that should be performed","enum":["OPEN_STOW_JOB"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name"],"title":"ReopenStowJobAction","type":"object"},"CloseStowJobAction":{"description":"Sets the status of the stowjob to CLOSED","properties":{"name":{"description":"The name of the action that should be performed","enum":["CLOSE_STOW_JOB"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name"],"title":"CloseStowJobAction","type":"object"},"ModifyStowLineItemsAction":{"description":"MODIFY_STOW_LINE_ITEMS targets specific stowJob.stowLineItems by ID. Each targeted entry is partially updated: provided fields are completely replaced, while unspecified fields remain unchanged. New entries can be added by omitting the ID field.","properties":{"name":{"description":"The name of the action that should be performed","enum":["MODIFY_STOW_LINE_ITEMS"],"type":"string"},"stowLineItems":{"items":{"$ref":"#/components/schemas/StowLineItemForUpdate"},"type":"array"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name","stowLineItems"],"title":"ModifyStowLineItemsAction","type":"object"},"StowLineItemForUpdate":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/StowLineItemArticle"}],"description":"The article that should be stowed"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"description":"The ID of the stowLineItem. Leave empty for creation","type":"string"},"reasons":{"description":"The reasons for the stow operation","items":{"$ref":"#/components/schemas/ExternalStockChangeReasonInput"},"maxItems":10,"type":"array"},"stowTo":{"description":"Instructions on how and where to stow the item","items":{"$ref":"#/components/schemas/StowLineItemStowToForUpdate"},"type":"array"},"takeFrom":{"allOf":[{"$ref":"#/components/schemas/StowLineItemTakeFromForCreation"}],"description":"Instructions on how and where to take the item from"}},"title":"StowLineItemForUpdate","type":"object","description":"StowLineItemForUpdate"},"StowLineItemArticle":{"properties":{"titleLocalized":{"description":"The translations for the title of the item","type":"object"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this item. Please make sure that no authentication is required to fetch the image!","type":"string"},"measurementUnitKey":{"description":"Identifier for the item's unit of measurement","type":"string"},"scannableCodes":{"description":"ScannableCodes such as barcodes related to the item","items":{"type":"string"},"type":"array"},"tenantArticleId":{"description":"Identifier for a certain product which the StowLineItem refers to","type":"string"},"title":{"description":"The title of the item","type":"string"}},"required":["tenantArticleId"],"title":"StowLineItemArticle","type":"object","description":"StowLineItemArticle"},"ExternalStockChangeReasonInput":{"properties":{"reasonLocalized":{"description":"List of localized reason strings. If provided, no preconfiguration is necessary. Cannot be provided in combination with id or existing tenantReasonId.","type":"object"},"id":{"description":"ID of reason. Use to enrich with preconfigured reason","type":"string"},"tenantReasonId":{"description":"tenantReasonId of reason. If no reasonLocalized provided, a preconfigured reason with the tenantReasonId must be present","type":"string"}},"title":"ExternalStockChangeReasonInput","type":"object","description":"ExternalStockChangeReasonInput"},"StowLineItemStowToForUpdate":{"properties":{"id":{"type":"string"},"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"stowed":{"allOf":[{"$ref":"#/components/schemas/StowedStowLineItemStowToForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be stowed on a specific stock or storage location. Use type DISCARD if the item should be booked out of the system","enum":["STOCK","LOCATION","DISCARD"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemStowToForUpdate","type":"object","description":"StowLineItemStowToForUpdate"},"StowedStowLineItemStowToForCreation":{"properties":{"stowedAt":{"description":"Time and date on which the item was stowed. Will be set to the current time if not provided.","format":"date-time","type":"string"},"stowedQuantity":{"description":"Quantity that was stowed","type":"number"},"stowedStockRef":{"description":"Specifies the stock where the item will be stowed. Set this to null to explicitly create a new stock. \n Exception: If stowTo.type is \"DISCARD\", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.","nullable":true,"type":"string"},"stowedStorageLocationRef":{"description":"If a new stock is created via stowedStockRef = null, this is used to set the storage location of the new stock. \n If a stock is specified, this field will be ignored.","type":"string"}},"required":["stowedStockRef","stowedQuantity"],"title":"StowedStowLineItemStowToForCreation","type":"object","description":"StowedStowLineItemStowToForCreation"},"StowLineItemTakeFromForCreation":{"properties":{"quantity":{"description":"Quantity that should be taken / stowed","type":"number"},"scannableCodes":{"description":"ScannableCodes such as barcodes relevant for taking or stowing the item","items":{"type":"string"},"type":"array"},"stockInformation":{"allOf":[{"$ref":"#/components/schemas/StowJobStockInformation"}],"description":"Additional information about the newly created stock. **Only allowed for type UNREGISTERED**"},"stockRef":{"description":"Stock from which the item should be taken / stowed to. Leave empty for type UNREGISTERED / DISCARD.","type":"string"},"storageLocationRef":{"description":"Storage location from which the item should be taken or to which the item should be stowed","type":"string"},"taken":{"allOf":[{"$ref":"#/components/schemas/TakenStowLineItemTakeFromForCreation"}],"description":"Operative data holding information about the stowing progress. **As for now stocks will *not* be updated even if the numbers indicate so because the stow job feature is still under development.**"},"type":{"description":"Define if items should be taken from specific stock or storage location. Use type UNREGISTERED if a new item should be booked into the system","enum":["STOCK","LOCATION","UNREGISTERED"],"type":"string"}},"required":["quantity","type"],"title":"StowLineItemTakeFromForCreation","type":"object","description":"StowLineItemTakeFromForCreation"},"StowJobStockInformation":{"properties":{"properties":{"additionalProperties":{"type":"string"},"allOf":[{"$ref":"#/components/schemas/StockPropertyPreset"}],"description":"allow tracking of specific values such as expiry dates on a set of items. They should describe physical identifiable properties of the stock and are not meant to be used for metadata (see \"customAttributes\" for that)."},"traitConfig":{"items":{"$ref":"#/components/schemas/StorageLocationTraitConfigEntry"},"type":"array"}},"title":"StowJobStockInformation","type":"object","description":"StowJobStockInformation"},"StockPropertyPreset":{"properties":{"expiry":{"type":"string"}},"title":"StockPropertyPreset","type":"object","description":"StockPropertyPreset"},"StorageLocationTraitConfigEntry":{"properties":{"enabled":{"description":"whether the trait is enabled or not","type":"boolean"},"trait":{"description":"Describes what kind of actions this stock is available for\n     * `PICKABLE`- The stock is available for picking\n     * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)\n     * `KEEP_ON_ZERO`- The stock will not be deleted when emptied\n     * `OUTBOUND`- The stock is intended for outbound processes","type":"string"}},"required":["enabled","trait"],"title":"StorageLocationTraitConfigEntry","type":"object","description":"StorageLocationTraitConfigEntry"},"TakenStowLineItemTakeFromForCreation":{"properties":{"takenAt":{"description":"Time and date on which the item was taken","format":"date-time","type":"string"},"takenQuantity":{"description":"Quantity that was taken","type":"number"},"takenStockRef":{"description":"Specifies the stock from which the goods will be taken. \n Exception: If stowTo.type is \"UNREGISTERED\", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.","nullable":true,"type":"string"}},"required":["takenQuantity","takenStockRef"],"title":"TakenStowLineItemTakeFromForCreation","type":"object","description":"TakenStowLineItemTakeFromForCreation"},"StowJobReplaceAssignedUsersAction":{"description":"REPLACE_ASSIGNED_USERS replaces the assigned users of the stow job","properties":{"assignedUsers":{"description":"The users are assigned to the stow job","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationById"},{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUser"}]},"maxItems":20,"type":"array"},"name":{"description":"The name of the action that should be performed","enum":["REPLACE_ASSIGNED_USERS"],"type":"string"},"version":{"description":"The current version of the stow job that should be modified","type":"number"}},"required":["version","name","assignedUsers"],"title":"StowJobReplaceAssignedUsersAction","type":"object"},"AssignedUserForCreationById":{"description":"Create a assigned user by giving a valid id","properties":{"userId":{"description":"userId of the user should be assigned","type":"string"}},"required":["userId"],"title":"AssignedUserForCreationById","type":"object"},"AssignedUserForCreationByName":{"description":"Create a assigned user by giving a valid name","properties":{"username":{"description":"username of the user should be assigned","type":"string"}},"required":["username"],"title":"AssignedUserForCreationByName","type":"object"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/stowjobs/{stowJobId}/actions":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />","operationId":"Post StowJob Actions","parameters":[{"in":"path","name":"stowJobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/StartStowJobAction"},{"$ref":"#/components/schemas/PauseStowJobAction"},{"$ref":"#/components/schemas/CancelStowJobAction"},{"$ref":"#/components/schemas/ReopenStowJobAction"},{"$ref":"#/components/schemas/CloseStowJobAction"},{"$ref":"#/components/schemas/ModifyStowLineItemsAction"},{"$ref":"#/components/schemas/StowJobReplaceAssignedUsersAction"}]}}},"required":true},"responses":{"200":{"description":"Actions successfully performed"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"A version conflict occurred."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The syntax of the request content was correct, but it was unable to process the contained instructions, possibly due to semantic errors."}},"summary":"Call stow job action","tags":["Stowing"]}}}}
```


# Configurations

Configurations in inventory management define storage principles and handling for special cases in stock and reservation management.

<table><thead><tr><th width="166.71614583333331">Configuration</th><th width="217.3046875">Path</th><th width="264.8984375">Description</th><th width="100.015625">Default</th></tr></thead><tbody><tr><td><a href="#unmixed-storage-configuration">Unmixed storage</a></td><td><a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/inventory">/api/configurations/inventory</a><br><br><a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/facilities/-facilityId-/configurations/inventory">/api/facilities/{facilityId}/configurations/inventory</a></td><td>Defines whether stock with different <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-properties">properties</a> (for example, expiry dates) can be stored at the same location.</td><td><code>inactive</code></td></tr><tr><td><a href="#outbound-stock-configuration">Outbound stock</a></td><td><a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/facilities/-facilityId-/configurations/inventory">/api/facilities/{facilityId}/configurations/inventory</a></td><td>Defines if stock is booked to an outbound location after picking.</td><td><code>inactive</code></td></tr><tr><td><a href="#short-pick-configuration">Short pick</a></td><td><a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/stock">/api/facilities/{facilityId}/configurations/stock</a></td><td>Sets stock to zero for storage locations where a <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking#short-pick">short pick</a> occurred.</td><td><code>inactive</code></td></tr><tr><td><a href="#reserved-stock-configuration">Reserved stock</a></td><td><a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/stock">/api/configurations/stock</a></td><td>Defines the event after which reservations and stock should be removed.</td><td><code>inactive</code></td></tr><tr><td><a href="#expected-stock-configuration">Expected stock</a></td><td><a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/stock">/api/configurations/stock</a></td><td>Automatically creates expected stock from expected line items in routing plan.</td><td><code>inactive</code></td></tr><tr><td><a href="#inbound-process-configuration">Inbound process</a></td><td><a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/stock">/api/configurations/stock</a></td><td>Automatically creates internal purchase orders in the receiving facility when goods are handed over during an interfacility transfer</td><td><code>active</code></td></tr></tbody></table>

## Unmixed storage configuration

Storage principles for stock properties (such as expiration date) can be defined for each facility. The principle of "unmixed storage" means that the same item with different properties (for example, expiry date) must not be stored at the same location.

Enabling unmixed storage has the following effects:

* If a user tries to stow the same items with different properties at the same storage location, a user prompt appears in the [Inventory app](https://docs.fulfillmenttools.com/documentation/apps/inventory-app).
* For [storage location recommendations](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones#storage-location-recommendations), only locations that meet the unmixed storage principle are shown.

The unmixed storage configuration should be disabled if stock properties aren't relevant while stowing or relocating items.

{% hint style="warning" %}
The configuration `isMixed` must be set to `false` to enable unmixed storage in the facility.
{% endhint %}

{% hint style="info" %}
The configuration can be activated on the network level with the [inventory configuration REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/configurations/inventory). The configuration can be activated at the facility level with the [inventory configuration facility REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/facilities/-facilityId-/configurations/inventory).
{% endhint %}

## Outbound stock configuration

Inventory levels can be tracked until items physically leave the facility and are handed over to another legal entity (for example, customer or shipping provider).

Outbound inventory refers to stock that has already been picked for an order and physically separated from other stock. It is placed at an outbound location until handed over to another party and finally leaves the warehouse. The outbound location, along with its items, is displayed in the [storage location overview](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/storage-locations-and-zones). Outbound storage locations can also be virtual locations that represent multiple outbound locations within the facility.

Enabling the outbound stock configuration has the following effects:

* After a pick job is completed, the following actions take place:
  * Stocks are reduced at the original location
  * New stock is created on the defined outbound location
  * The reservation is lifted from the original stock and placed on the newly created stock
* Stock at the outbound location is still included in the stock levels communicated via `FACILITY_STOCK_CHANGED` [events](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events) (although, not as [available](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability)). So, external systems still receive accurate stock levels for items physically present in the facility.
* After the stock leaves the facility, all related stocks and reservations are deleted.

{% hint style="info" %}
The configuration can be activated at the facility level using the [inventory configuration facility REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/facilities/-facilityId-/configurations/inventory).
{% endhint %}

## Short pick configuration

A short pick occurs when an order can't be completely picked. This can happen when some ordered items are too low in stock or out of stock. By enabling the config, stock for an item in a facility is set to the picked amount. If nothing could be picked, the stock is set to 0.

**Example for the platform behavior:**

<table><thead><tr><th width="161">Short pick setting</th><th width="138">Current stock</th><th>Ordered quantity</th><th>Picked quantity</th><th>New stock</th></tr></thead><tbody><tr><td>Active</td><td>10</td><td>5</td><td>3</td><td>0</td></tr><tr><td>Inactive</td><td>10</td><td>5</td><td>3</td><td>7</td></tr></tbody></table>

{% hint style="warning" %}
It's strongly advised to activate the `confirmationOnShortPick` in the [picking configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking#configuration-of-picking-methods) at the same time. Otherwise, systems can't differentiate between cases where the user tried to pick an item but failed because there was no available stock, and cases where the pick job was rerouted before the user even tried to pick all ordered items.
{% endhint %}

{% hint style="info" %}
The configuration can be activated on the facility level with the [facility configuration stock REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#patch-/api/facilities/-facilityId-/configurations/stock).
{% endhint %}

## **Reserved stock configuration**

The reserved stock configuration allows users to decide after which event reservations and their respective stock should be removed. This can be helpful, for example, if only handover jobs are used within fulfillmenttools. In the default behavior (if `clearStocksAndReservationsTrigger` is undefined), reservations and stocks are removed after the `PICK_JOB_CLOSED` event.

It's recommended to define a configuration during the initial platform setup and to avoid changes afterward. Changing the configuration, such as switching the reservation removal event from `HANDOVERJOB` to `PICKJOB`, while orders are still in progress, may result in unresolved reservations. In such cases, the affected reservations must be removed using the [reservations REST APIs](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/reservations/actions).

{% hint style="info" %}
The configuration can be activated on the network level with the [stock configuration REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/stock).
{% endhint %}

## Expected stock configuration

Expected stock can be generated automatically as part of advanced order routing. When a routing plan is created for a receiving facility, it includes expected line items for incoming goods. If the configuration parameter `expectedStock.generateFromRoutingPlan` is set to `true`, the system creates expected stock entries of type `ASAP` for these line items and reserves them immediately.

When stock for the corresponding `tenantArticleId` increases at the facility, the system transfers the associated reservations from expected stock to available stock. Expected stock is adjusted if reservations are partially reallocated, and it's removed entirely when no reservations remain, provided that the configuration is active.

The configuration is managed at the network level via the [stock configuration REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/stock). It's `inactive` by default.

{% hint style="warning" %}
If no inbound processes are used, this configuration must be enabled in advanced order routing to avoid creating duplicate reservations.
{% endhint %}

## Inbound process configuration

By default, an internal purchase order is automatically created in the receiving facility when goods are handed over during an interfacility transfer. To disable this behavior, set `inboundProcess.generateFromInterfacilityTransfer` to `false`.

{% hint style="warning" %}
If `expectedStock.generateFromRoutingPlan` is set to `true`, you **must** set `inboundProcess.generateFromInterfacilityTransfer` to `false` to avoid duplicate expected stocks being created.
{% endhint %}

Deactivate this setting if your workflow doesn't use purchase orders.

The configuration is managed at the network level via the [stock configuration REST API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/stock). It's `active` by default.

{% hint style="info" %}
For more information see [Interfacility transfer](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/interfacility-transfer).
{% endhint %}


# Order Management

In fulfillmenttools, an order represents the consumer's intent as captured in the shop system. It describes what the customer wants, independent of how it will fulfill it later. The order is the starting point for all subsequent [routing](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing) and [fulfillment](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations) activities.

The order entity has its own lifecycle and can be in several states that describe the condition of the consumer request.

## Order statuses

The order status reflects the state of the consumer's request. This is the status shown in the [orders API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/orders/-orderId-).

<table><thead><tr><th width="129.3828125">Status</th><th width="611.734375">Description</th></tr></thead><tbody><tr><td><code>OPEN</code></td><td>The order has been created and is ready for further processing.</td></tr><tr><td><code>PROMISED</code></td><td><p>This state represents a preliminary order created for availability and feasibility checks. In this state, the platform can evaluate stock availability, earliest possible delivery dates, carrier options, and other fulfillment constraints before the order becomes binding. A promised order either expires and transitions to an <code>OBSOLETE</code> status, or it's confirmed and becomes a real customer order in the <code>OPEN</code> status.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>For more details on availability checks and promising logic, see the <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising">Availability and Promising documentation</a>.</p></div></td></tr><tr><td><code>LOCKED</code></td><td><p>In some cases, it might be necessary to perform manual checks on an order, for example, customer verification or fraud detection. Locked orders are routed to a facility but don't result in a pick job until they are unlocked. Unlocking can be done manually in <a href="https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders">Backoffice</a> or using the <a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#post-/api/orders/-orderId-/actions">orders action REST API</a>.</p><div data-gb-custom-block data-tag="hint" data-style="warning" class="hint hint-warning"><p>Since a locked order doesn't create a pick job, it's not affected by a <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/reroute#time-triggered-reroute-for-started-pick-jobs">time-triggered reroute</a>.</p></div></td></tr><tr><td><code>CANCELLED</code></td><td>The order was canceled manually or automatically, depending on the configuration.</td></tr><tr><td><code>OBSOLETE</code></td><td>A promised order expires and transitions to this state.</td></tr></tbody></table>

These statuses belong to the order entity itself and don't represent operational progress. They determine whether and when the consumer request can move into operational handling.

## Order definition

### Consumer information

The `consumer` section describes the party on whose behalf the order is placed. The consumer may represent:

* A consumer (for example, an end customer who places an eCommerce order)
* A facility (for example, a supply order)
* A consumer on whose behalf an order is placed by a facility or store

Consumer information may include:

* One or more addresses (for example, postal address, invoice address, or parcel locker address)
* Facility references for supply orders
* Custom attributes for tenant-specific extensions

For supply orders, consumer addresses aren't supported, except for addresses of type `INVOICE_ADDRESS` when the order is placed on behalf of a consumer.

### **Items and product information**

The `orderLineItems` section contains the articles being purchased, including:

* Quantities
* Measurement units
* Scannable codes
* Custom attributes
* Measurement units and their tolerance validations
* Allowed substitutes
* Pricing information
* Tags

If all relevant attributes are maintained in the listing, an item can be provided in its minimal form: `tenantArticleId` and `quantity`**.** All additional article information is then resolved from the [listing](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/listing).

### **Custom services**

[Custom services](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/custom-services) extend the order with additional tasks that must be performed after picking. This enables complex service workflows such as engraving, tailoring, or appointment-based services. They can be attached to the entire order or to specific order line items.

Each service includes:

* Service definition
* Nested service items (optional)
* Article references
* Additional information fields

### **Delivery preferences and order types**

Delivery preferences describe how an order should be fulfilled. They also implicitly define the order type. fulfillmenttools doesn't require an explicit order type field. Instead, the type is derived from the provided delivery preferences.

* If delivery preferences specify `collect`, the order becomes a click-and-collect order.
* If delivery preferences specify `shipping`, the order becomes a ship‑from‑store order.
* If no delivery preference is provided, the system defaults to ship‑from‑store.
* If the consumer is a facility, the order becomes a supply order.

Delivery preferences may include:

* Collect preferences
* Shipping preferences
* Reservation preferences
* Sourcing options reference
* Supplying facilities
* Target times

#### **Click-and-collect order**

A click-and-collect order is created implicitly when the delivery preferences specify a collection at a facility.

The `Order.deliveryPreferences` object identifies the order for in-store collection.

The following attributes in `Order.deliveryPreferences` mark an order as a collect order:

* `paid`: A boolean flag indicating if the consumer has already paid for the order. This flag must be set to `false` for click-and-reserve orders.
* `provisioningTime`: Represents the appointment time for consumer pickup. This appointment time can be changed during the fulfillment process if the consumer's plans change. Based on the `provisioningTime`, it is possible to configure an automatic cancellation timeframe if the consumer doesn't arrive for pickup.
* `facilityRef`: Specifies the pickup facility. This must be a valid `facilityRef`. For details on configuring facilities, see the [Facilities article](https://docs.fulfillmenttools.com/documentation/getting-started/facilities).

**Facility reference:** The consumer's chosen facility location for picking up their order. The [service type fence](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/fences#service-type) will evaluate this attribute.

**Provisioning time**: Indicates when the order is expected to be ready for consumer pickup at the selected facility.

**Supplying facility configuration:**

* These facilities serve as backups for the primary facility in case the primary facility can't fulfill all ordered items. In this case, a [reroute](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/reroute) can be triggered into one of the supplying facilities (which have to be of service type ship-from-store). The supplying facility then fulfills the order and sends it back to the primary facility, where the consumer can pick it up. This limits the number of facilities the [routing rules](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/routing-strategy) must consider. The [service type fence](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/fences#service-type) will evaluate this attribute.
* If supplying facilities are specified for a click-and-collect order, they will compete against the primary click-and-collect facility during initial routing. If a supplying facility performs better than the primary click-and-collect facility, this order will be routed directly to the supplying facility. The supplying facility, in turn, fulfills the order and sends it back to the primary facility.

#### **Ship‑from‑store order**

A ship‑from‑store order is created implicitly when the delivery preferences specify shipment to a consumer address. If no delivery preference is provided, this is the default. The `Order.deliveryPreferences` object identifies the order for shipping. Typically, a shipping label is required to send the parcels.

The following attributes in `Order.deliveryPreferences` mark an order as a shipping order:

* `preferredCarriers`: Defines the logistics carrier chosen for delivery.
* `serviceLevel`: Specifies the service level, which is either `DELIVERY` for standard shipping or `SAMEDAY` for same-day delivery.
* `desiredDeliveryTime`: Contains the delivery time selected by the consumer during checkout. This value, combined with the reservation preference mode, determines when fulfillmenttools checks for stock reservation.
* `reservationPreferences`: Defines behavior for orders that can't be fulfilled immediately after routing. This is relevant when a consumer places an order for future delivery, and the stock shouldn't be reserved instantly (for example, for items with a best-before date).

fulfillmenttools calculates the `targetTime` attribute based on facility and carrier configurations; it is not set directly in the order.

fulfillmenttools performs routing based on:

* Facility configuration
* Listings
* Stock
* Routing parameters (optional)

Relevant delivery preference attributes:

* **Service level:** Defines whether the consumer requires [same day](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/carrier-management/carrier-features-and-requirements#same-day-delivery) or standard delivery. The [service type fence](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/fences#service-type) will evaluate this attribute.
* **Preferred carrier:** Can be used if the consumer wants their order delivered by a specific carrier. The [carrier availability fence](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/fences#carrier-availability) will evaluate this attribute.
* **Preselected facilities**: Specifies several facilities that should be taken into consideration when performing a routing decision instead of all facilities within the network. The [preselected facility fence](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/fences#preselected-facilities) will evaluate this attribute.
* **Desired delivery time/target time:** Used for prioritization and promise calculations.

The `Order.consumer.email` address is forwarded to the logistics carrier when a shipping label is requested. Consumer consent is required to process this personal data; otherwise, a generic email address must be supplied.

#### **Supply order**

A supply order is created implicitly when the consumer information indicates that a facility is placing the order on its own behalf.

Characteristics:

* The requesting facility appears as the consumer.
* fulfillmenttools identifies the best supplying facility.
* The order is fulfilled as an internal [interfacility transfer](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/interfacility-transfer).

#### **Payment information**

The `paymentInfo` section captures the payment method and currency. It doesn't influence routing but is relevant for operational visibility and customer communication.

#### Custom attributes, stickers, and tags

[Custom attributes](https://docs.fulfillmenttools.com/documentation/getting-started/custom-attributes) or [tags](https://docs.fulfillmenttools.com/documentation/getting-started/tags) allow tenants to add additional, tenant‑specific information to an order. They can be used to influence routing logic through the [custom routing rules](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/doms-toolkit) or to attach [stickers](https://docs.fulfillmenttools.com/documentation/getting-started/stickers) to operational entities for better visibility during fulfillment.

## Order events

You can find the relevant order management events in the [available events article](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events).

## **Process**

While the order describes the consumer request, the process represents the complete lifecycle required to fulfill it. A process begins once fulfillmenttools starts processing the order and continues through fulfillment, cancellation, and returns.

A process may include:

* Routing decisions
* Reservations
* Picking and packing
* Handover to carriers and consumers
* Rerouting
* Expiry handling
* Shipping
* Returns or operational cancellations

### Process flow

This graphic illustrates how order flows through the fulfillmenttools modules.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FVssk9agNiIHYeh9N9AEK%2FOrder%20flow.png?alt=media&amp;token=024b839f-ea14-494a-bc47-651a905c5e29" alt=""><figcaption></figcaption></figure>

### **Status model**

The process status model provides status information at multiple levels of granularity. This enables consumers to monitor a process from a high-level business perspective while still allowing detailed analysis of the underlying operational activities. This is the status model found in the [process API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/process).

The status hierarchy is structured as follows:

```
Process
 └─ Domains
     └─ Modules
         └─ Module entities
```

Each level aggregates the status information of the level below it.

Statuses are aggregated bottom-up through the hierarchy. Module statuses are derived from module entity statuses, domain statuses from module statuses, and the overall process status from domain statuses. Aggregation follows predefined precedence rules to ensure a single consistent status representation at each level.

* [**Process status**](#overall-process-status) provides an overall view of the entire process.
* [**Domain statuses**](#domain-statuses) provide a business-oriented view of specific process areas.
* **Module statuses** represent the status of individual functional modules.
* **Module entity statuses** represent the status of the concrete entity.

#### **Overall process status**

The process status represents the highest level of status aggregation within the process.

It provides a consolidated view across all domains and is intended as the primary indicator of the overall process state.

<table><thead><tr><th width="160.5">Process status</th><th width="605.5625">Description</th></tr></thead><tbody><tr><td><code>CREATED</code></td><td>The process has been created and is ready for further processing.</td></tr><tr><td><code>IN_PROGRESS</code></td><td>The process is actively being executed. This includes running routing operations, ongoing fulfillment tasks, or an initiated return.</td></tr><tr><td><code>FINISHED</code></td><td>All underlying modules and their entities have completed their lifecycles, and the process is fully resolved.</td></tr><tr><td><code>CANCELED</code></td><td>The process has been terminated because the associated order was canceled.</td></tr><tr><td><code>ERROR</code></td><td>The process can't progress because one or more underlying modules and entities are stuck or have failed, for example, due to unroutable items or an unsuccessful shipping‑label creation.</td></tr></tbody></table>

#### Domain statuses

Domain statuses group related modules into logical business areas.

They provide a business-centric view of the process and allow consumers to focus on specific aspects of process execution without analyzing individual modules.

The following domains are available:

<table><thead><tr><th width="201.4140625">Domain</th><th>Aggregated modules</th><th>Description</th></tr></thead><tbody><tr><td><code>domsStatuses</code></td><td><code>ORDER</code>, <code>ROUTING</code></td><td>Order orchestration and routing-related activities.</td></tr><tr><td><code>operativeStatuses</code></td><td><code>PICKING</code>, <code>PACKING</code>, <code>SHIPMENT</code>, <code>HANDOVER</code>, <code>SERVICE_JOB</code></td><td>Operational fulfillment activities.</td></tr><tr><td><code>inventoryStatuses</code></td><td><code>RESERVATION</code></td><td>Inventory-related activities.</td></tr><tr><td><code>returnStatuses</code></td><td><code>RETURN</code></td><td>Return processing activities.</td></tr></tbody></table>

Each domain status is represented by a `processStatusDetail` object:

```json
{
  "status": "IN_PROGRESS",
  "subStatuses": ["DELAYED"],
  "subStatusHistory": ["DELAYED"]
}
``
```

#### Substatus

The substatus provides additional operational context to the process status by highlighting specific conditions that may require attention or indicate a risk to the fulfillment process. While the process status represents the overall fulfillment phase, the substatus identifies exceptional situations detected during order execution.\
\
Substatuses can exist at different levels of the status hierarchy, including module entities, modules, domains, and the overall process. As status information is aggregated through the hierarchy, substatuses may also be aggregated or generalized to provide an appropriate level of detail for each level.\
\
Multiple substatuses can be associated with the same process status. They don't represent a separate lifecycle, but rather operational indicators that supplement the current process status with more detailed information.\
\
A substatus remains active as long as the underlying condition exists. Once the condition is resolved, the substatus is removed from the active `subStatuses` list and considered historical. Historical substatuses are retained in `subStatusHistory` to provide visibility into previously occurring conditions during the process lifecycle.

<table><thead><tr><th width="155.7109375">Substatus</th><th>Description</th></tr></thead><tbody><tr><td><code>MISMATCH</code></td><td><p>A discrepancy has been detected between the expected fulfillment outcome and the actual execution result.</p><p>This substatus is assigned when the fulfillment execution deviates from the originally expected outcome and may require review or follow-up actions.</p><p>Examples include:</p><ul><li>A short pick, where the picked quantity is lower than the requested quantity.</li><li>A zero pick, where no quantity could be picked although fulfillment was expected.</li><li>A split order scenario where fulfillment was planned across multiple facilities and one part of the order was subsequently canceled, resulting in a deviation from the original fulfillment plan.</li></ul></td></tr><tr><td><code>DELAYED</code></td><td><p>The process has missed its committed fulfillment timeline.</p><p>For example, a <code>DELAYED</code> substatus is generated when the current time exceeds the pick job's <code>pickingTimes.startLatestAt</code> value.</p></td></tr></tbody></table>

## Backoffice order view

For operational users, Backoffice provides a consolidated view of the order and all related process entities. It allows you to inspect routing decisions, monitor fulfillment progress, review operational tasks such as pick and pack jobs, and execute permitted actions. For more details on how orders and processes are represented operationally, see the [Backoffice order view article](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders).


# Orders

An order represents the consumer's intent as captured in the shop system. The order is the starting point for all subsequent [routing](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing) and [fulfillment](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations) activities.

This article focuses on creating and canceling orders that go through the process via the API. For full details about the order entity, see the [Order Management article](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management). To modify an order, see the [Order modification article](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-modification). To create an order record, see the [Order records article](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-records).

## Create an order

To create a new order in fulfillmenttools, call the following `POST` endpoint:

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/orders
```

{% hint style="warning" %}
Orders with the same `tenantOrderId` are only allowed if the previous orders don't have a status of open, locked, or promised. Cancel the previous orders first.
{% endhint %}

Below is an example of an order:

```json
{
  "consumer": {
    "addresses": [
      {
        "firstName": "Phil",
        "lastName": "Bison",
        "street": "Bison Drive",
        "houseNumber": "42",
        "postalCode": "42420",
        "city": "Los Angeles",
        "country": "US",
        "email": "phil.bison@fulfillmenttools.com"
      }
    ]
  },
  "tenantOrderId": "R456728546",
  "orderDate": "2024-01-19T08:45:50.525Z",
  "orderLineItems": [
    {
      "article": {
        "tenantArticleId": "TSHIRT-W-2468",
        "title": "Basic T-Shirt White"
      },
      "quantity": 1
    },
    {
      "article": {
        "tenantArticleId": "SNEAK-W-4891",
        "title": "White sneakers"
      },
      "quantity": 1
    }
  ],
  "deliveryPreferences": {
    "shipping": {
      "serviceLevel": "DELIVERY"
    }
  }
}
```

If the request was successful, it returns an HTTP `200 OK` response with a body that contains some new values:

`id`: Every order has a unique generated ID for identification.

`version`: Version as part of our optimistic locking mechanism.

`orderLineItems[].id`: Each order line item has its ID.

`status`: Every order has a status, newly posted orders always have the status `OPEN` if the status isn't defined in the request (for example, you could set the `"status": "LOCKED"` in the initial request).

`processId`: A process is an entity containing every entity involved in the whole fulfilling process.

`created`: Time at which the order was created in fulfillmenttools.

`lastModified`: Time the order was most recently modified.

## Cancel an order

You can't delete an order via the API, you can only cancel an order. To do this, you'll need to change the status of the order via API, or [cancel it via Backoffice](https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders#operational-actions).

To edit an order, see the [Order modification article](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-modification).

## Order sources

When a Customer Support Manager wants to see the source for each order (for example, their own online shop or third-party platforms like Amazon, Otto, and so on) to track the order process better and respond to customer inquiries more effectively, there's an option to define the `source` of the order.

Users have two options:

* `sourceRef`: Refers to the existing source in configurations.
* `tenantSourceId`: Refers to the tenant source, which is defined in the source configurations.

{% hint style="info" %}
See the [Orders API Reference](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/orders).
{% endhint %}

### Create a source

Administrators can define possible sources of an order via API.

{% tabs %}
{% tab title="Endpoint" %}

```http
GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/ordersources
```

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/ordersources
```

{% endtab %}

{% tab title="Request example" %}

```json
{
  "version": 1,
  "ordersources": [
    {
      "tenantSourceId" : "marketplace_Amazon", // optional but must be unique
      "nameLocalized": { 
          en_US: "Amazon_en", 
          de_DE: "Amazon_de" 
      }
    }
  ]
}
```

{% endtab %}
{% endtabs %}


# Orders endpoints

## The Order object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"deprecated":true,"description":"@deprecated this property has been deprecated and has no effect on the routing.","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticleForCreation"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticleForCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForCreation"},"title":"OrderLineItemArticleForCreation","description":"OrderLineItemArticleForCreation"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"OrderArticleAttributeItemForUpsert":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemForUpsert"}],"title":"OrderArticleAttributeItemForUpsert","description":"OrderArticleAttributeItemForUpsert"},"ArticleAttributeItemForUpsert":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItemForUpsert","type":"object","description":"ArticleAttributeItemForUpsert"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["article","id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","maximum":2147483647,"type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"}}}}
```

## Get order

> Get a specific order by ID.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, retrieve, update, and manage orders.","name":"Orders"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"deprecated":true,"description":"@deprecated this property has been deprecated and has no effect on the routing.","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticleForCreation"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticleForCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForCreation"},"title":"OrderLineItemArticleForCreation","description":"OrderLineItemArticleForCreation"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"OrderArticleAttributeItemForUpsert":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemForUpsert"}],"title":"OrderArticleAttributeItemForUpsert","description":"OrderArticleAttributeItemForUpsert"},"ArticleAttributeItemForUpsert":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItemForUpsert","type":"object","description":"ArticleAttributeItemForUpsert"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["article","id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","maximum":2147483647,"type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/orders/{orderId}":{"get":{"description":"Get a specific order by ID.","operationId":"getOrder","parameters":[{"description":"ID of order you want to get","in":"path","name":"orderId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"Order was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found"}},"summary":"Get order","tags":["Orders"]}}}}
```

## List orders

> List orders with optional filtering by tenant order ID or consumer ID.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, retrieve, update, and manage orders.","name":"Orders"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StrippedOrders":{"properties":{"orders":{"items":{"$ref":"#/components/schemas/StrippedOrder"},"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"StrippedOrders","description":"StrippedOrders"},"StrippedOrder":{"allOf":[{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"properties":{"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","minimum":1,"type":"integer"},"title":{"type":"string"}},"required":["quantity","title"],"type":"object"},"type":"array"},"processRef":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"type":"array"}},"required":["id","status","orderDate"],"type":"object"}],"title":"StrippedOrder","description":"StrippedOrder"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/orders":{"get":{"description":"List orders with optional filtering by tenant order ID or consumer ID.","operationId":"getAllOrders","parameters":[{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"filter orders by tenantOrderId","in":"query","name":"tenantOrderId","required":false,"schema":{"type":"string"}},{"description":"filter orders by consumerId","in":"query","name":"consumerId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrippedOrders"}}},"description":"Orders are found."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List orders","tags":["Orders"]}}}}
```

## Create order

> Create a new order.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, retrieve, update, and manage orders.","name":"Orders"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"deprecated":true,"description":"@deprecated this property has been deprecated and has no effect on the routing.","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticleForCreation"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticleForCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForCreation"},"title":"OrderLineItemArticleForCreation","description":"OrderLineItemArticleForCreation"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"OrderArticleAttributeItemForUpsert":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemForUpsert"}],"title":"OrderArticleAttributeItemForUpsert","description":"OrderArticleAttributeItemForUpsert"},"ArticleAttributeItemForUpsert":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItemForUpsert","type":"object","description":"ArticleAttributeItemForUpsert"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["article","id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","maximum":2147483647,"type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/orders":{"post":{"description":"Create a new order.","operationId":"addOrder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderForCreation"}}},"description":"Order object supplied by your shop instance.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"The order was successfully created. The Location header contains the URL of the order."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create order","tags":["Orders"]}}}}
```

## Update order

> Update an existing order.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, retrieve, update, and manage orders.","name":"Orders"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderForUpdate":{"additionalProperties":false,"properties":{"comment":{"description":"A comment for updating this order.","type":"string"},"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"maxItems":500,"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"title":"OrderForUpdate","description":"OrderForUpdate"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","maximum":2147483647,"type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"OrderArticleAttributeItemForUpsert":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemForUpsert"}],"title":"OrderArticleAttributeItemForUpsert","description":"OrderArticleAttributeItemForUpsert"},"ArticleAttributeItemForUpsert":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItemForUpsert","type":"object","description":"ArticleAttributeItemForUpsert"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"deprecated":true,"description":"@deprecated this property has been deprecated and has no effect on the routing.","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticleForCreation"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticleForCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForCreation"},"title":"OrderLineItemArticleForCreation","description":"OrderLineItemArticleForCreation"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["article","id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/orders/{orderId}":{"patch":{"description":"Update an existing order.","operationId":"updateOrder","parameters":[{"description":"ID of Order you want to patch","in":"path","name":"orderId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderForUpdate"}}},"description":"Request body for updating an order","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"Order was found & patch-set has been applied. The patched entity is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Entity not found, for more information please look at details."}},"summary":"Update order","tags":["Orders"]}}}}
```

## Create promise order

> Endpoint to create a promise order.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, retrieve, update, and manage orders.","name":"Orders"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PromiseRequest":{"additionalProperties":false,"properties":{"additionalInfo":{"$ref":"#/components/schemas/PromiseRequestAdditionalInfo"},"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":100,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":100,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"$ref":"#/components/schemas/OrderPricingForCreation"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":100,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":100,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"xml":{"name":"PromiseRequest"},"title":"PromiseRequest","description":"PromiseRequest"},"PromiseRequestAdditionalInfo":{"properties":{"includeListingCustomAttributes":{"default":false,"description":"If true, the listing custom attributes are included in the response. This is useful for debugging purposes.","type":"boolean"},"resourceInvestment":{"$ref":"#/components/schemas/ResourceInvestment"}},"type":"object","title":"PromiseRequestAdditionalInfo","description":"PromiseRequestAdditionalInfo"},"ResourceInvestment":{"description":"How much resources should be invested during the optimization?","properties":{"level":{"description":"[abstract values]: how many resources should we invest in optimization. With a higher level the results will be better, nevertheless we need to invest more time for the optimization.","exclusiveMinimum":true,"maximum":1,"minimum":0,"type":"number"}},"required":["level"],"type":"object","title":"ResourceInvestment"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"deprecated":true,"description":"@deprecated this property has been deprecated and has no effect on the routing.","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticleForCreation"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticleForCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForCreation"},"title":"OrderLineItemArticleForCreation","description":"OrderLineItemArticleForCreation"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"OrderArticleAttributeItemForUpsert":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemForUpsert"}],"title":"OrderArticleAttributeItemForUpsert","description":"OrderArticleAttributeItemForUpsert"},"ArticleAttributeItemForUpsert":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItemForUpsert","type":"object","description":"ArticleAttributeItemForUpsert"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"ResponseForDeliveryPromise":{"additionalProperties":false,"properties":{"backOrdered":{"$ref":"#/components/schemas/Backordered"},"collect":{"$ref":"#/components/schemas/DeliveryPromiseCollect"},"orderRef":{"type":"string"},"orderVersion":{"type":"number"},"pricing":{"$ref":"#/components/schemas/OrderPricing"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"shipToCustomer":{"items":{"$ref":"#/components/schemas/DeliveryPromiseShipment"},"type":"array"},"shipToStore":{"items":{"$ref":"#/components/schemas/DeliveryPromiseShipment"},"type":"array"},"sourcingOption":{"$ref":"#/components/schemas/SourcingOption"}},"required":["orderRef","orderVersion"],"type":"object","xml":{"name":"ResponseForDeliveryPromise"},"title":"ResponseForDeliveryPromise","description":"ResponseForDeliveryPromise"},"Backordered":{"properties":{"lineItems":{"items":{"$ref":"#/components/schemas/DeliveryPromiseLineItem"},"type":"array"}},"required":["lineItems"],"type":"object","title":"Backordered","description":"Backordered"},"DeliveryPromiseLineItem":{"properties":{"availabilityTimeframe":{"$ref":"#/components/schemas/AvailabilityTimeframe"},"available":{"type":"number"},"outOfStockBehaviour":{"$ref":"#/components/schemas/OutOfStockBehaviour"},"quantity":{"type":"number"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"type":"object","title":"DeliveryPromiseLineItem","description":"DeliveryPromiseLineItem"},"AvailabilityTimeframe":{"properties":{"start":{"format":"date-time","type":"string"}},"type":"object","title":"AvailabilityTimeframe","description":"AvailabilityTimeframe"},"OutOfStockBehaviour":{"description":"The PREORDER and RESTOCK can be only set, when the depending outOfStockConfig is provided.\nAlso PREORDER and RESTOCK values are in Alpha status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />","enum":["NONE","BACKORDER","PREORDER","RESTOCK","PREORDER_AND_RESTOCK"],"type":"string","title":"OutOfStockBehaviour"},"DeliveryPromiseCollect":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BasicDeliveryPromiseShipment"}],"properties":{"targetTime":{"format":"date-time","type":"string"}},"required":["targetTime"],"type":"object","xml":{"name":"DeliveryPromiseCollect"},"title":"DeliveryPromiseCollect","description":"DeliveryPromiseCollect"},"BasicDeliveryPromiseShipment":{"additionalProperties":false,"properties":{"facility":{"$ref":"#/components/schemas/BasicDeliveryPromiseShipmentFacility"},"lineItems":{"items":{"$ref":"#/components/schemas/DeliveryPromiseLineItem"},"type":"array"}},"required":["lineItems","facility"],"type":"object","xml":{"name":"DeliveryPromiseShipment"},"title":"BasicDeliveryPromiseShipment","description":"BasicDeliveryPromiseShipment"},"BasicDeliveryPromiseShipmentFacility":{"additionalProperties":false,"properties":{"facilityName":{"type":"string"},"facilityRef":{"type":"string"},"tenantFacilityId":{"type":"string"}},"required":["facilityName","facilityRef"],"title":"BasicDeliveryPromiseShipmentFacility","description":"BasicDeliveryPromiseShipmentFacility"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"DeliveryPromiseShipment":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BasicDeliveryPromiseShipment"}],"properties":{"carriers":{"items":{"$ref":"#/components/schemas/PromiseCarrier"},"type":"array"}},"required":["carriers"],"type":"object","xml":{"name":"DeliveryPromiseShipment"},"title":"DeliveryPromiseShipment","description":"DeliveryPromiseShipment"},"PromiseCarrier":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"},"carrierRef":{"type":"string"},"deliveryPromiseValidUntil":{"format":"date-time","type":"string"},"products":{"items":{"$ref":"#/components/schemas/PromiseDeliveryOptions"},"type":"array"}},"required":["carrierRef","carrierKey","carrierName","products"],"type":"object","xml":{"name":"PromiseCarrier"},"title":"PromiseCarrier","description":"PromiseCarrier"},"PromiseDeliveryOptions":{"additionalProperties":false,"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"deliveryCosts":{"items":{"$ref":"#/components/schemas/DeliveryCost"},"type":"array"},"estimatedDeliveryTime":{"$ref":"#/components/schemas/EstimatedDeliveryTime"},"transitTime":{"$ref":"#/components/schemas/CarrierTransitTime"}},"required":["carrierProductCategory","deliveryCosts"],"type":"object","xml":{"name":"PromiseDeliveryOptions"},"title":"PromiseDeliveryOptions","description":"PromiseDeliveryOptions"},"DeliveryCost":{"properties":{"cost":{"description":"The cost of sending with a carrier","type":"number"},"currency":{"description":"The currency of the price as an ISO 4217 code.","type":"string"}},"required":["cost","currency"],"title":"DeliveryCost","type":"object","description":"DeliveryCost"},"EstimatedDeliveryTime":{"properties":{"maxDeliveryDays":{"description":"Maximum total delivery time in days","minimum":0,"type":"integer"},"minDeliveryDays":{"description":"Minimum total delivery time in days","minimum":0,"type":"integer"}},"required":["maxDeliveryDays","minDeliveryDays"],"type":"object","title":"EstimatedDeliveryTime","description":"EstimatedDeliveryTime"},"CarrierTransitTime":{"properties":{"maxTransitDays":{"description":"Maximum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"},"minTransitDays":{"description":"Minimum days a carrier needs for transit","format":"int32","minimum":0,"type":"number"}},"required":["minTransitDays","maxTransitDays"],"title":"CarrierTransitTime","type":"object","description":"CarrierTransitTime"},"SourcingOption":{"properties":{"estimatedDeliveryDate":{"description":"Estimated delivery date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"estimatedPickupDate":{"description":"Estimated pickup date in format YYYY-MM-DD.","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"id":{"type":"string"},"listingDetails":{"items":{"$ref":"#/components/schemas/SourcingOptionListingDetails"},"type":"array"},"nodes":{"items":{"$ref":"#/components/schemas/SourcingOptionNode"},"type":"array"},"nonAssignedOrderLineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"priorityRatingResults":{"items":{"$ref":"#/components/schemas/PriorityRatingResult"},"type":"array"},"ratingResults":{"items":{"$ref":"#/components/schemas/RatingResult"},"type":"array"},"runId":{"type":"string"},"totalCosts":{"$ref":"#/components/schemas/SourcingOptionCosts"},"totalPenalty":{"description":"The total calculated penalty we calculated for this option","type":"number"},"transfers":{"items":{"$ref":"#/components/schemas/SourcingOptionTransfer"},"type":"array"},"validUntil":{"description":"The latest date at which this option is still valid, as an ISO8601 UTC timestamp string.","type":"string"}},"required":["id","runId","totalPenalty","nodes","transfers","ratingResults","priorityRatingResults"],"type":"object","title":"SourcingOption","description":"SourcingOption"},"SourcingOptionListingDetails":{"properties":{"customAttributes":{"additionalProperties":true,"type":"object"},"facilityRef":{"type":"string"},"tenantArticleId":{"type":"string"}},"title":"SourcingOptionListingDetails","description":"SourcingOptionListingDetails"},"SourcingOptionNode":{"properties":{"facilityRef":{"type":"string"},"id":{"description":"id of this node, unique for this Sourcing Option Responses","type":"string"},"isPickUpLocation":{"description":"Indicates if this node is a pick up location","type":"boolean"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"tenantFacilityId":{"type":"string"},"type":{"$ref":"#/components/schemas/NodeType"}},"required":["id","type","lineItems"],"type":"object","title":"SourcingOptionNode","description":"SourcingOptionNode"},"HandledItem":{"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleId":{"type":"string"}},"required":["tenantArticleId","quantity"],"type":"object","title":"HandledItem","description":"HandledItem"},"NodeType":{"enum":["SUPPLIER","MANAGED_FACILITY","CUSTOMER"],"type":"string","title":"NodeType","description":"NodeType"},"PriorityRatingResult":{"properties":{"id":{"type":"string"},"matchesPriorityMinimum":{"type":"boolean"},"name":{"type":"string"},"routingStrategyNodeId":{"type":"string"},"type":{"$ref":"#/components/schemas/RatingResultType"}},"required":["id","type","routingStrategyNodeId","matchesPriorityMinimum"],"title":"PriorityRatingResult","description":"PriorityRatingResult"},"RatingResultType":{"enum":["STANDARD","TOOLKIT"],"type":"string","xml":{"name":"RatingResultType"},"title":"RatingResultType","description":"RatingResultType"},"RatingResult":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"optionAggregation":{"$ref":"#/components/schemas/ToolkitRatingOptionAggregation"},"penalty":{"type":"number"},"routingStrategyNodeId":{"type":"string"},"type":{"description":"The type of the rating, e.g. 'StandardRating' or 'ToolkitRating'","type":"string"}},"required":["penalty","id","type","routingStrategyNodeId","name"],"title":"RatingResult","description":"RatingResult"},"ToolkitRatingOptionAggregation":{"description":"Defines how the penalties of the facilities within one sourcing option are aggregated into the option penalty. MIN: at least one facility must satisfy the rating, otherwise maxPenalty is applied once. MAX: all facilities must satisfy the rating, otherwise maxPenalty is applied once. SUM: every facility not satisfying the rating is charged maxPenalty individually.","enum":["MIN","MAX","SUM"],"type":"string","xml":{"name":"ToolkitRatingOptionAggregation"},"title":"ToolkitRatingOptionAggregation"},"SourcingOptionCosts":{"additionalProperties":false,"properties":{"salesPrices":{"description":"Sales prices and applied discounts of the individual items in the solution. Only present if costComponentRating is enabled.","items":{"$ref":"#/components/schemas/SourcingOptionSalesPrice"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money"},"totalSalesPriceAmount":{"$ref":"#/components/schemas/Money"},"totalShippingCosts":{"$ref":"#/components/schemas/ShippingCosts"}},"required":["salesPrices"],"type":"object","title":"SourcingOptionCosts","description":"SourcingOptionCosts"},"SourcingOptionSalesPrice":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the item in the solution","type":"number"},"discount":{"items":{"oneOf":[{"$ref":"#/components/schemas/FacilityDiscountRelative"},{"$ref":"#/components/schemas/FacilityDiscountAbsoluteForCreation"}]},"type":"array"},"salesPricePerUnitWithDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit with discount"},"salesPricePerUnitWithoutDiscountAmount":{"$ref":"#/components/schemas/Money","description":"The sales price per unit without discount"},"sourceFacilityRef":{"description":"The facility reference of the source facility","type":"string"},"sourceTenantFacilityId":{"description":"The tenant facility id of the source facility","type":"string"},"tenantArticleId":{"description":"The tenant article id of the item","type":"string"}},"required":["tenantArticleId","salesPricePerUnitWithoutDiscountAmount","amount","sourceFacilityRef"],"type":"object","title":"SourcingOptionSalesPrice","description":"SourcingOptionSalesPrice"},"FacilityDiscountRelative":{"additionalProperties":false,"properties":{"type":{"enum":["RELATIVE"],"type":"string"},"value":{"description":"Provided discount in percent.","minimum":0.1,"type":"number"}},"required":["type","value"],"type":"object","title":"FacilityDiscountRelative","description":"FacilityDiscountRelative"},"FacilityDiscountAbsoluteForCreation":{"additionalProperties":false,"properties":{"type":{"enum":["ABSOLUTE"],"type":"string"},"values":{"items":{"$ref":"#/components/schemas/FacilityDiscountAbsoluteElement"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object","title":"FacilityDiscountAbsoluteForCreation","description":"FacilityDiscountAbsoluteForCreation"},"FacilityDiscountAbsoluteElement":{"additionalProperties":false,"properties":{"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}],"description":"The currency of the price as an ISO 4217 code."},"decimalPlaces":{"description":"Number of decimal places for the given currency","minimum":0,"type":"integer"},"value":{"description":"Total value that should be shipped. Value is configured in the smallest subunit, e.g. cents.","minimum":1,"type":"integer"}},"required":["value","currency","decimalPlaces"],"type":"object","title":"FacilityDiscountAbsoluteElement","description":"FacilityDiscountAbsoluteElement"},"CurrencyCode":{"description":"The currency code is a three-letter code that represents a currency in the ISO 4217 standard.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string","title":"CurrencyCode"},"Money":{"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode"},"decimalPlaces":{"type":"number"},"value":{"type":"number"}},"required":["value","currency"],"type":"object","xml":{"name":"Money"},"title":"Money","description":"Money"},"ShippingCosts":{"additionalProperties":false,"properties":{"packageCosts":{"description":"Costs of the individual packaging units","items":{"$ref":"#/components/schemas/PackageCost"},"type":"array"},"totalTransportCostAmount":{"$ref":"#/components/schemas/Money","description":"The total transport cost amount"}},"required":["totalTransportCostAmount"],"type":"object","title":"ShippingCosts","description":"ShippingCosts"},"PackageCost":{"additionalProperties":false,"properties":{"costAmount":{"$ref":"#/components/schemas/Money","description":"The total package cost amount"},"packageName":{"description":"Name of the package","type":"string"}},"required":["packageName","costAmount"],"type":"object","title":"PackageCost","description":"PackageCost"},"SourcingOptionTransfer":{"properties":{"carrier":{"properties":{"carrierKey":{"type":"string"},"carrierName":{"type":"string"}},"type":"object"},"costDetails":{"description":"The cost components of this transfer that are not part of a packaging unit, such as transfer surcharges.","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"existenceReason":{"$ref":"#/components/schemas/SourcingOptionTransferExistenceReason"},"facilityConnectionRef":{"type":"string"},"fallbackCosts":{"$ref":"#/components/schemas/Money"},"id":{"description":"The id of the sourcing option transfer.","type":"string"},"lineItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"packagingInformation":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingInformation"},"type":"array"},"sourceNodeRef":{"type":"string"},"strandId":{"type":"string"},"targetNodeRef":{"type":"string"},"timeLine":{"$ref":"#/components/schemas/TransferTimeLine"},"totalCosts":{"$ref":"#/components/schemas/Money"},"transferGroup":{"description":"The transferGroup identifying transfers that travel together in the same delivery time window. Transfers with the same transferGroup are expected to be fulfilled within the same temporal delivery slot.","type":"string"}},"required":["sourceNodeRef","targetNodeRef","lineItems","packagingInformation"],"type":"object","title":"SourcingOptionTransfer","description":"SourcingOptionTransfer"},"BasePriceCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The price the tariff charges for the weight or volume tier the goods fell into.","properties":{"matchedThreshold":{"description":"The resolved weight or volume tier","format":"int64","type":"integer"},"type":{"enum":["BASE_PRICE"],"type":"string"}},"required":["id","type","amount"],"title":"BasePriceCostDetail"},"AbstractCostDetail":{"description":"One addend of a transport cost, so that a price can be reconciled against the tariff it was resolved from.","discriminator":{"propertyName":"type"},"properties":{"amount":{"$ref":"#/components/schemas/Money"},"id":{"description":"Position of this detail within its own costDetails list, referenced by appliedToCostDetailIds","type":"string"},"type":{"type":"string"}},"required":["id","type","amount"],"title":"AbstractCostDetail"},"OverflowCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"What the goods beyond the highest configured tier cost on top of the base price.","properties":{"type":{"enum":["OVERFLOW"],"type":"string"}},"required":["id","type","amount"],"title":"OverflowCostDetail"},"CostCoefficientCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"The configured rate charged per measurement unit, applied to the measured value.","properties":{"coefficient":{"description":"The configured rate","type":"number"},"measurementUnit":{"$ref":"#/components/schemas/CostMeasurementUnit"},"measurementValue":{"description":"The weight or volume the coefficient was multiplied by","type":"number"},"type":{"enum":["COST_COEFFICIENT"],"type":"string"}},"required":["id","type","amount","coefficient","measurementUnit","measurementValue"],"title":"CostCoefficientCostDetail"},"CostMeasurementUnit":{"enum":["GRAM","CUBIC_METER"],"type":"string","title":"CostMeasurementUnit","description":"CostMeasurementUnit"},"AbsoluteSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A fixed surcharge, charged as the tenant configured it.","properties":{"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["ABSOLUTE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType"],"title":"AbsoluteSurchargeCostDetail"},"RelativeSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge of the configured percentage of calculationBaseAmount.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["RELATIVE_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","percentage","calculationBaseAmount"],"title":"RelativeSurchargeCostDetail"},"ThresholdSurchargeCostDetail":{"allOf":[{"$ref":"#/components/schemas/AbstractCostDetail"}],"description":"A surcharge charged as the greater of minimumAmount and percentage of calculationBaseAmount, so amount is whichever of the two applied.","properties":{"appliedToCostDetailIds":{"description":"The same-level cost details that make up calculationBaseAmount. Empty when the base is not itself a cost detail.","items":{"type":"string"},"type":"array"},"calculationBaseAmount":{"$ref":"#/components/schemas/Money"},"minimumAmount":{"$ref":"#/components/schemas/Money"},"percentage":{"description":"The configured percentage","type":"number"},"tenantSurchargeType":{"description":"The tenant surcharge id","type":"string"},"type":{"enum":["THRESHOLD_SURCHARGE"],"type":"string"}},"required":["id","type","amount","tenantSurchargeType","minimumAmount","percentage","calculationBaseAmount"],"title":"ThresholdSurchargeCostDetail"},"SourcingOptionTransferExistenceReason":{"enum":["KEPT_FROM_LAST_RUN","REDUCED_ON_ORDER_SPLIT"],"type":"string","title":"SourcingOptionTransferExistenceReason","description":"SourcingOptionTransferExistenceReason"},"SourcingOptionsTransferPackagingInformation":{"properties":{"costDetails":{"description":"The cost components that add up to totalCosts","items":{"discriminator":{"mapping":{"ABSOLUTE_SURCHARGE":"#/components/schemas/AbsoluteSurchargeCostDetail","BASE_PRICE":"#/components/schemas/BasePriceCostDetail","COST_COEFFICIENT":"#/components/schemas/CostCoefficientCostDetail","OVERFLOW":"#/components/schemas/OverflowCostDetail","RELATIVE_SURCHARGE":"#/components/schemas/RelativeSurchargeCostDetail","THRESHOLD_SURCHARGE":"#/components/schemas/ThresholdSurchargeCostDetail"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/BasePriceCostDetail"},{"$ref":"#/components/schemas/OverflowCostDetail"},{"$ref":"#/components/schemas/CostCoefficientCostDetail"},{"$ref":"#/components/schemas/AbsoluteSurchargeCostDetail"},{"$ref":"#/components/schemas/RelativeSurchargeCostDetail"},{"$ref":"#/components/schemas/ThresholdSurchargeCostDetail"}]},"type":"array"},"packagingUnit":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnit"},"packedItems":{"items":{"$ref":"#/components/schemas/HandledItem"},"type":"array"},"totalCosts":{"$ref":"#/components/schemas/Money","description":"Total costs for this packaging information"}},"required":["packagingUnit","totalCosts","packedItems"],"type":"object","title":"SourcingOptionsTransferPackagingInformation","description":"SourcingOptionsTransferPackagingInformation"},"SourcingOptionsTransferPackagingUnit":{"properties":{"dimensions":{"$ref":"#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions"},"maxItemQuantity":{"description":"The maximum number of items that can be packed in this packaging unit","type":"integer"},"name":{"type":"string"},"packagingUnitRef":{"type":"string"},"prices":{"items":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliveryCost"},"type":"array"},"priority":{"description":"The priority of this packaging unit, lower values are preferred","type":"integer"},"tenantPackagingUnitId":{"type":"string"},"transitTime":{"$ref":"#/components/schemas/SourcingOptionsTransferTransitTime"},"volumeBufferInPercent":{"description":"The volume buffer in percent for this packaging unit","type":"number"}},"required":["name","priority"],"type":"object","title":"SourcingOptionsTransferPackagingUnit","description":"SourcingOptionsTransferPackagingUnit"},"SourcingOptionsTransferPackagingUnitDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"maxWeightInGram":{"type":"number"},"width":{"type":"number"}},"type":"object","title":"SourcingOptionsTransferPackagingUnitDimensions","description":"SourcingOptionsTransferPackagingUnitDimensions"},"SourcingOptionsTransferDeliveryCost":{"allOf":[{"$ref":"#/components/schemas/Money"}],"properties":{"deliveryCostCoefficient":{"$ref":"#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient"}},"type":"object","xml":{"name":"SourcingOptionsTransferDeliveryCost"},"title":"SourcingOptionsTransferDeliveryCost","description":"SourcingOptionsTransferDeliveryCost"},"SourcingOptionsTransferDeliverCostCoefficient":{"properties":{"measurementUnit":{"$ref":"#/components/schemas/CostCoefficientMeasurementUnit"},"value":{"type":"number"}},"required":["value","measurementUnit"],"type":"object","title":"SourcingOptionsTransferDeliverCostCoefficient","description":"SourcingOptionsTransferDeliverCostCoefficient"},"CostCoefficientMeasurementUnit":{"description":"The unit of measurement for the coefficient","enum":["GRAM"],"type":"string","title":"CostCoefficientMeasurementUnit"},"SourcingOptionsTransferTransitTime":{"properties":{"maxTransitDays":{"type":"number"},"minTransitDays":{"type":"number"}},"required":["minTransitDays","maxTransitDays"],"type":"object","title":"SourcingOptionsTransferTransitTime","description":"SourcingOptionsTransferTransitTime"},"TransferTimeLine":{"properties":{"calculationStartPoint":{"description":"The date and time from which all time-related calculations for the corresponding items are based.","format":"date-time","type":"string"},"earliestPickingStart":{"description":"The earliest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"earliestPossibleDeliveryTime":{"description":"The earliest date at which the corresponding items can be delivered to the recipient.","format":"date-time","type":"string"},"latestPickingStart":{"description":"The latest date and time when picking for the corresponding items can begin.","format":"date-time","type":"string"},"targetTime":{"description":"The desired date and time by which the corresponding items should be fulfilled.","format":"date-time","type":"string"},"usedTransitTimeInDays":{"description":"The raw amount of transit days used for timeline calculation","minimum":0,"type":"integer"}},"required":["calculationStartPoint","earliestPickingStart","latestPickingStart","targetTime"],"type":"object","xml":{"name":"TransferTimeLine"},"title":"TransferTimeLine","description":"TransferTimeLine"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/promises/deliverypromise":{"post":{"description":"Endpoint to create a promise order.","operationId":"postDeliveryPromise","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromiseRequest"}}},"description":"Order object supplied by your shop instance","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForDeliveryPromise"}}},"description":"The order promise was created URL of the order promise."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create promise order","tags":["Orders"]}}}}
```

## List orders (search)

> Search for Order

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, retrieve, update, and manage orders.","name":"Orders"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/OrderSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/OrderSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"OrderSearchPayload","type":"object","description":"OrderSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"OrderSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/OrderSearchQuery"},"maxItems":500,"type":"array"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerFilter"}],"description":"Nested search by consumer"},"customAttributes":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/BooleanFilter"},{"$ref":"#/components/schemas/StringEqFilter"},{"$ref":"#/components/schemas/NumberEqFilter"},{"$ref":"#/components/schemas/DateFilter"}]},"description":"Search by custom attributes","type":"object"},"deliveryPreferences":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesFilter"}],"description":"Nested search by deliveryPreferences"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/OrderSearchQuery"},"maxItems":500,"type":"array"},"orderDate":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search entries by orderDate. Applying a narrow and well-considered filter value is strongly recommended, as it can greatly improve response times, especially when working with large datasets."},"orderLineItems":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsListFilter"}],"description":"Nested list search by orderLineItems"},"paymentInfo":{"allOf":[{"$ref":"#/components/schemas/OrderPaymentInfoFilter"}],"description":"Nested search by paymentInfo"},"status":{"allOf":[{"$ref":"#/components/schemas/OrderStatusEnumFilter"}],"description":"Search by status"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantOrderId"},"tags":{"allOf":[{"$ref":"#/components/schemas/OrderTagsListFilter"}],"description":"Nested list search by tags"}},"title":"OrderSearchQuery","type":"object","description":"OrderSearchQuery"},"OrderConsumerFilter":{"properties":{"addresses":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesListFilter"}],"description":"Nested list search by addresses"},"consumerId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by consumerId"}},"title":"OrderConsumerFilter","type":"object","description":"OrderConsumerFilter"},"OrderConsumerAddressesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderConsumerAddressesListFilter","type":"object","description":"OrderConsumerAddressesListFilter"},"OrderConsumerAddressesFilter":{"properties":{"addressType":{"allOf":[{"$ref":"#/components/schemas/OrderConsumerAddressesAddressTypeEnumFilter"}],"description":"Search by addressType"},"city":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by city"},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by companyName"},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by country"},"email":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by email"},"firstName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by firstName"},"houseNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by houseNumber"},"lastName":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by lastName"},"postalCode":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by postalCode"},"province":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by province"},"street":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by street"}},"title":"OrderConsumerAddressesFilter","type":"object","description":"OrderConsumerAddressesFilter"},"OrderConsumerAddressesAddressTypeEnumFilter":{"properties":{"eq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"in":{"description":"Search by addressType","items":{"enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by addressType","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string"}},"title":"OrderConsumerAddressesAddressTypeEnumFilter","type":"object","description":"OrderConsumerAddressesAddressTypeEnumFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"BooleanFilter":{"properties":{"eq":{"type":"boolean"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"boolean"}},"title":"BooleanFilter","type":"object","description":"BooleanFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"NumberEqFilter":{"properties":{"eq":{"type":"number"},"gt":{"type":"number"},"gte":{"type":"number"},"lt":{"type":"number"},"lte":{"type":"number"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","type":"number"}},"title":"NumberEqFilter","type":"object","description":"NumberEqFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"OrderDeliveryPreferencesFilter":{"properties":{"collect":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesCollectListFilter"}],"description":"Nested list search by collect"},"shipping":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesShippingFilter"}],"description":"Nested search by shipping"}},"title":"OrderDeliveryPreferencesFilter","type":"object","description":"OrderDeliveryPreferencesFilter"},"OrderDeliveryPreferencesCollectListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesCollectFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderDeliveryPreferencesCollectListFilter","type":"object","description":"OrderDeliveryPreferencesCollectListFilter"},"OrderDeliveryPreferencesCollectFilter":{"properties":{"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"paid":{"allOf":[{"$ref":"#/components/schemas/BooleanFilter"}],"description":"Search by paid"}},"title":"OrderDeliveryPreferencesCollectFilter","type":"object","description":"OrderDeliveryPreferencesCollectFilter"},"OrderDeliveryPreferencesShippingFilter":{"properties":{"desiredDeliveryTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by desiredDeliveryTime"},"serviceLevel":{"allOf":[{"$ref":"#/components/schemas/OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"}],"description":"Search by serviceLevel"}},"title":"OrderDeliveryPreferencesShippingFilter","type":"object","description":"OrderDeliveryPreferencesShippingFilter"},"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter":{"properties":{"eq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"},"in":{"description":"Search by serviceLevel","items":{"enum":["DELIVERY","SAMEDAY"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by serviceLevel","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"title":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter","type":"object","description":"OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter"},"OrderOrderLineItemsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderOrderLineItemsListFilter","type":"object","description":"OrderOrderLineItemsListFilter"},"OrderOrderLineItemsFilter":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleFilter"}],"description":"Nested search by article"}},"title":"OrderOrderLineItemsFilter","type":"object","description":"OrderOrderLineItemsFilter"},"OrderOrderLineItemsArticleFilter":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/OrderOrderLineItemsArticleTitleLocalizedFilter"}],"description":"Nested search by titleLocalized"},"tenantArticleId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantArticleId"},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by title"}},"title":"OrderOrderLineItemsArticleFilter","type":"object","description":"OrderOrderLineItemsArticleFilter"},"OrderOrderLineItemsArticleTitleLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderOrderLineItemsArticleTitleLocalizedFilter","type":"object","description":"OrderOrderLineItemsArticleTitleLocalizedFilter"},"OrderPaymentInfoFilter":{"properties":{"methodLocalized":{"allOf":[{"$ref":"#/components/schemas/OrderPaymentInfoMethodLocalizedFilter"}],"description":"Nested search by methodLocalized"},"currency":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by currency"},"method":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by method"}},"title":"OrderPaymentInfoFilter","type":"object","description":"OrderPaymentInfoFilter"},"OrderPaymentInfoMethodLocalizedFilter":{"properties":{"de_DE":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by de_DE"},"en_US":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by en_US"},"ru_RU":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by ru_RU"}},"title":"OrderPaymentInfoMethodLocalizedFilter","type":"object","description":"OrderPaymentInfoMethodLocalizedFilter"},"OrderStatusEnumFilter":{"properties":{"eq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"in":{"description":"Search by status","items":{"enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by status","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string"}},"title":"OrderStatusEnumFilter","type":"object","description":"OrderStatusEnumFilter"},"OrderTagsListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/OrderTagsFilter"}],"description":"Contains returns if at least one entry matches"},"exists":{"description":"exists:false matches empty or absent lists; exists:true matches non-empty lists","type":"boolean"}},"title":"OrderTagsListFilter","type":"object","description":"OrderTagsListFilter"},"OrderTagsFilter":{"properties":{"value":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by value"}},"title":"OrderTagsFilter","type":"object","description":"OrderTagsFilter"},"OrderSort":{"properties":{"orderDate":{"enum":["ASC","DESC"],"type":"string"},"status":{"enum":["ASC","DESC"],"type":"string"}},"title":"OrderSort","type":"object","description":"OrderSort"},"OrderPaginatedResult":{"properties":{"orders":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","orders"],"title":"OrderPaginatedResult","type":"object","description":"OrderPaginatedResult"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"deprecated":true,"description":"@deprecated this property has been deprecated and has no effect on the routing.","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticleForCreation"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticleForCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForCreation"},"title":"OrderLineItemArticleForCreation","description":"OrderLineItemArticleForCreation"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"OrderArticleAttributeItemForUpsert":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemForUpsert"}],"title":"OrderArticleAttributeItemForUpsert","description":"OrderArticleAttributeItemForUpsert"},"ArticleAttributeItemForUpsert":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItemForUpsert","type":"object","description":"ArticleAttributeItemForUpsert"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["article","id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","maximum":2147483647,"type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/orders/search":{"post":{"deprecated":false,"description":"Search for Order","operationId":"searchOrder","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List orders (search)","tags":["Orders"]}}}}
```

## POST /api/orders/{orderId}/actions

> Call order action

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, retrieve, update, and manage orders.","name":"Orders"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderActionsParameter":{"oneOf":[{"$ref":"#/components/schemas/OrderUnlockActionParameter"},{"$ref":"#/components/schemas/OrderInvalidationActionParameter"},{"$ref":"#/components/schemas/OrderCancelActionParameter"},{"$ref":"#/components/schemas/OrderForceCancelActionParameter"},{"$ref":"#/components/schemas/PromiseConfirmActionParameter"},{"$ref":"#/components/schemas/PromiseExtendActionParameter"},{"$ref":"#/components/schemas/OrderConsumerAddressChangeActionParameter"},{"$ref":"#/components/schemas/OrderConsumerAddressesReplaceActionParameter"}],"title":"OrderActionsParameter","description":"OrderActionsParameter"},"OrderUnlockActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to unlock an order.","properties":{"name":{"enum":["UNLOCK"],"type":"string"},"targetTime":{"description":"Time to be set as a targetTime for the devlivery preferences.","format":"date-time","type":"string"}},"required":["name","version"],"title":"OrderUnlockActionParameter"},"AbstractOrderActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderActionsParameter","description":"AbstractOrderActionsParameter"},"OrderInvalidationActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to Invalidate an order.","properties":{"name":{"enum":["INVALIDATE_PROMISE"],"type":"string"}},"required":["name","version"],"title":"OrderInvalidationActionParameter"},"OrderCancelActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to cancel an order.","properties":{"cancelationReasonId":{"description":"ID of the cancelation reason","type":"string"},"name":{"enum":["CANCEL"],"type":"string"}},"required":["name","version"],"title":"OrderCancelActionParameter"},"OrderForceCancelActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to force cancel an order.","properties":{"name":{"enum":["FORCE_CANCEL"],"type":"string"}},"required":["name","version"],"title":"OrderForceCancelActionParameter"},"PromiseConfirmActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to confirm a promise.","properties":{"name":{"enum":["CONFIRM_PROMISE"],"type":"string"},"tenantOrderId":{"description":"The tenantOrderId to be used for the resulting order","type":"string"}},"required":["name","version"],"title":"PromiseConfirmActionParameter"},"PromiseExtendActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"description":"Action to extend a promise.","properties":{"name":{"enum":["EXTEND_PROMISE"],"type":"string"}},"required":["name","version"],"title":"PromiseExtendActionParameter"},"OrderConsumerAddressChangeActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"deprecated":true,"description":"@deprecated use PATCH /api/orders/:id instead 'Action to change a consumer address of an order, e.g. the postal address.'","properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"consumerAddress":{"$ref":"#/components/schemas/ConsumerAddress"},"name":{"enum":["CHANGE_CONSUMER_ADDRESS"],"type":"string"}},"required":["name","version","consumerAddress","addressType"],"title":"OrderConsumerAddressChangeActionParameter"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"OrderConsumerAddressesReplaceActionParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderActionsParameter"}],"deprecated":true,"description":"@deprecated use PATCH /api/orders/:id instead 'Action to replace all consumer addresses of an order.'","properties":{"consumerAddresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"name":{"enum":["REPLACE_CONSUMER_ADDRESSES"],"type":"string"}},"required":["name","version","consumerAddresses"],"title":"OrderConsumerAddressesReplaceActionParameter"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"deprecated":true,"description":"@deprecated this property has been deprecated and has no effect on the routing.","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticleForCreation"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticleForCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForCreation"},"title":"OrderLineItemArticleForCreation","description":"OrderLineItemArticleForCreation"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"OrderArticleAttributeItemForUpsert":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemForUpsert"}],"title":"OrderArticleAttributeItemForUpsert","description":"OrderArticleAttributeItemForUpsert"},"ArticleAttributeItemForUpsert":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItemForUpsert","type":"object","description":"ArticleAttributeItemForUpsert"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["article","id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","maximum":2147483647,"type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/orders/{orderId}/actions":{"post":{"operationId":"orderAction","parameters":[{"description":"Reference to the order you want to call the action for","in":"path","name":"orderId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderActionsParameter"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"Updated Order in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Order not found or expired"}},"summary":"Call order action","tags":["Orders"]}}}}
```

## POST /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions

> Call order line item action

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, retrieve, update, and manage orders.","name":"Orders"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderLineItemActionsParameter":{"oneOf":[{"$ref":"#/components/schemas/OrderLineItemCustomAttributesUpdateParameter"}],"type":"object","title":"OrderLineItemActionsParameter","description":"OrderLineItemActionsParameter"},"OrderLineItemCustomAttributesUpdateParameter":{"allOf":[{"$ref":"#/components/schemas/AbstractOrderLineItemActionsParameter"}],"description":"Action to update custom attributes of an order.","properties":{"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here. If no customAttributes exist yet, they will be created for this line item.","type":"object"},"name":{"enum":["UPDATE_CUSTOM_ATTRIBUTES"],"type":"string"}},"required":["name","version","customAttributes"],"title":"OrderLineItemCustomAttributesUpdateParameter"},"AbstractOrderLineItemActionsParameter":{"discriminator":{"propertyName":"name"},"properties":{"name":{"type":"string"},"version":{"description":"Version of the order to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"AbstractOrderLineItemActionsParameter","description":"AbstractOrderLineItemActionsParameter"},"Order":{"allOf":[{"$ref":"#/components/schemas/OrderForCreation"},{"$ref":"#/components/schemas/VersionedResource"},{"properties":{"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"cancelationReason":{"$ref":"#/components/schemas/CancelationReason"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReference"},"minItems":1,"type":"array"},"id":{"description":"The id of this order. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfo"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricing"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"processId":{"description":"Id of the global process related to this entity. For example used for starting the GDPR process and others.","type":"string"},"schemaVersion":{"type":"number"},"status":{"$ref":"#/components/schemas/OrderStatus"},"updateDetails":{"items":{"$ref":"#/components/schemas/OrderUpdateDetail"},"minItems":1,"type":"array"},"workflowInformation":{"oneOf":[{"$ref":"#/components/schemas/WorkflowInformation"},{"$ref":"#/components/schemas/WorkflowUnavailable"}]}},"required":["id","status","orderLineItems","processId","workflowInformation"],"type":"object"}],"xml":{"name":"Order"},"title":"Order","description":"Order"},"OrderForCreation":{"additionalProperties":false,"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServices":{"items":{"$ref":"#/components/schemas/CustomServiceReferenceForCreation"},"maxItems":500,"minItems":1,"type":"array"},"deliveryPreferences":{"$ref":"#/components/schemas/DeliveryPreferences"},"orderDate":{"description":"The date this order was created at the supplying system.","format":"date-time","type":"string"},"orderLineItems":{"items":{"$ref":"#/components/schemas/OrderLineItemForCreation"},"maxItems":500,"type":"array"},"paymentInfo":{"$ref":"#/components/schemas/OrderPaymentInfoForCreation"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />"},"promisesOptions":{"$ref":"#/components/schemas/OrderPromisesOptions"},"source":{"description":"Defines the source of this order. This field is not required, if the order is created based on an external system.","oneOf":[{"$ref":"#/components/schemas/SourceRef"},{"$ref":"#/components/schemas/TenantSourceId"}],"type":"object"},"status":{"$ref":"#/components/schemas/OrderStatus"},"statusReasons":{"items":{"$ref":"#/components/schemas/OrderStatusReason"},"maxItems":500,"type":"array"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":100,"minItems":1,"type":"array"},"tenantOrderId":{"description":"Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.","type":"string"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"minItems":1,"type":"array"}},"required":["orderDate","orderLineItems","consumer"],"type":"object","xml":{"name":"Order"},"title":"OrderForCreation","description":"OrderForCreation"},"OrderForCreationConsumer":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/ConsumerAddress"},"maxItems":500,"type":"array"},"consumerId":{"description":"The id of the consumer.","type":"string"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"email":{"deprecated":true,"description":"@deprecated The email address of the consumer. Use email in addresses array\n","format":"email","type":"string"},"facilityRef":{"description":"ID of the facility, if the recipient is a facility.","type":"string"},"tenantFacilityId":{"description":"tenantFacilityId of the facility, if the recipient is a facility","type":"string"}},"type":"object","title":"OrderForCreationConsumer","description":"OrderForCreationConsumer"},"ConsumerAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"companyName":{"type":"string"},"coordinates":{"$ref":"#/components/schemas/Coordinates"},"email":{"format":"email","minLength":1,"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"salutation":{"type":"string"}},"type":"object","title":"ConsumerAddress","description":"ConsumerAddress"},"Address":{"properties":{"additionalAddressInfo":{"type":"string"},"city":{"pattern":"^.+$","type":"string"},"country":{"description":"A two-digit country code as per ISO 3166-1 alpha-2","pattern":"^[A-Z]{2}$","type":"string"},"customAttributes":{"description":"Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"houseNumber":{"pattern":"^.+$","type":"string"},"phoneNumbers":{"items":{"properties":{"customAttributes":{"description":"Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"label":{"description":"Can be used to give a description for the number, like \"private\", \"business number\", etc.","type":"string"},"type":{"enum":["MOBILE","PHONE"],"type":"string"},"value":{"description":"The number itself. We do not enforce any format (yet).","type":"string"}},"required":["value","type"],"type":"object"},"maxItems":500,"type":"array"},"postalCode":{"pattern":"^.+$","type":"string"},"province":{"pattern":"^.+$","type":"string"},"street":{"pattern":"^.+$","type":"string"}},"required":["street","city","postalCode","country"],"type":"object","title":"Address","description":"Address"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"Coordinates":{"description":"Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API","properties":{"lat":{"description":"Latitude value","type":"number"},"lon":{"description":"Longitude value","type":"number"}},"required":["lat","lon"],"type":"object","title":"Coordinates"},"CustomServiceReferenceForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceDefinition","articleItems","customServiceItems"],"type":"object","title":"CustomServiceReferenceForCreation","description":"CustomServiceReferenceForCreation"},"ArticleItem":{"additionalProperties":false,"properties":{"quantity":{"minimum":1,"type":"number"},"tenantArticleRef":{"type":"string"}},"required":["quantity","tenantArticleRef"],"type":"object","title":"ArticleItem","description":"ArticleItem"},"CustomServiceDefinition":{"properties":{"additionalInformation":{"description":"Additional information necessary to fulfil the custom service","items":{"properties":{"additionalInformationRef":{"description":"A reference to the specific additional information of the custom service","type":"string"},"tenantAdditionalInformationId":{"description":"The id of the tenant specific additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}],"description":"The value of the additional information"}},"required":["additionalInformationRef"],"type":"object"},"maxItems":500,"type":"array"},"customAttributes":{"description":"Attributes that can be added to the consumer. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"customServiceRef":{"description":"A reference to the custom service to be applied to the orderline items","type":"string"},"isBundled":{"description":"if true all articles below this service are intrpreted as a bundle","type":"boolean"},"tenantCustomServiceId":{"description":"The id of the tenant specific custom service","type":"string"}},"type":"object","title":"CustomServiceDefinition","description":"CustomServiceDefinition"},"CustomServiceItemForCreation":{"additionalProperties":false,"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"maxItems":500,"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItemForCreation"},"maxItems":500,"type":"array"}},"required":["customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItemForCreation","description":"CustomServiceItemForCreation"},"DeliveryPreferences":{"additionalProperties":false,"properties":{"collect":{"items":{"$ref":"#/components/schemas/CollectDelivery"},"maxItems":1,"type":"array"},"estimatedDeliveryDate":{"description":"Estimated delivery or pickup commitment.","format":"date-time","type":"string"},"reservationPreferences":{"$ref":"#/components/schemas/DeliveryReservationPreferences"},"shipping":{"$ref":"#/components/schemas/DeliveryPreferencesShipping"},"sourcingOptionRefs":{"deprecated":true,"description":"@deprecated this property has been deprecated and has no effect on the routing.","items":{"description":"Reference of a SourcingOptions","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilities":{"description":"@deprecated Use supplyingFacilities under collect","items":{"description":"Reference of a Facility","type":"string"},"maxItems":500,"type":"array"},"targetTime":{"description":"At which time the result is expected.","format":"date-time","type":"string"}},"type":"object","title":"DeliveryPreferences","description":"DeliveryPreferences"},"CollectDelivery":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility where the consumer expects to collect the items","type":"string"},"paid":{"default":false,"description":"Indicates if the order is already paid.","type":"boolean"},"provisioningTime":{"description":"The point in time by which the order is supposed to be provisioned.","format":"date-time","type":"string"},"supplyingFacilities":{"deprecated":true,"description":"@deprecated Use supplyingFacilitiesConfigurations","items":{"description":"Reference of a Facility.","type":"string"},"maxItems":500,"type":"array"},"supplyingFacilitiesConfigurations":{"description":"References of facility that could supply contents of the order to another facility with specific configuration of its usage","items":{"$ref":"#/components/schemas/SupplyingFacilityConfiguration"},"maxItems":500,"type":"array"},"tenantFacilityId":{"description":"Reference to the facility where the consumer expects to collect the items.","type":"string"}},"type":"object","title":"CollectDelivery","description":"CollectDelivery"},"SupplyingFacilityConfiguration":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"deliveryEvents":{"items":{"$ref":"#/components/schemas/DeliveryEvent"},"maxItems":500,"type":"array"},"facilityRef":{"description":"ID of the facility.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility.","type":"string"}},"required":["deliveryEvents"],"title":"SupplyingFacilityConfiguration","description":"SupplyingFacilityConfiguration"},"DeliveryEvent":{"properties":{"deliveryTarget":{"$ref":"#/components/schemas/DeliveryTarget"},"deliveryTrigger":{"enum":["DEFAULT"],"type":"string"}},"required":["deliveryTarget","deliveryTrigger"],"title":"DeliveryEvent","description":"DeliveryEvent"},"DeliveryTarget":{"description":"The destination for a delivery","enum":["SHIP_TO_STORE","SHIP_TO_CUSTOMER"],"type":"string","title":"DeliveryTarget"},"DeliveryReservationPreferences":{"properties":{"mode":{"$ref":"#/components/schemas/DeliveryReservationMode"},"reservationTime":{"format":"date-time","type":"string"}},"required":["mode"],"type":"object","title":"DeliveryReservationPreferences","description":"DeliveryReservationPreferences"},"DeliveryReservationMode":{"enum":["SCHEDULED","ASAP","ALAP"],"title":"DeliveryReservationMode","description":"DeliveryReservationMode"},"DeliveryPreferencesShipping":{"properties":{"carrierProductCategory":{"$ref":"#/components/schemas/CarrierProductCategory"},"desiredDeliveryTime":{"format":"date-time","type":"string"},"preferredCarriers":{"items":{"$ref":"#/components/schemas/PreferredCarrier"},"maxItems":500,"type":"array"},"preferredCarriersWithProduct":{"items":{"$ref":"#/components/schemas/PreferredCarrierWithProduct"},"maxItems":500,"type":"array"},"preselectedFacilities":{"items":{"$ref":"#/components/schemas/PreselectedFacility"},"maxItems":500,"type":"array"},"serviceLevel":{"description":"DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. SAMEDAY: The parcel will reach the recipient the same day when ordering.","enum":["DELIVERY","SAMEDAY"],"type":"string"}},"type":"object","title":"DeliveryPreferencesShipping","description":"DeliveryPreferencesShipping"},"CarrierProductCategory":{"enum":["STANDARD","EXPRESS","VALUE","FORWARDING"],"type":"string","title":"CarrierProductCategory","description":"CarrierProductCategory"},"PreferredCarrier":{"description":"Keys of the preferred carriers to handle out the order","type":"string","title":"PreferredCarrier"},"PreferredCarrierWithProduct":{"additionalProperties":false,"properties":{"carrierKey":{"type":"string"},"carrierProduct":{"type":"string"},"carrierServices":{"items":{"$ref":"#/components/schemas/CarrierServices"},"maxItems":500,"type":"array"}},"required":["carrierKey"],"type":"object","title":"PreferredCarrierWithProduct","description":"PreferredCarrierWithProduct"},"CarrierServices":{"enum":["SIGNATURE","CUSTOMER_SIGNATURE","ADULT_SIGNATURE","SATURDAY_DELIVERY","IDENTITY_CHECK_COMPANY","IDENTITY_CHECK_PRIVATE","ADDITIONAL_TRANSPORTATION_INSURANCE","IDENTITY_AGE_CHECK_18","NO_NEIGHBOR_DELIVERY","HANDOVER_TO_RECIPIENT_ONLY"],"type":"string","title":"CarrierServices","description":"CarrierServices"},"PreselectedFacility":{"anyOf":[{"required":["facilityRef"]},{"required":["tenantFacilityId"]}],"properties":{"facilityRef":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"},"tenantFacilityId":{"description":"Reference to the facility which is supposed to fulfill the order.","type":"string"}},"type":"object","title":"PreselectedFacility","description":"PreselectedFacility"},"OrderLineItemForCreation":{"additionalProperties":false,"properties":{"allowedSubstitutes":{"description":"Array of allowed substitutes for given orderLineItem. If an empty array is provided, no substitute is allowed for this orderLineItem. If allowedSubstitutes is not provided, this configured substitutes on listing level will be available","items":{"$ref":"#/components/schemas/Substitute"},"maxItems":500,"type":"array"},"article":{"$ref":"#/components/schemas/OrderLineItemArticleForCreation"},"customAttributes":{"description":"Attributes that can be added to the orderline. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","type":"object"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"quantity":{"description":"quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"scannableCodes":{"items":{"description":"Codes, that identify the article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Secondary identifier for items unit of measurement.","type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the specific article that has been ordered","format":"int64","maximum":2147483647,"minimum":0,"type":"integer"},"shopPrice":{"description":"@deprecated price per piece of this line item Use attributes instead (see: <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">customization by attributes</a>)\n","type":"number"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":500,"type":"array"}},"required":["article","quantity"],"type":"object","title":"OrderLineItemForCreation","description":"OrderLineItemForCreation"},"Substitute":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/SubstituteAttributeItem"},"maxItems":40,"type":"array"},"imageUrl":{"type":"string"},"measurementUnitKey":{"description":"Identifier for items unit of measurement.","type":"string"},"measurementValidation":{"$ref":"#/components/schemas/MeasurementValidation"},"priority":{"description":"This field allows you to rank substitutes against each other. The lowest number is the most preferrable substitute.","minimum":0,"type":"number"},"scannableCodes":{"items":{"description":"Strings, that identify the substitute article","type":"string"},"maxItems":500,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","type":"string"},"tenantArticleId":{"type":"string"},"title":{"type":"string"}},"required":["title","tenantArticleId"],"type":"object","xml":{"name":"Substitute"},"title":"Substitute","description":"Substitute"},"SubstituteAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"SubstituteAttributeItem","description":"SubstituteAttributeItem"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"MeasurementValidation":{"properties":{"overPickHardTolerancePercentage":{"description":"Allowed hard over pick deviation tolerance.","minimum":0,"type":"number"},"overPickSoftTolerancePercentage":{"description":"Allowed soft over pick deviation tolerance.","minimum":0,"type":"number"},"shortPickHardTolerancePercentage":{"description":"Allowed hard short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"},"shortPickSoftTolerancePercentage":{"description":"Allowed soft short pick deviation tolerance.","maximum":100,"minimum":0,"type":"number"}},"title":"MeasurementValidation","description":"MeasurementValidation"},"OrderLineItemArticleForCreation":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForCreation"},"title":"OrderLineItemArticleForCreation","description":"OrderLineItemArticleForCreation"},"AbstractArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"AbstractArticle","type":"object","description":"AbstractArticle"},"OrderArticleAttributeItemForUpsert":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemForUpsert"}],"title":"OrderArticleAttributeItemForUpsert","description":"OrderArticleAttributeItemForUpsert"},"ArticleAttributeItemForUpsert":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by fulfillmenttools to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout fulfillmenttools. For a complete list of possible categories\nand their correct use, refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"anyOf":[{"type":"string"},{"enum":["billableWeightPerUnit","weightPerUnit","currency","valuePerUnit","hsCode","numberOfDecimalPlaces","decimalPlaces","value","countryOfManufacture","percentage","valueOfMeasureForBasePrice","unitKeyOfMeasureForBasePrice"]}],"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear, for example, in the App.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, for example, priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of fulfillmenttools. Default\nvalue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItemForUpsert","type":"object","description":"ArticleAttributeItemForUpsert"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"OrderPaymentInfoForCreation":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"}},"type":"object","title":"OrderPaymentInfoForCreation","description":"OrderPaymentInfoForCreation"},"OrderPricingForCreation":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Customer-provided order-level pricing inputs. All arrays are optional — if a pricing feature block is missing, OMS treats the feature as not relevant. On update, pricing uses partial-merge semantics: only the provided arrays are replaced, omitted arrays retain their previous values.\n","properties":{"discounts":{"items":{"$ref":"#/components/schemas/OrderPricingDiscount"},"maxItems":100,"type":"array"},"fees":{"items":{"$ref":"#/components/schemas/OrderPricingFee"},"maxItems":100,"type":"array"},"taxes":{"items":{"$ref":"#/components/schemas/OrderPricingTax"},"maxItems":100,"type":"array"}},"type":"object","title":"OrderPricingForCreation"},"OrderPricingDiscount":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0 to 100). Required when type is PERCENTAGE. Must be positive or zero (e.g. 10 for 10% off).","format":"float","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Type of the discount. ABSOLUTE requires value, PERCENTAGE requires percentage.","enum":["ABSOLUTE","PERCENTAGE"],"type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingDiscount","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingDiscount"},"MonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places. If omitted, the default for the currency applies.","format":"int64","type":"integer"},"value":{"description":"Monetary value as integer (no decimals)","format":"int64","type":"integer"}},"required":["value","currency"],"title":"MonetaryValue","type":"object","description":"MonetaryValue"},"OrderPricingFee":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the fee","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"type":"object","title":"OrderPricingFee","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingFee"},"OrderPricingTax":{"properties":{"ratePercent":{"description":"Tax rate as percentage","type":"number"},"scope":{"description":"Scope of the tax","type":"string"},"taxableValue":{"$ref":"#/components/schemas/MonetaryValue"},"type":{"description":"Tax type identifier","type":"string"},"value":{"$ref":"#/components/schemas/MonetaryValue"}},"required":["value"],"type":"object","title":"OrderPricingTax","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTax"},"OrderPromisesOptions":{"additionalProperties":false,"properties":{"validUntil":{"description":"The date and time at which the promised order expires and is automatically cancelled if not converted into an actual order. Must be between 1 minute and 8 hours from now.","format":"date-time","type":"string"}},"required":["validUntil"],"type":"object","xml":{"name":"OrderPromisesOptions"},"title":"OrderPromisesOptions","description":"OrderPromisesOptions"},"SourceRef":{"additionalProperties":false,"properties":{"sourceRef":{"type":"string"}},"required":["sourceRef"],"type":"object","title":"SourceRef","description":"SourceRef"},"TenantSourceId":{"additionalProperties":false,"properties":{"tenantSourceId":{"type":"string"}},"required":["tenantSourceId"],"type":"object","title":"TenantSourceId","description":"TenantSourceId"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderStatusReason":{"description":"Order Status Reason.","properties":{"reason":{"description":"The reason for setting this order status","type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"required":["reason","status"],"title":"OrderStatusReason"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"CancelationReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReason"}],"properties":{"action":{"enum":["CANCELATION"],"type":"string"}},"required":["action"],"type":"object","xml":{"name":"CancelationReason"},"title":"CancelationReason","description":"CancelationReason"},"AbstractReason":{"allOf":[{"$ref":"#/components/schemas/AbstractReasonForCreation"},{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"action":{"description":"The action this reason can be attached to.","type":"string"},"id":{"description":"The id of the Reason","type":"string"}},"required":["id","action"],"type":"object","xml":{"name":"AbstractReason"},"title":"AbstractReason","description":"AbstractReason"},"AbstractReasonForCreation":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"Text explaining the reason for a supported action.","type":"string"}},"required":["reason","reasonLocalized"],"type":"object","xml":{"name":"AbstractReasonForCreation"},"title":"AbstractReasonForCreation","description":"AbstractReasonForCreation"},"CustomServiceReference":{"properties":{"articleItems":{"items":{"$ref":"#/components/schemas/ArticleItem"},"type":"array"},"customServiceDefinition":{"$ref":"#/components/schemas/CustomServiceDefinition"},"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["customServiceDefinition","articleItems","customServiceItems","id"],"type":"object","title":"CustomServiceReference","description":"CustomServiceReference"},"CustomServiceItem":{"allOf":[{"$ref":"#/components/schemas/CustomServiceItemForCreation"}],"properties":{"customServiceItems":{"items":{"$ref":"#/components/schemas/CustomServiceItem"},"type":"array"},"id":{"type":"string"}},"required":["id","customServiceItems","articleItems","customServiceDefinition"],"type":"object","title":"CustomServiceItem","description":"CustomServiceItem"},"OrderLineItem":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemForCreation"},{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticle"},"id":{"description":"The id of this orderline. It is generated during creation automatically by the API and suits as the primary identifier of the described line.","type":"string"}},"required":["article","id"],"type":"object"}],"title":"OrderLineItem","description":"OrderLineItem"},"OrderLineItemArticle":{"allOf":[{"$ref":"#/components/schemas/AbstractArticle"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the<a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItem"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticle"},"title":"OrderLineItemArticle","description":"OrderLineItemArticle"},"OrderArticleAttributeItem":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItem"}],"title":"OrderArticleAttributeItem","description":"OrderArticleAttributeItem"},"OrderPaymentInfo":{"additionalProperties":false,"properties":{"methodLocalized":{"$ref":"#/components/schemas/LocaleString"},"currency":{"description":"The currency in which the consumer paid with","type":"string"},"method":{"description":"Localized value from methodLocalized","type":"string"}},"type":"object","title":"OrderPaymentInfo","description":"OrderPaymentInfo"},"OrderPricing":{"allOf":[{"$ref":"#/components/schemas/OrderPricingForCreation"},{"properties":{"total":{"$ref":"#/components/schemas/OrderPricingTotal"}},"type":"object"}],"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Order pricing with customer-provided inputs and OMS-calculated totals.\n","title":"OrderPricing"},"OrderPricingTotal":{"properties":{"priceBreakdown":{"$ref":"#/components/schemas/OrderPricingTotals"}},"type":"object","title":"OrderPricingTotal","description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />OrderPricingTotal"},"OrderPricingTotals":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Calculated order price breakdown. All fields are optional — if a derived field cannot be calculated, it is omitted.\n","properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderTotalDiscounts"}],"nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderPricingTotals"},"OrderTotalDiscounts":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Aggregate discount total with a breakdown by source. Values follow the negative-or-zero discount convention.\n","properties":{"breakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object"},"value":{"allOf":[{"$ref":"#/components/schemas/MonetaryValue"}],"nullable":true,"type":"object"}},"type":"object","title":"OrderTotalDiscounts"},"OrderUpdateDetail":{"properties":{"changes":{"$ref":"#/components/schemas/OrderUpdateDetailChanges"},"comment":{"type":"string"},"created":{"description":"The date this update was done.","format":"date-time","type":"string"},"user":{"type":"string"}},"required":["created","changes"],"type":"object","title":"OrderUpdateDetail","description":"OrderUpdateDetail"},"OrderUpdateDetailChanges":{"properties":{"consumer":{"$ref":"#/components/schemas/OrderForCreationConsumer"},"customAttributes":{"description":"Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.","nullable":true,"type":"object"},"orderLineItems":{"description":"Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update.","items":{"$ref":"#/components/schemas/OrderLineItemForUpdate"},"nullable":true,"type":"array"},"preferredHandlingTime":{"description":"Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.","format":"date-time","type":"string"}},"type":"object","title":"OrderUpdateDetailChanges","description":"OrderUpdateDetailChanges"},"OrderLineItemForUpdate":{"properties":{"article":{"$ref":"#/components/schemas/OrderLineItemArticleForUpdate"},"id":{"description":"The id of this order line item. It is generated during creation automatically and suits as the primary identifier of the described entity.","type":"string"},"quantity":{"description":"The quantity of this order line item.","maximum":2147483647,"type":"number"}},"title":"OrderLineItemForUpdate","description":"OrderLineItemForUpdate"},"OrderLineItemArticleForUpdate":{"allOf":[{"$ref":"#/components/schemas/AbstractArticleForCreation"},{"properties":{"attributes":{"description":"Attributes are used in fulfillmenttools to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients.\nDetails about usage can be found in the <a href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes\">article attributes article</a>.","items":{"$ref":"#/components/schemas/OrderArticleAttributeItemForUpsert"},"maxItems":500,"type":"array"},"customAttributes":{"deprecated":true,"description":"@deprecated Please use customAttributes in OrderLineItem.\n","nullable":true,"type":"object"}},"type":"object"}],"xml":{"name":"OrderLineItemArticleForUpdate"},"title":"OrderLineItemArticleForUpdate","description":"OrderLineItemArticleForUpdate"},"AbstractArticleForCreation":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Ensure that no authentication is needed to fetch the image.","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"Weight value is in gram","minimum":0,"type":"number"}},"required":["title"],"title":"AbstractArticleForCreation","type":"object","description":"AbstractArticleForCreation"},"WorkflowInformation":{"additionalProperties":false,"properties":{"instanceRef":{"description":"The ID identifying the workflow instance this entity belongs to.","type":"string"},"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[true],"type":"boolean"},"nodeRef":{"description":"The ID identifying the node within the workflow instance tha this entity belongs to.","type":"string"}},"title":"WorkflowInformation","type":"object","description":"WorkflowInformation"},"WorkflowUnavailable":{"additionalProperties":false,"properties":{"isAvailable":{"description":"Explicitly states if this entity is part of a workflow.","enum":[false],"type":"boolean"}},"title":"WorkflowUnavailable","type":"object","description":"WorkflowUnavailable"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions":{"post":{"operationId":"orderLineItemAction","parameters":[{"description":"Reference to the order you want to call the action for","in":"path","name":"orderId","required":true,"schema":{"type":"string"}},{"description":"Reference to the order line item you want to call the action for","in":"path","name":"orderLineItemId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderLineItemActionsParameter"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"description":"Updated Order in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Call order line item action","tags":["Orders"]}}}}
```


# Order modification

The order modification feature allows users to adjust both original order details and process flows, enhancing flexibility and responsiveness in order handling.

To enable order modification within Backoffice, you must edit the [remote configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/remote-configuration) and set the `PROCESS_DETAILS_EDIT_ORDER_ENABLED`. You'll then need to add the required permission. The general permission `ORDER_LINEITEM_WRITE` can be used, or you can add more granular permissions. See the tables in the sectinos below to ensure that each role can only perform the specific operation it's authorized for.

## **Original order modification**

<table><thead><tr><th width="148.62109375">Action</th><th width="161.64453125">Description</th><th width="333.45703125">Conditions</th><th>Effect</th></tr></thead><tbody><tr><td><strong>Edit line items</strong></td><td>Delete items or adjust quantities to correct errors or reflect stock/customer needs.</td><td><ul><li>All associated operational entities are in the "open" state</li><li>Order line item is not attached to a <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/custom-services">custom service</a> or <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/bundled-line-items">bundled</a> with another item in the order</li><li>The feature is activated via the order modification configuration in the <a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/configurations/ordermodification">REST API</a></li><li><p>Each edit action requires its own <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a>:</p><ul><li><strong>General write access:</strong> <code>ORDER_LINEITEM_WRITE</code></li><li><strong>Add item</strong>: <code>LINE_ITEM_ADD</code></li><li><strong>Delete item:</strong> <code>LINE_ITEM_DELETE</code></li><li><strong>Increase quantity:</strong> <code>LINE_ITEM_QUANTITY_INCREASE</code></li><li><strong>Decrease quantity:</strong> <code>LINE_ITEM_QUANTITY_DECREASE</code></li></ul></li></ul></td><td>Reroute order</td></tr><tr><td><strong>Add new line item</strong></td><td>Extend the order by adding additional items.</td><td><ul><li>All associated operational entities are in the "open" state</li><li>Order line item is not attached to a <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/custom-services">custom service</a> or <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/bundled-line-items">bundled</a> with another item in the order</li><li>The feature is activated via the order modification configuration in the <a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/configurations/ordermodification">REST API</a></li><li>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>ORDER_LINEITEM_WRITE</code> and <code>LINE_ITEM_ADD</code> is set</li></ul></td><td>Reroute order</td></tr><tr><td><strong>Edit or add preferred date</strong></td><td>Add or change the delivery/handover date.</td><td><ul><li>All associated operational entities are in the "open" state</li><li>The feature is activated via the order modification configuration in the <a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/configurations/ordermodification">REST API</a></li><li>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>ORDER_WRITE</code> is set</li></ul></td><td>Reroute order</td></tr><tr><td><strong>Edit custom attributes</strong></td><td>Add or change attributes to tailor orders, for example, new routing criteria.</td><td><ul><li>All associated operational entities are in the "open" state</li><li>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>ORDER_CUSTOM_ATTRIBUTES_WRITE</code> is set</li></ul></td><td>Reroute order</td></tr><tr><td><strong>Edit customer address</strong></td><td>Correct address errors. A new shipping label might be required.</td><td>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>ORDER_CONSUMER_WRITE</code> is set</td><td>If a shipping label has already been generated, it becomes obsolete and must be recreated.</td></tr></tbody></table>

### Impact of original order modifications

A reroute results in the release of the inventory reservation. But an order might become unroutable if inventory is reserved for another order during the reroute process.

## **Process modification**

<table data-search="false"><thead><tr><th width="214.3125">Action</th><th width="195.4765625">Description</th><th width="303.25390625">Conditions</th></tr></thead><tbody><tr><td><strong>Cancel order</strong></td><td>Cancels all entities of an order.</td><td><ul><li>All pick jobs are open</li><li>No items have been picked</li><li>No shipping labels requested</li><li>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>ORDER_CANCEL</code> is set</li></ul></td></tr><tr><td><strong>Force cancel order</strong></td><td>Sets all entities to canceled regardless of processing status. Releases reserved stock. If items are already picked, manual steps are required to return items to storage and align physical inventory with system records.</td><td><ul><li>Must be enabled via <a href="https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#put-/api/configurations/ordercancelation">REST API</a></li><li>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>ORDER_FORCE_CANCEL</code> is set</li></ul></td></tr><tr><td><strong>Carrier change</strong></td><td>Changes the carrier for the picking task. A new label must be generated.</td><td><ul><li>Ship‑from‑store orders only</li><li>Handover job is open</li><li>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>SHIPMENT_WRITE</code> is set</li></ul></td></tr><tr><td><strong>Assign order</strong></td><td>Assigns the order to a new facility and creates a new pick job there. Deletes existing pick jobs.</td><td><ul><li>Ship‑from‑store orders only</li><li>All pick jobs are open</li><li>No items have been picked</li><li>No labels have been requested</li><li>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>PROCESS_WRITE</code> is set</li></ul></td></tr><tr><td><strong>Reroute order</strong></td><td>Performs new routing if the current routing isn't optimal.<br>Deletes existing pick jobs.</td><td><ul><li>All pick jobs are open</li><li>No items have been picked</li><li>No labels have been requested</li><li>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>PROCESS_REROUTE</code> is set</li></ul></td></tr><tr><td><strong>Reroute unroutable order</strong></td><td>Re-evaluates the order against routing rules to find an optimal path. Can be executed in bulk to process multiple unroutable orders simultaneously.</td><td><ul><li>Order or articles within the order are not routable</li><li>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>ROUTING_WRITE</code> is set</li></ul></td></tr><tr><td><strong>Task reroute</strong></td><td>Enables manual rerouting of tasks. Blocks the facility previously processing the order (if activated in the settings).</td><td><ul><li>Pick job is open</li><li>The necessary <a href="https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/user-management">permission</a> <code>ROUTING_WRITE</code> is set</li></ul></td></tr></tbody></table>

## Order modification events

Order modifications trigger specific events that enable tracking changes or integrating with other systems. See the complete list of [available events](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events).

## Modify an order

Not all properties of an order can be modified after the order has been placed. The following properties can be changed:

* **Order line items**
  * Modify quantity and article properties (except `tenantArticleId`)
  * Add new line items or remove existing ones
  * Feature must be activated in [order modification configuration](#order-modification-configuration)
  * See [Order Line Items Modification](#order-line-items-modification) for details
* **Order custom attributes**
  * Can only be modified before pick job or handover job has started
* **Preferred handling time**
  * Ship-from-store orders: Updates `desiredDeliveryTime`
  * Click-and-collect orders: Updates `provisioningTime`
  * Can only be modified before pick job or handover job has started
* **Consumer details/addresses**
  * Generally modifiable at any time
  * Changes to delivery addresses (`POSTAL_ADDRESS` or `PARCEL_LOCKER`) only allowed before handover job has started
  * See [Modification Restrictions](#modification-restrictions-based-on-process-state) for details

To modify an existing order at fulfillmenttools, call the following PATCH endpoint:

```http
PATCH https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/orders/{orderId}
```

The request body can contain any combination of the modifiable properties:

```json
{
  "version": 1,
  "comment": "Customer requested address correction and item updates",
  "customAttributes": {
    "customerSpecialHandling": "voucher",
    "internalNote": "VIP customer"
  },
  "orderLineItems": [
    {
      "id": "existing-orderlineitem-id",
      "quantity": 5,
      "article": {
        "title": "Updated Product Title",
        "imageUrl": "https://example.com/updated-image.jpg"
      }
    },
    {
      "quantity": 2,
      "article": {
        "tenantArticleId": "5020064",
        "title": "Wandtattoo Stadion",
        "imageUrl": "https://d358g9injarr4u.cloudfront.net/res/product_1000/343f4569-66bb-4b0c-aa2b-20011a51b620.jpg",
        "attributes": [
          {
            "category": "descriptive",
            "priority": 100,
            "key": "Maße",
            "value": "70 x 50 cm"
          },
          {
            "category": "descriptive",
            "priority": 200,
            "key": "Beschreibung",
            "value": "Wandtattoo in Ziegelwand-Optik, Mit tollem Blick aufs Stadion"
          }
        ]
      }
    }
  ],
  "addresses": [
    {
      "salutation": "Herr",
      "personalTitle": "Dr.",
      "firstName": "Max",
      "lastName": "Mustermann",
      "street": "Musterstraße",
      "houseNumber": "123",
      "postalCode": "50667",
      "city": "Köln",
      "country": "DE",
      "province": "DE-NW",
      "phoneNumbers": [
        {
          "value": "+49123456789",
          "label": "private",
          "type": "MOBILE"
        }
      ],
      "additionalAddressInfo": "2. Stock, links",
      "email": "max.mustermann@example.com",
      "addressType": "POSTAL_ADDRESS",
      "coordinates": {
        "lat": 50.9375,
        "lon": 6.9603
      }
    }
  ],
  "preferredHandlingTime": "2027-05-04T13:00:00.000Z"
}
```

### Order line items modification

Order line items can be modified in three ways:

1. **Update existing item**: Provide the `id` of the order line item
   * You can change the `quantity`
   * You can modify article properties (for example, `title`, `imageUrl`, `attributes`)
   * The `tenantArticleId` can't be modified
2. **Add new item**: Omit the `id` field
   * Provide complete `article` object with `tenantArticleId`
   * Specify desired `quantity`
   * Article `attributes` are optional
   * Same validation rules as order creation apply
3. **Remove item**: Set `quantity` to `0` for an existing order line item
   * At least one order line item must remain in the order

{% hint style="warning" %}
The `orderLineItems` array works as a diff/patch:

* Only include the order line items you want to change or add
* Order line items not included in the request remain unchanged
* Duplicate `tenantArticleId` values aren't supported
  {% endhint %}

**Example:**

```json
"orderLineItems": [
  {
    "id": "existing-item-id",
    "quantity": 5,
    "article": {
      "title": "Updated Product Title",
      "imageUrl": "https://new-image-url.com/image.jpg"
    }
  },
  {
    "quantity": 2,
    "article": {
      "tenantArticleId": "NEW-ARTICLE-123",
      "title": "New Product",
      "attributes": [
        {
          "category": "descriptive",
          "key": "Color",
          "value": "Blue"
        }
      ]
    }
  },
  {
    "id": "remove-this-item-id",
    "quantity": 0
  }
]
```

### Modification restrictions based on process state

Not all order properties can be modified at all times. Depending on the fulfillment process state, certain modifications are restricted:

#### Consumer/addresses

**Generally modifiable at any time**, except:

* Changes to delivery addresses (addresses with `addressType: POSTAL_ADDRESS` or `addressType: PARCEL_LOCKER`)
* Changes to `facilityRef`
* Changes to `tenantFacilityId`

These modifications are only allowed before a handover job has started.

#### Custom attributes

Can only be modified when no pick job has started and no handover job has started.

#### Preferred handling time

The `preferredHandlingTime` field updates different properties depending on the order type:

* **Shipping orders**: Updates `desiredDeliveryTime` in `deliveryPreferences.shipping`
* **Click-and-Collect orders**: Updates `provisioningTime` in the facility preferences

Can only be modified when no pick job has started and no handover job has started.

#### Order line items

Requires the order modification configuration flag `allowOrderLineItemModification` to be set to `true`.

See [Order modification configuration](#order-modification-configuration) for more information.

{% hint style="info" %}
There's no automated way to query the pick job or handover job status before attempting a modification. Consider the timing of your modifications and handle potential errors appropriately.
{% endhint %}

### Response

If the request was successful, it returns an HTTP `200 OK` response with a body containing the updated order.

Be aware that:

* An order must have at least one order line item with a quantity > 0.
* All validations that are applied during order creation are also applied during order modification.
* **Rerouting behavior**:
  * Modifications to `orderLineItems`, `customAttributes`, or `preferredHandlingTime` trigger automatic rerouting of the order.
  * Modifications to consumer details or addresses don't trigger rerouting.
* You can provide a `comment` for the modification, which is part of new `updateDetails` field in the order.
* The user field is only set when the `actorAnonymization` in the [GPDR configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/gdpr-configuration) is set to `false`.
* An event is sent when an order is modified. See [Available events](https://docs.fulfillmenttools.com/documentation/getting-started/eventing/available-events) for more information.
* Modification restrictions depend on the fulfillment process state (pick job, handover job). See [Modification Restrictions](#modification-restrictions-based-on-process-state) above.
* The `orderLineItems` array works as a diff. Only include items you want to modify, add, or remove. Other items remain unchanged.
* Duplicate `tenantArticleId` values within a single order aren't supported.
* To remove an order line item, set its `quantity` to `0`.
* The `tenantArticleId` of an existing order line item can't be changed.

```json
{
  // ...order body
  "updateDetails": [
    {
      "created": "2024-05-01T10:15:30.000Z",
      "user": "customer-service@fulfillmenttools.com",
      "comment": "Customer requested address correction and item updates",
      "changes": {
        "customAttributes": {
          "customerSpecialHandling": "voucher",
          "internalNote": "VIP customer"
        },
        "preferredHandlingTime": "2027-05-04T13:00:00.000Z",
        "orderLineItems": [
          {
            "id": "75d37a56-8e97-4598-afe9-4523af32bc0c",
            "quantity": 5
          }
        ],
        "addresses": [
          {
            "street": "Musterstraße",
            "houseNumber": "123",
            "postalCode": "50667",
            "city": "Köln",
            "country": "DE",
            "addressType": "POSTAL_ADDRESS"
          }
        ]
      }
    }
  ]
}
```

## Order modification configuration

There's an order modification configuration that controls the behavior of the order modification feature.

Currently supported:

* Enabling or disabling the modification of order line items

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/ordermodification
```

```json
{
  "version": 1,
  "allowOrderLineItemModification": true
}
```

## Authorization for order modification

Different order modification operations require specific permissions:

### Required permissions

* **ORDER\_WRITE**: Required for all order modifications
* **ORDER\_CONSUMER\_WRITE**: Additionally required when modifying consumer details or addresses
* **ORDER\_LINEITEM\_WRITE**: Additionally required when modifying order line items

### Permission examples

**Modifying only custom attributes or preferred handling time:**

```
Required: ORDER_WRITE
```

**Modifying addresses:**

```
Required: ORDER_WRITE + ORDER_CONSUMER_WRITE
```

**Modifying order line items:**

```
Required: ORDER_WRITE + ORDER_LINEITEM_WRITE
```

**Modifying multiple properties (for example, addresses and line items):**

```
Required: ORDER_WRITE + ORDER_CONSUMER_WRITE + ORDER_LINEITEM_WRITE
```

See the [Authorization article](https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization) for more information.

## Order modification error handling

### Optimistic locking conflicts

If the order has been modified by another process since you last retrieved it, you'll receive a `409 Conflict` error. In this case:

1. Fetch the latest version of the order
2. Review the changes
3. Retry your modification with the updated `version` number

### Validation errors

All validations from order creation also apply to modifications:

* At least one order line item must remain (quantity > 0)
* Duplicate `tenantArticleId` values aren't allowed
* All required fields must be present and valid

### Process state restrictions

If you attempt a modification that is not allowed in the current process state (for example, changing the delivery address after handover has started), you'll receive an error response. Since there's no automated way to query the process state beforehand, handle these errors appropriately in your integration.

## Best practices for order modification

1. **Always include the current version**: Use optimistic locking to prevent conflicts.
2. **Provide meaningful comments**: Help track the reason for modifications in the `updateDetails` history.
3. **Use diff-based updates for line items**: Only include changed items in `orderLineItems` array to keep the request minimal.
4. **Be aware of process state timing**: Consider the timing of your modifications relative to the fulfillment process.
5. **Understand re-routing behavior**: Modifications to order line items, custom attributes, or preferred handling time trigger automatic re-routing. Consumer/address updates do not trigger re-routing.
6. **Monitor events**: Listen to `ORD`


# Order records

An order record represents the finalized state of an order that has already been completed or originated outside the operational OMS flow. Unlike an [order](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/orders), an order record doesn't express customer intent that needs to be fulfilled. It captures what happened, not what needs to happen next. It doesn't participate in the fulfillment lifecycle and doesn't trigger routing, picking, packing, shipping, or any downstream operational processes.

Order records exist to make non-operational order data available for audit, analytics, and reporting, without adding load or complexity to the operational OMS.

## Distinction between order and order record

| Dimension           | Order record                         | Order                                  |
| ------------------- | ------------------------------------ | -------------------------------------- |
| Purpose             | Persist completed or external orders | Create demand and trigger fulfillment  |
| Lifecycle           | No lifecycle                         | Full lifecycle with events             |
| Downstream entities | None                                 | Yes (pick jobs, pack jobs, parcels, …) |
| Validation          | Minimal                              | Strict                                 |
| Input type          | Offline, batch, legacy, historical   | Real-time operational orders           |
| Cost profile        | Low (storage-oriented)               | Higher (event-driven, stateful)        |

## Create order records

Order records are created using a bulk endpoint that accepts up to 25 records per request. To create order records, call the following `PUT` endpoint:

{% tabs %}
{% tab title="Endpoint" %}

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/orderrecords
```

{% endtab %}

{% tab title="Request example" %}

```json
{
  "operations": [
    {
      "tenantOrderRecordId": "A-RECORD-99211",
      "orderRecordDate": "2026-03-24T13:21:00.000Z",
      "facilityRef": "22675b17-04d3-40eb-8970-5a5a382b4a76",
      "consumer": {
        "consumerId": "429117bb-6de0-462c-9062-44d7e6d68db2",
        "email": "anna.mueller@example.com",
        "addresses": [
          {
            "firstName": "Anna",
            "lastName": "Müller",
            "street": "Hauptstraße",
            "houseNumber": "34",
            "postalCode": "50667",
            "city": "Köln",
            "province": "Nordrhein-Westfalen",
            "country": "DE"
          }
        ]
      },
      "lineItems": [
        {
          "article": {
            "tenantArticleId": "ELEC-CAMERA-INSTANT",
            "title": "Sofortbildkamera Mini",
            "attributes": [
              {
                "category": "descriptive",
                "priority": 100,
                "key": "Filmformat",
                "value": "Instax Mini",
                "type": "STRING"
              },
              {
                "category": "basePrice",
                "key": "value",
                "value": "7499"
              },
              {
                "category": "basePrice",
                "key": "currency",
                "value": "EUR"
              },
              {
                "category": "basePrice",
                "key": "decimalPlaces",
                "value": "2"
              }
            ]
          },
          "quantity": 1,
          "warranty": {
            "warrantyStartDate": "2026-03-23T23:00:00.000Z",
            "warrantyPeriod": "P2Y"
          },
          "returnPolicy": {
            "isReturnable": true,
            "returnWindowEndDate": "2026-04-22T22:00:00.000Z"
          }
        }
      ],
      "payments": [
        {
          "paymentMethod": "Cash",
          "value": {
            "value": 8246,
            "currency": "EUR",
            "decimalPlaces": 2
          },
          "status": "COMPLETED"
        }
      ],
      "origin": {
        "type": "POS",
        "terminalId": "terminal-99211",
        "cashierId": "cashier-99211"
      }
    }
  ]
}
```

{% endtab %}

{% tab title="Response example" %}
If the request was successful, it returns an HTTP `200 OK` response with a summary and details for each operation:

`summary`: Counts of created, updated, and unchanged records in the batch

`details[].status`: The result for each operation — `CREATED`, `UPDATED`, `UNCHANGED`, or `FAILED`

`details[].orderRecord`: The full order record object including system-generated fields

`details[].error`: Present when status is `FAILED`, contains `type` and `message`

<pre class="language-json"><code class="lang-json">{
<strong>  "summary": {
</strong>    "created": 1,
    "updated": 0,
    "unchanged": 0
  },
  "details": [
    {
<strong>      "status": "CREATED",
</strong><strong>      "orderRecord": {
</strong>        "id": "665a1b2c3d4e5f6a7b8c9d0e",
        "version": 1,
        "tenantOrderRecordId": "A-RECORD-99211",
        "orderRecordDate": "2026-03-24T13:21:00.000Z",
        "facilityRef": "22675b17-04d3-40eb-8970-5a5a382b4a76",
        "created": "2026-03-24T14:00:00.000Z",
        "lastModified": "2026-03-24T14:00:00.000Z",
        "anonymized": false
      }
    }
  ]
}
</code></pre>

{% endtab %}
{% endtabs %}

## Order record structure

### Required fields

* `orderRecordDate`: Date and time of the transaction (ISO 8601)
* `facilityRef`: Reference to the facility where the transaction occurred
* `lineItems`: Array of purchased items (1–500 items)

### Optional fields

* `tenantOrderRecordId`: Your external order record ID for reference
* `consumer`: Customer information including `consumerId`, `email`, and `addresses` (up to 10)
* `payments`: Payment details (up to 100) including method, amounts, and status (`COMPLETED`, `FAILED`, `CANCELLED`, `REFUNDED`, `PARTIALLY_REFUNDED`)
* `origin`: POS origin information with `terminalId` and `cashierId`
* `pricing`: Order-level pricing breakdown with discounts (up to 100), fees (up to 100), and taxes (up to 100)
* `customAttributes`: Free-form key-value attributes for tenant-specific data

### Line items

Each line item requires an `article` with a `tenantArticleId` and a `quantity` (minimum 1). Optional fields include:

* `article.title`: Product name
* `article.attributes`: Product attributes with `key`, `value`, and optional `category`, `priority`, `type`, and localized values
* `measurementUnitKey`: Unit of measure
* `warranty`: Warranty details with `warrantyStartDate` and `warrantyPeriod` (ISO 8601 duration, for example, `P2Y` for 2 years)
* `returnPolicy`: Return details with `isReturnable` flag and `returnWindowEndDate`
* `customAttributes`: Free-form attributes

### Monetary values

All monetary values use the `MonetaryValue` format:

```json
{
  "value": 7499,
  "currency": "EUR",
  "decimalPlaces": 2
}
```

`value`: Amount in the smallest currency unit (for example, cents)

`currency`: ISO 4217 currency code

`decimalPlaces`: Number of decimal places (defaults to currency standard)

### System-generated fields

These fields are automatically set and returned in the response:

* `id`: Unique identifier for the order record
* `version`: Version number for optimistic locking
* `created`: Timestamp when the record was created
* `lastModified`: Timestamp of the last modification
* `anonymized`: Whether PII has been anonymized (GDPR)
* `gdprCleanupDate`: When anonymization will occur
* `deletionDate`: When the record will be permanently deleted
* `pricing.priceBreakdown`: Calculated totals including `subTotal`, `totalDiscounts`, `totalTaxes`, `totalFees`, `totalDeposit`, and `total`

## List order records

To retrieve a paginated list of order records, call the following `GET` endpoint:

```http
GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/orderrecords
```

### Query parameters

* `size` (optional): Number of items per page, maximum 500, default 20
* `startAfterId` (optional): Cursor for keyset pagination — pass the `id` of the last record from the previous page
* `facilityRef` (optional): Filter by facility reference
* `tenantOrderRecordId` (optional): Filter by your external order record ID

### Example: List with filtering

```http
GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/orderrecords?facilityRef=22675b17-04d3-40eb-8970-5a5a382b4a76&size=50
```

## Get a single order record

To retrieve a specific order record by its ID:

```http
GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/orderrecords/{orderRecordId}
```

Returns the full order record object or a `404 Not Found` if the record doesn't exist.

## Authorization

Order record operations require the following permissions:

* `ORDER_RECORD_READ`: Required for listing and retrieving order records
* `ORDER_RECORD_WRITE`: Required for creating order records

See the [Authorization article](https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization) for more information.

## GDPR and data retention

Order records support automatic GDPR compliance:

* **Anonymization**: PII is automatically anonymized based on the configured GDPR cleanup schedule
* **Deletion**: Records are permanently deleted after the configured retention period
* The `anonymized`, `gdprCleanupDate`, and `deletionDate` fields track the GDPR lifecycle

See the [GDPR configuration](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/gdpr-configuration) for more details.


# Order records endpoints

## List order records

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />List order records with pagination and optional filters

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints for managing orders that have already been completed and do not need to participate in the fulfillment lifecycle.","name":"Order records"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderRecords":{"properties":{"orderRecords":{"description":"Array of order records","items":{"$ref":"#/components/schemas/OrderRecord"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"number"}},"required":["orderRecords","total"],"title":"OrderRecords","type":"object","description":"OrderRecords"},"OrderRecord":{"properties":{"anonymized":{"description":"Whether consumer data has been anonymized","type":"boolean"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"deletionDate":{"description":"Date when the record will be deleted","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the facility","type":"string"},"gdprCleanupDate":{"description":"Date when GDPR cleanup will occur","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the order record","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItem"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricing"}],"description":"Pricing information including calculated totals"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"}},"required":["orderRecordDate","facilityRef","lineItems","id","version","created","lastModified","anonymized","gdprCleanupDate","deletionDate"],"title":"OrderRecord","type":"object","description":"OrderRecord"},"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"},"OrderRecordLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"description":"Unique identifier of the line item","type":"string"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity","id"],"title":"OrderRecordLineItem","type":"object","description":"OrderRecordLineItem"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"},"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"},"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordPricing":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingTotal"}],"description":"Calculated totals"}},"title":"OrderRecordPricing","type":"object","description":"OrderRecordPricing"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"},"OrderRecordPricingTotal":{"properties":{"priceBreakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotals"}],"description":"Calculated price breakdown"}},"title":"OrderRecordPricingTotal","type":"object","description":"OrderRecordPricingTotal"},"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/orderrecords":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />List order records with pagination and optional filters","operationId":"listOrderRecords","parameters":[{"in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"in":"query","name":"size","required":false,"schema":{"maximum":500,"type":"number"}},{"in":"query","name":"facilityRef","required":false,"schema":{"type":"string"}},{"in":"query","name":"tenantOrderRecordId","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRecords"}}},"description":"The order records that were found based on the given filters."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List order records","tags":["Order records"]}}}}
```

## Bulk create order records

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Create multiple order records in a single request (max 25)

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints for managing orders that have already been completed and do not need to participate in the fulfillment lifecycle.","name":"Order records"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderRecordBulkOperations":{"properties":{"operations":{"description":"Array of order record creation operations","items":{"$ref":"#/components/schemas/OrderRecordForCreation"},"maxItems":25,"minItems":1,"type":"array"}},"required":["operations"],"title":"OrderRecordBulkOperations","type":"object","description":"OrderRecordBulkOperations"},"OrderRecordForCreation":{"properties":{"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"facilityRef":{"description":"Reference to the facility","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItemForCreation"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingForCreation"}],"description":"Pricing information for the order record"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"}},"required":["orderRecordDate","facilityRef","lineItems"],"title":"OrderRecordForCreation","type":"object","description":"OrderRecordForCreation"},"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"},"OrderRecordLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity"],"title":"OrderRecordLineItemForCreation","type":"object","description":"OrderRecordLineItemForCreation"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"},"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"},"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordPricingForCreation":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"}},"title":"OrderRecordPricingForCreation","type":"object","description":"OrderRecordPricingForCreation"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"},"OrderRecordBulkOperationsResponse":{"properties":{"details":{"description":"Per-item results of the bulk operation","items":{"$ref":"#/components/schemas/OrderRecordBulkOperationResult"},"maxItems":25,"type":"array"},"summary":{"allOf":[{"$ref":"#/components/schemas/OrderRecordBulkOperationsSummary"}],"description":"Summary of the bulk operation"}},"required":["summary","details"],"title":"OrderRecordBulkOperationsResponse","type":"object","description":"OrderRecordBulkOperationsResponse"},"OrderRecordBulkOperationResult":{"properties":{"error":{"allOf":[{"$ref":"#/components/schemas/OrderRecordBulkOperationError"}],"description":"Error details if the operation failed"},"orderRecord":{"allOf":[{"$ref":"#/components/schemas/OrderRecord"}],"description":"The created order record"},"status":{"description":"Status of the bulk operation","enum":["CREATED","FAILED","UNCHANGED"],"type":"string"}},"required":["status"],"title":"OrderRecordBulkOperationResult","type":"object","description":"OrderRecordBulkOperationResult"},"OrderRecordBulkOperationError":{"properties":{"message":{"description":"Error message","type":"string"},"type":{"description":"Error type","enum":["VALIDATION","UNKNOWN"],"type":"string"}},"required":["type","message"],"title":"OrderRecordBulkOperationError","type":"object","description":"OrderRecordBulkOperationError"},"OrderRecord":{"properties":{"anonymized":{"description":"Whether consumer data has been anonymized","type":"boolean"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"deletionDate":{"description":"Date when the record will be deleted","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the facility","type":"string"},"gdprCleanupDate":{"description":"Date when GDPR cleanup will occur","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the order record","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItem"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricing"}],"description":"Pricing information including calculated totals"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"}},"required":["orderRecordDate","facilityRef","lineItems","id","version","created","lastModified","anonymized","gdprCleanupDate","deletionDate"],"title":"OrderRecord","type":"object","description":"OrderRecord"},"OrderRecordLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"description":"Unique identifier of the line item","type":"string"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity","id"],"title":"OrderRecordLineItem","type":"object","description":"OrderRecordLineItem"},"OrderRecordPricing":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingTotal"}],"description":"Calculated totals"}},"title":"OrderRecordPricing","type":"object","description":"OrderRecordPricing"},"OrderRecordPricingTotal":{"properties":{"priceBreakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotals"}],"description":"Calculated price breakdown"}},"title":"OrderRecordPricingTotal","type":"object","description":"OrderRecordPricingTotal"},"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"},"OrderRecordBulkOperationsSummary":{"properties":{"created":{"description":"Number of order records created","type":"integer"},"unchanged":{"description":"Number of order records unchanged","type":"integer"},"updated":{"description":"Number of order records updated","type":"integer"}},"required":["created","updated","unchanged"],"title":"OrderRecordBulkOperationsSummary","type":"object","description":"OrderRecordBulkOperationsSummary"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/orderrecords":{"put":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Create multiple order records in a single request (max 25)","operationId":"bulkCreateOrderRecords","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRecordBulkOperations"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRecordBulkOperationsResponse"}}},"description":"The order records have been successfully created."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Bulk create order records","tags":["Order records"]}}}}
```

## Get an order record

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Get a single order record by id

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints for managing orders that have already been completed and do not need to participate in the fulfillment lifecycle.","name":"Order records"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OrderRecord":{"properties":{"anonymized":{"description":"Whether consumer data has been anonymized","type":"boolean"},"consumer":{"allOf":[{"$ref":"#/components/schemas/OrderRecordConsumer"}],"description":"Consumer information"},"created":{"description":"Creation timestamp","format":"date-time","type":"string"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"deletionDate":{"description":"Date when the record will be deleted","format":"date-time","type":"string"},"facilityRef":{"description":"Reference to the facility","type":"string"},"gdprCleanupDate":{"description":"Date when GDPR cleanup will occur","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the order record","type":"string"},"lastModified":{"description":"Last modification timestamp","format":"date-time","type":"string"},"lineItems":{"description":"Line items of the order record","items":{"$ref":"#/components/schemas/OrderRecordLineItem"},"maxItems":500,"type":"array"},"orderRecordDate":{"description":"Date of the order record","format":"date-time","type":"string"},"origin":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}],"description":"Origin of the order record","discriminator":{"mapping":{"POS":"#/components/schemas/OrderRecordPosOrigin"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/OrderRecordPosOrigin"}]},"payments":{"description":"Payment information","items":{"$ref":"#/components/schemas/OrderRecordPayment"},"maxItems":100,"type":"array"},"pricing":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricing"}],"description":"Pricing information including calculated totals"},"tenantOrderRecordId":{"description":"Tenant-specific order record identifier","type":"string"},"version":{"description":"Version number for optimistic locking","type":"integer"}},"required":["orderRecordDate","facilityRef","lineItems","id","version","created","lastModified","anonymized","gdprCleanupDate","deletionDate"],"title":"OrderRecord","type":"object","description":"OrderRecord"},"OrderRecordConsumer":{"properties":{"addresses":{"description":"Addresses of the consumer","items":{"$ref":"#/components/schemas/OrderRecordAddress"},"maxItems":10,"type":"array"},"consumerId":{"description":"Consumer identifier","type":"string"},"email":{"description":"Email address of the consumer","type":"string"}},"title":"OrderRecordConsumer","type":"object","description":"OrderRecordConsumer"},"OrderRecordAddress":{"properties":{"additionalAddressInfo":{"description":"Additional address information","type":"string"},"city":{"description":"City","type":"string"},"companyName":{"description":"Company name","type":"string"},"country":{"description":"Country","type":"string"},"firstName":{"description":"First name","type":"string"},"houseNumber":{"description":"House number","type":"string"},"lastName":{"description":"Last name","type":"string"},"postalCode":{"description":"Postal code","type":"string"},"province":{"description":"Province or state","type":"string"},"street":{"description":"Street","type":"string"}},"title":"OrderRecordAddress","type":"object","description":"OrderRecordAddress"},"OrderRecordLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemArticle"}],"description":"Article information"},"customAttributes":{"description":"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.","nullable":true,"type":"object"},"id":{"description":"Unique identifier of the line item","type":"string"},"measurementUnitKey":{"description":"Measurement unit key","type":"string"},"quantity":{"description":"Quantity of the line item","type":"number"},"returnPolicy":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemReturnPolicy"}],"description":"Return policy information"},"warranty":{"allOf":[{"$ref":"#/components/schemas/OrderRecordLineItemWarranty"}],"description":"Warranty information"}},"required":["article","quantity","id"],"title":"OrderRecordLineItem","type":"object","description":"OrderRecordLineItem"},"OrderRecordLineItemArticle":{"properties":{"attributes":{"description":"Article attributes","items":{"$ref":"#/components/schemas/OrderRecordArticleAttributeItem"},"maxItems":100,"type":"array"},"tenantArticleId":{"description":"Tenant-specific article identifier","type":"string"},"title":{"description":"Title of the article","type":"string"}},"required":["tenantArticleId","attributes"],"title":"OrderRecordLineItemArticle","type":"object","description":"OrderRecordLineItemArticle"},"OrderRecordArticleAttributeItem":{"properties":{"valueLocalized":{"description":"Localized value of the attribute","type":"object"},"keyLocalized":{"description":"Localized key of the attribute","type":"object"},"category":{"description":"Category of the attribute. Supports both standard article attribute categories and pricing-specific categories.","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"key":{"description":"The key of the attribute","minLength":1,"type":"string"},"priority":{"description":"Priority of the attribute","type":"integer"},"type":{"description":"The type of the attribute","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"type":"string"}},"required":["key","value"],"title":"OrderRecordArticleAttributeItem","type":"object","description":"OrderRecordArticleAttributeItem"},"OrderRecordLineItemReturnPolicy":{"properties":{"isReturnable":{"description":"Whether the item is returnable","type":"boolean"},"returnWindowEndDate":{"description":"End date of the return window","format":"date-time","type":"string"}},"title":"OrderRecordLineItemReturnPolicy","type":"object","description":"OrderRecordLineItemReturnPolicy"},"OrderRecordLineItemWarranty":{"properties":{"warrantyPeriod":{"description":"Warranty period (e.g. ISO 8601 duration)","pattern":"^-?P(?:(\\d+W)|(\\d+Y)?(\\d+M)?(\\d+D)?(?:T(\\d+H)?(\\d+M)?(\\d+S)?)?)$","type":"string"},"warrantyStartDate":{"description":"Start date of the warranty","format":"date-time","type":"string"}},"title":"OrderRecordLineItemWarranty","type":"object","description":"OrderRecordLineItemWarranty"},"OrderRecordPosOrigin":{"properties":{"cashierId":{"description":"Cashier identifier","type":"string"},"terminalId":{"description":"Terminal identifier","type":"string"},"type":{"description":"Discriminator for POS origin","enum":["POS"],"type":"string"}},"required":["type"],"title":"OrderRecordPosOrigin","type":"object","description":"OrderRecordPosOrigin"},"OrderRecordPayment":{"properties":{"paymentMethod":{"description":"Payment method identifier","type":"string"},"receiptNumber":{"description":"Receipt number","type":"string"},"status":{"description":"Status of the payment","enum":["COMPLETED","FAILED","CANCELLED","REFUNDED","PARTIALLY_REFUNDED"],"type":"string"},"taxValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax portion of the payment value"},"transactionId":{"description":"Transaction identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Payment value"}},"required":["value"],"title":"OrderRecordPayment","type":"object","description":"OrderRecordPayment"},"OrderRecordMonetaryValue":{"properties":{"currency":{"description":"ISO 4217 currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"type":"string"},"decimalPlaces":{"description":"Number of decimal places (defaults to currency standard)","type":"integer"},"value":{"description":"The monetary value as integer","type":"integer"}},"required":["value","currency"],"title":"OrderRecordMonetaryValue","type":"object","description":"OrderRecordMonetaryValue"},"OrderRecordPricing":{"properties":{"discounts":{"description":"Discounts applied to the order","items":{"$ref":"#/components/schemas/OrderRecordDiscount"},"maxItems":100,"type":"array"},"fees":{"description":"Fees applied to the order","items":{"$ref":"#/components/schemas/OrderRecordFee"},"maxItems":100,"type":"array"},"taxes":{"description":"Tax breakdown","items":{"$ref":"#/components/schemas/OrderRecordTax"},"maxItems":100,"type":"array"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordPricingTotal"}],"description":"Calculated totals"}},"title":"OrderRecordPricing","type":"object","description":"OrderRecordPricing"},"OrderRecordDiscount":{"properties":{"nameLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleStringConstrained"}],"description":"Localized name of the discount"},"code":{"description":"Discount code","type":"string"},"context":{"description":"Context of the discount","type":"string"},"name":{"description":"Name of the discount","type":"string"},"percentage":{"description":"Discount percentage (0-100). Required when type is PERCENTAGE.","type":"number"},"tenantDiscountId":{"description":"Tenant-specific discount identifier","type":"string"},"type":{"description":"Discount type","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discount value. Required when type is ABSOLUTE."}},"title":"OrderRecordDiscount","type":"object","description":"OrderRecordDiscount"},"LocaleStringConstrained":{"properties":{},"title":"LocaleStringConstrained","type":"object","description":"LocaleStringConstrained"},"OrderRecordFee":{"properties":{"name":{"description":"Name of the fee","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Fee value"}},"title":"OrderRecordFee","type":"object","description":"OrderRecordFee"},"OrderRecordTax":{"properties":{"ratePercent":{"description":"Tax rate as a percentage","format":"float","type":"number"},"scope":{"description":"Tax scope","type":"string"},"taxableValue":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"The taxable base value"},"type":{"description":"Tax type identifier","type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Tax value"}},"required":["value"],"title":"OrderRecordTax","type":"object","description":"OrderRecordTax"},"OrderRecordPricingTotal":{"properties":{"priceBreakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotals"}],"description":"Calculated price breakdown"}},"title":"OrderRecordPricingTotal","type":"object","description":"OrderRecordPricingTotal"},"OrderRecordTotals":{"properties":{"subTotal":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Subtotal before discounts, taxes, and fees","nullable":true,"type":"object"},"total":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Grand total","nullable":true,"type":"object"},"totalDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordTotalDiscounts"}],"description":"Total discounts applied, with breakdown by source","nullable":true,"type":"object"},"totalFees":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total fees","nullable":true,"type":"object"},"totalLineItemSurcharges":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total line item surcharges applied","nullable":true,"type":"object"},"totalTaxes":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Total taxes","nullable":true,"type":"object"}},"required":["subTotal","totalDiscounts","totalLineItemSurcharges","totalTaxes","totalFees","total"],"title":"OrderRecordTotals","type":"object","description":"OrderRecordTotals"},"OrderRecordTotalDiscounts":{"properties":{"breakdown":{"allOf":[{"$ref":"#/components/schemas/OrderRecordDiscountBreakdown"}],"description":"Total discounts broken down by source"},"value":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Aggregate total discounts applied","nullable":true,"type":"object"}},"required":["value","breakdown"],"title":"OrderRecordTotalDiscounts","type":"object","description":"OrderRecordTotalDiscounts"},"OrderRecordDiscountBreakdown":{"properties":{"lineItemDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts originating from line items","nullable":true,"type":"object"},"orderDiscounts":{"allOf":[{"$ref":"#/components/schemas/OrderRecordMonetaryValue"}],"description":"Discounts applied at order level","nullable":true,"type":"object"}},"required":["lineItemDiscounts","orderDiscounts"],"title":"OrderRecordDiscountBreakdown","type":"object","description":"OrderRecordDiscountBreakdown"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/orderrecords/{orderRecordId}":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Get a single order record by id","operationId":"getOrderRecord","parameters":[{"in":"path","name":"orderRecordId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRecord"}}},"description":"The order record was found."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get an order record","tags":["Order records"]}}}}
```


# Order event history log

The order event history log provides a chronological, immutable record of all operational events on an order or operative entity. It shows what happened, when it happened, why it happened, and, if GDPR allows, who triggered the change. It covers the full order lifecycle and related entities, including pick jobs, pack jobs, parcels, handover jobs, routing plans, service jobs, and external actions. All events are exposed through the [process history logs REST API](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/order-event-history/process-history-log-endpoints).

A log entry always includes:

* **Domain:** The entity type the event belongs to (for example, `ORDER`, `PARCEL`, `PICKJOB`).
* **Event type**: The unique identifier for the event (for example, `ORDER_CREATED`, `PICKING_DONE`)
* **Type:** The category group for the event (for example, `ORDER_LIFECYCLE`, `FULFILLMENT`)
* **Info**: Human-readable event title displayed in the UI.
* **Time stamp**: When the event occurred.
* **Event cause:** Detailed explanation of when and why the event occurred.
* **User**: Information about the user or system that triggered the event. The user object is included in the event history entry only when the acting person is recorded under [GDPR actorAnonymization](https://docs.fulfillmenttools.com/documentation/by-pillar/order-management/gdpr-configuration). If user attribution isn't permitted, the log entry is stored without user information.
* **Payload:** Additional structured information depending on the event type.

## Event types

The following table describes all supported `ProcessHistoryEventType` values and their meaning in alphabetical order.

<table><thead><tr><th width="356.24609375">Event type</th><th>Description</th></tr></thead><tbody><tr><td><code>ACTION_TRIGGERED</code></td><td>An <a href="https://docs.fulfillmenttools.com/documentation/integrations/external-actions">external action</a> was triggered.</td></tr><tr><td><code>CARRIER_CHANGED</code></td><td>The carrier was changed.</td></tr><tr><td><code>COMMENT_ADDED</code></td><td>A user added a comment to the entity.</td></tr><tr><td><code>CONSUMER_ADDRESS_CHANGED</code></td><td>The consumer's address was updated.</td></tr><tr><td><code>DELIVERY_PROMISE_CREATED</code></td><td>This indicates that an initial <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising/delivery-promise">order delivery promise</a> was generated.</td></tr><tr><td><code>HANDOVER_CANCELED</code></td><td>A handover job was canceled.</td></tr><tr><td><code>HANDOVER_CREATED</code></td><td>A handover job was created.</td></tr><tr><td><code>HANDOVER_DONE</code></td><td>Handover was completed successfully.</td></tr><tr><td><code>HANDOVER_DONE_WITH_REFUSED_ITEMS</code></td><td>Handover completed with refused items.</td></tr><tr><td><code>LOCKED_ORDER_CREATED</code></td><td>The order was created with a locked status.</td></tr><tr><td><code>OPERATIVE_TASK_CREATED</code></td><td>A pick job or handover job was created.</td></tr><tr><td><code>ORDER_CANCELLED</code></td><td>A user or system rule canceled the order.</td></tr><tr><td><code>ORDER_CREATED</code></td><td>The order was created and now has an open status.</td></tr><tr><td><code>ORDER_CREATED_FROM_PROMISE</code></td><td>The previously created delivery promise was confirmed and turned into a real order.</td></tr><tr><td><code>ORDER_FORCE_CANCELLED</code></td><td>The order was forcibly canceled, bypassing standard validation.</td></tr><tr><td><code>ORDER_HAS_UNROUTABLE_ITEMS</code></td><td>The system detected items that can't be routed.</td></tr><tr><td><code>ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE</code></td><td>A reroute was triggered due to inactivity.</td></tr><tr><td><code>ORDER_ITEM_ADDED</code></td><td>A new item was added to the original order.</td></tr><tr><td><code>ORDER_ITEM_AMOUNT_CHANGED</code></td><td>The quantity of the original order line item changed.</td></tr><tr><td><code>ORDER_ITEM_DELETED</code></td><td>A line item was removed from the original order.</td></tr><tr><td><code>ORDER_MANUAL_FACILITY_ASSIGNMENT</code></td><td>A user manually assigned a facility to the order.</td></tr><tr><td><code>ORDER_MANUAL_REROUTE</code></td><td>A user manually triggered a reroute.</td></tr><tr><td><code>ORDER_MODIFICATION_REROUTE</code></td><td>The system rerouted the order due to an order modification.</td></tr><tr><td><code>ORDER_PREFERRED_DATE_MODIFIED</code></td><td>The preferred handling or delivery date was updated.</td></tr><tr><td><code>ORDER_TIME_TRIGGERED_REROUTE</code></td><td>A scheduled rule triggered a reroute.</td></tr><tr><td><code>ORDER_UNLOCKED</code></td><td>A previously locked order was unlocked.</td></tr><tr><td><code>PACKING_CREATED</code></td><td>A packing job was created.</td></tr><tr><td><code>PACKING_DONE</code></td><td>Packing was completed.</td></tr><tr><td><code>PACKING_IN_PROGRESS</code></td><td>Packing was started.</td></tr><tr><td><code>PARCEL_CREATED</code></td><td>A parcel was created.</td></tr><tr><td><code>PARCEL_LABEL_CREATION_FAILED</code></td><td>A shipping label request failed.</td></tr><tr><td><code>PARCEL_LABEL_REQUESTED</code></td><td>A shipping label for a parcel was requested.</td></tr><tr><td><code>PICKING_ABORTED_NO_ITEMS_PICKED</code></td><td>Picking was aborted without picking any items.</td></tr><tr><td><code>PICKING_CANCELLED</code></td><td>A picking task was canceled.</td></tr><tr><td><code>PICKING_DONE</code></td><td>Picking was completed successfully.</td></tr><tr><td><code>PICKING_DONE_INCOMPLETE</code></td><td>Picking finished with missing items.</td></tr><tr><td><code>PICKING_DONE_INCOMPLETE_REROUTE</code></td><td>The system rerouted after the picking task resulted in a short pick.</td></tr><tr><td><code>PICKING_IN_PROGRESS</code></td><td>Picking started.</td></tr><tr><td><code>PICKING_PAUSED</code></td><td>Picking paused.</td></tr><tr><td><code>PICKING_RESET</code></td><td>A picking process was reset.</td></tr><tr><td><code>PICKING_RESTART</code></td><td>A picking process was restarted.</td></tr><tr><td><code>REFUND_TRIGGERED</code></td><td>The <a href="https://docs.fulfillmenttools.com/documentation/backoffice/network-view/orders/returns#trigger-refund">refund</a> was triggered.</td></tr><tr><td><code>REROUTE_FAILED</code></td><td>No alternative facility found to fulfill items affected by short pick or unroutable conditions.</td></tr><tr><td><code>RETURN_ANNOUNCED</code></td><td>Return registered by customer.</td></tr><tr><td><code>RETURN_CANCELED</code></td><td>Return canceled due to canceled order.</td></tr><tr><td><code>RETURN_FINISHED</code></td><td>The return has been fully processed.</td></tr><tr><td><code>SERVICEJOB_CANCELED</code></td><td>A service job was canceled.</td></tr><tr><td><code>SERVICEJOB_CREATED</code></td><td>A service job was created.</td></tr><tr><td><code>SERVICEJOB_DONE</code></td><td>A service job was completed.</td></tr><tr><td><code>SERVICEJOB_IN_PROGRESS</code></td><td>A service job was started.</td></tr><tr><td><code>TASK_MANUAL_REROUTE</code></td><td>A user manually rerouted a picking task, not the complete order.</td></tr><tr><td><code>UNROUTABLE_ITEMS_REROUTE</code></td><td>A reroute of the unroutable items was triggered.</td></tr></tbody></table>

### Payload overview

Depending on the event type, the payload provides additional structured information. Examples include:

* **Reroute payloads** (manual, automatic, unroutable items): Contains reroute reasons, localized descriptions, and target facility information.
* **Order cancellation payload:** Includes cancellation reasons and localized texts.
* **Order modification payloads:** Covers address changes, preferred handling time updates, and line item modifications.
* **Status reason payload**: Includes order status change reasons.
* **Operative entity payloads:** Provides facility context for pick, pack, and service jobs.
* **Parcel label creation failure payload:** Includes facility information and an error message.
* **Picking incomplete payload:** Lists short-picked items and reasons.
* **Carrier changed payload:** Includes previous and new carrier.
* **Return and refund payload:** Includes the article ID, reason, and refund amount (price or percentage).

Payloads are always tailored to the event type and can include localized fields, facility references, article details, or operational metadata.


# Process history log endpoints

## The ProcessHistoryLog object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"ProcessHistoryLog":{"allOf":[{"$ref":"#/components/schemas/ProcessHistoryLogBase"}],"properties":{"eventType":{"$ref":"#/components/schemas/ProcessHistoryEventType"},"payload":{"description":"Payload varies based on eventType","nullable":true,"oneOf":[{"$ref":"#/components/schemas/RerouteLogPayload"},{"$ref":"#/components/schemas/RerouteLogPayloadBase"},{"$ref":"#/components/schemas/OrderCancellationPayload"},{"$ref":"#/components/schemas/OrderModificationPayloadBase"},{"$ref":"#/components/schemas/ConsumerAddressModifiedLogPayload"},{"$ref":"#/components/schemas/OrderModificationPreferredHandlingTimePayload"},{"$ref":"#/components/schemas/StatusReasonsPayload"},{"$ref":"#/components/schemas/OrderLineItemModifiedLogPayload"},{"$ref":"#/components/schemas/OperativeEntityPayloadBase"},{"$ref":"#/components/schemas/ExternalActionHistoryLogPayload"},{"$ref":"#/components/schemas/ParcelLabelCreationFailedPayload"},{"$ref":"#/components/schemas/OperativeEntityPickingDoneIncompletePayload"},{"$ref":"#/components/schemas/ReturnManagementPayloadBase"}],"type":"object"}},"required":["eventType"],"title":"ProcessHistoryLog","description":"ProcessHistoryLog"},"ProcessHistoryLogBase":{"properties":{"domain":{"$ref":"#/components/schemas/ProcessHistoryDomainType"},"domainRef":{"type":"string"},"eventCause":{"type":"string"},"id":{"type":"string"},"status":{"description":"Status can be OrderStatus, PickJobStatus, PackJobStatus, ParcelStatus, HandoverjobStatus, RoutingPlanStatus, ShipmentStatus, ItemReturnJobStatus or null","nullable":true,"type":"string"},"timestamp":{"description":"Timestamp of the moment at which this log entry was created.","format":"date-time","type":"string"},"type":{"description":"Can be ProcessHistoryLogTypeCommon or user-defined action type","type":"string"},"user":{"$ref":"#/components/schemas/ProcessHistoryLogUser"},"version":{"nullable":true,"type":"number"},"info":{"type":"string"}},"required":["id","type","domain","status","domainRef","version","user","timestamp"],"type":"object","title":"ProcessHistoryLogBase","description":"ProcessHistoryLogBase"},"ProcessHistoryDomainType":{"description":"The domain type of the process history entry","enum":["ORDER","ORDER_MODIFICATION","PICKJOB","PACKJOB","SERVICEJOB","PARCEL","HANDOVER","ROUTING_PLAN","EXTERNAL_ACTION","SHIPMENT","ITEM_RETURN"],"type":"string","title":"ProcessHistoryDomainType"},"ProcessHistoryLogUser":{"properties":{"username":{"type":"string"},"userRef":{"type":"string"}},"required":["userRef","username"],"type":"object","title":"ProcessHistoryLogUser","description":"ProcessHistoryLogUser"},"ProcessHistoryEventType":{"description":"Event types for process history","enum":["ORDER_CREATED","LOCKED_ORDER_CREATED","DELIVERY_PROMISE_CREATED","ORDER_CANCELLED","ORDER_FORCE_CANCELLED","ORDER_UNLOCKED","ORDER_CREATED_FROM_PROMISE","ORDER_MANUAL_REROUTE","UNROUTABLE_ITEMS_REROUTE","REROUTE_FAILED","ORDER_MANUAL_FACILITY_ASSIGNMENT","ORDER_TIME_TRIGGERED_REROUTE","ORDER_HAS_UNROUTABLE_ITEMS","ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE","TASK_MANUAL_REROUTE","ORDER_MODIFICATION_REROUTE","PICKING_DONE_INCOMPLETE_REROUTE","CONSUMER_ADDRESS_CHANGED","ORDER_ITEM_AMOUNT_CHANGED","ORDER_ITEM_DELETED","ORDER_ITEM_ADDED","ORDER_PREFERRED_DATE_MODIFIED","OPERATIVE_TASK_CREATED","PICKING_IN_PROGRESS","PICKING_PAUSED","PICKING_DONE","PICKING_DONE_INCOMPLETE","PICKING_ABORTED_NO_ITEMS_PICKED","PICKING_RESET","PICKING_RESTART","PICKING_CANCELLED","PACKING_CREATED","PACKING_IN_PROGRESS","PACKING_DONE","PARCEL_CREATED","PARCEL_LABEL_REQUESTED","PARCEL_LABEL_CREATION_FAILED","HANDOVER_CREATED","HANDOVER_DONE","HANDOVER_DONE_WITH_REFUSED_ITEMS","HANDOVER_CANCELED","SERVICEJOB_CREATED","SERVICEJOB_IN_PROGRESS","SERVICEJOB_DONE","SERVICEJOB_CANCELED","ACTION_TRIGGERED","COMMENT_ADDED","RETURN_ANNOUNCED","RETURN_CANCELED","RETURN_FINISHED","REFUND_TRIGGERED"],"type":"string","title":"ProcessHistoryEventType"},"RerouteLogPayload":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"},"targetFacility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"}},"required":["targetFacility"],"type":"object","title":"RerouteLogPayload","description":"RerouteLogPayload"},"RerouteDescriptionHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"RerouteDescriptionHistoryLog","description":"RerouteDescriptionHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"RerouteLogPayloadBase":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"}},"type":"object","title":"RerouteLogPayloadBase","description":"RerouteLogPayloadBase"},"OrderCancellationPayload":{"properties":{"cancelationReason":{"$ref":"#/components/schemas/CancelationReasonHistoryLog"}},"type":"object","title":"OrderCancellationPayload","description":"OrderCancellationPayload"},"CancelationReasonHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"CancelationReasonHistoryLog","description":"CancelationReasonHistoryLog"},"OrderModificationPayloadBase":{"properties":{"reason":{"type":"string"}},"type":"object","title":"OrderModificationPayloadBase","description":"OrderModificationPayloadBase"},"ConsumerAddressModifiedLogPayload":{"properties":{"changes":{"description":"List of address changes","items":{"$ref":"#/components/schemas/ConsumerAddressModifiedLogEntry"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogPayload","description":"ConsumerAddressModifiedLogPayload"},"ConsumerAddressModifiedLogEntry":{"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"changedFields":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogEntry","description":"ConsumerAddressModifiedLogEntry"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"OrderModificationPreferredHandlingTimePayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"newPreferredHandlingTime":{"description":"Updated preferredHandlingTime value","format":"date-time","nullable":true,"type":"string"},"previousPreferredHandlingTime":{"description":"preferredHandlingTime value before an update","format":"date-time","nullable":true,"type":"string"}},"required":["previousPreferredHandlingTime","newPreferredHandlingTime"],"title":"OrderModificationPreferredHandlingTimePayload","description":"OrderModificationPreferredHandlingTimePayload"},"StatusReasonsPayload":{"properties":{"statusReason":{"allOf":[{"$ref":"#/components/schemas/OrderStatusReasonLog"}],"description":"Reason for the status change","type":"object"}},"type":"object","title":"StatusReasonsPayload","description":"StatusReasonsPayload"},"OrderStatusReasonLog":{"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"type":"object","title":"OrderStatusReasonLog","description":"OrderStatusReasonLog"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderLineItemModifiedLogPayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"articles":{"description":"List of modified articles","items":{"$ref":"#/components/schemas/ArticleHistoryLog"},"type":"array"}},"title":"OrderLineItemModifiedLogPayload","description":"OrderLineItemModifiedLogPayload"},"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ExternalActionHistoryLogPayload":{"properties":{"groups":{"items":{"type":"string"},"type":"array"}},"required":["groups"],"type":"object","title":"ExternalActionHistoryLogPayload","description":"ExternalActionHistoryLogPayload"},"ParcelLabelCreationFailedPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"errorMessage":{"type":"string"}},"required":["errorMessage"],"type":"object","title":"ParcelLabelCreationFailedPayload","description":"ParcelLabelCreationFailedPayload"},"OperativeEntityPickingDoneIncompletePayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"shortPickedItems":{"items":{"$ref":"#/components/schemas/OperativeEntityShortPickedItem"},"type":"array"}},"title":"OperativeEntityPickingDoneIncompletePayload","description":"OperativeEntityPickingDoneIncompletePayload"},"OperativeEntityShortPickedItem":{"properties":{"article":{"$ref":"#/components/schemas/ArticleHistoryLog"},"picked":{"type":"number"},"quantity":{"type":"number"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"}},"required":["article","picked","quantity"],"type":"object","title":"OperativeEntityShortPickedItem","description":"OperativeEntityShortPickedItem"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"ReturnManagementPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"itemReturnJobsRef":{"type":"string"},"shortId":{"type":"string"}},"type":"object","title":"ReturnManagementPayloadBase","description":"ReturnManagementPayloadBase"}}}}
```

## Get process history logs

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Return all logs for a given process.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"A process groups all entities of an order.","name":"Processes"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ProcessHistoryLogSort":{"description":"Attribute to order a process history log by","enum":["TIMESTAMP_DESC","TIMESTAMP_ASC","INFO_DESC","INFO_ASC","TYPE_ASC","TYPE_DESC","USERNAME_DESC","USERNAME_ASC","FACILITY_NAME_DESC","FACILITY_NAME_ASC"],"type":"string","xml":{"name":"ProcessHistoryLogSort"},"title":"ProcessHistoryLogSort"},"ProcessHistoryLogs":{"properties":{"historyLogs":{"items":{"$ref":"#/components/schemas/ProcessHistoryLog"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"type":"object","title":"ProcessHistoryLogs","description":"ProcessHistoryLogs"},"ProcessHistoryLog":{"allOf":[{"$ref":"#/components/schemas/ProcessHistoryLogBase"}],"properties":{"eventType":{"$ref":"#/components/schemas/ProcessHistoryEventType"},"payload":{"description":"Payload varies based on eventType","nullable":true,"oneOf":[{"$ref":"#/components/schemas/RerouteLogPayload"},{"$ref":"#/components/schemas/RerouteLogPayloadBase"},{"$ref":"#/components/schemas/OrderCancellationPayload"},{"$ref":"#/components/schemas/OrderModificationPayloadBase"},{"$ref":"#/components/schemas/ConsumerAddressModifiedLogPayload"},{"$ref":"#/components/schemas/OrderModificationPreferredHandlingTimePayload"},{"$ref":"#/components/schemas/StatusReasonsPayload"},{"$ref":"#/components/schemas/OrderLineItemModifiedLogPayload"},{"$ref":"#/components/schemas/OperativeEntityPayloadBase"},{"$ref":"#/components/schemas/ExternalActionHistoryLogPayload"},{"$ref":"#/components/schemas/ParcelLabelCreationFailedPayload"},{"$ref":"#/components/schemas/OperativeEntityPickingDoneIncompletePayload"},{"$ref":"#/components/schemas/ReturnManagementPayloadBase"}],"type":"object"}},"required":["eventType"],"title":"ProcessHistoryLog","description":"ProcessHistoryLog"},"ProcessHistoryLogBase":{"properties":{"domain":{"$ref":"#/components/schemas/ProcessHistoryDomainType"},"domainRef":{"type":"string"},"eventCause":{"type":"string"},"id":{"type":"string"},"status":{"description":"Status can be OrderStatus, PickJobStatus, PackJobStatus, ParcelStatus, HandoverjobStatus, RoutingPlanStatus, ShipmentStatus, ItemReturnJobStatus or null","nullable":true,"type":"string"},"timestamp":{"description":"Timestamp of the moment at which this log entry was created.","format":"date-time","type":"string"},"type":{"description":"Can be ProcessHistoryLogTypeCommon or user-defined action type","type":"string"},"user":{"$ref":"#/components/schemas/ProcessHistoryLogUser"},"version":{"nullable":true,"type":"number"},"info":{"type":"string"}},"required":["id","type","domain","status","domainRef","version","user","timestamp"],"type":"object","title":"ProcessHistoryLogBase","description":"ProcessHistoryLogBase"},"ProcessHistoryDomainType":{"description":"The domain type of the process history entry","enum":["ORDER","ORDER_MODIFICATION","PICKJOB","PACKJOB","SERVICEJOB","PARCEL","HANDOVER","ROUTING_PLAN","EXTERNAL_ACTION","SHIPMENT","ITEM_RETURN"],"type":"string","title":"ProcessHistoryDomainType"},"ProcessHistoryLogUser":{"properties":{"username":{"type":"string"},"userRef":{"type":"string"}},"required":["userRef","username"],"type":"object","title":"ProcessHistoryLogUser","description":"ProcessHistoryLogUser"},"ProcessHistoryEventType":{"description":"Event types for process history","enum":["ORDER_CREATED","LOCKED_ORDER_CREATED","DELIVERY_PROMISE_CREATED","ORDER_CANCELLED","ORDER_FORCE_CANCELLED","ORDER_UNLOCKED","ORDER_CREATED_FROM_PROMISE","ORDER_MANUAL_REROUTE","UNROUTABLE_ITEMS_REROUTE","REROUTE_FAILED","ORDER_MANUAL_FACILITY_ASSIGNMENT","ORDER_TIME_TRIGGERED_REROUTE","ORDER_HAS_UNROUTABLE_ITEMS","ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE","TASK_MANUAL_REROUTE","ORDER_MODIFICATION_REROUTE","PICKING_DONE_INCOMPLETE_REROUTE","CONSUMER_ADDRESS_CHANGED","ORDER_ITEM_AMOUNT_CHANGED","ORDER_ITEM_DELETED","ORDER_ITEM_ADDED","ORDER_PREFERRED_DATE_MODIFIED","OPERATIVE_TASK_CREATED","PICKING_IN_PROGRESS","PICKING_PAUSED","PICKING_DONE","PICKING_DONE_INCOMPLETE","PICKING_ABORTED_NO_ITEMS_PICKED","PICKING_RESET","PICKING_RESTART","PICKING_CANCELLED","PACKING_CREATED","PACKING_IN_PROGRESS","PACKING_DONE","PARCEL_CREATED","PARCEL_LABEL_REQUESTED","PARCEL_LABEL_CREATION_FAILED","HANDOVER_CREATED","HANDOVER_DONE","HANDOVER_DONE_WITH_REFUSED_ITEMS","HANDOVER_CANCELED","SERVICEJOB_CREATED","SERVICEJOB_IN_PROGRESS","SERVICEJOB_DONE","SERVICEJOB_CANCELED","ACTION_TRIGGERED","COMMENT_ADDED","RETURN_ANNOUNCED","RETURN_CANCELED","RETURN_FINISHED","REFUND_TRIGGERED"],"type":"string","title":"ProcessHistoryEventType"},"RerouteLogPayload":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"},"targetFacility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"}},"required":["targetFacility"],"type":"object","title":"RerouteLogPayload","description":"RerouteLogPayload"},"RerouteDescriptionHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"RerouteDescriptionHistoryLog","description":"RerouteDescriptionHistoryLog"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization","title":"LocaleString","type":"object"},"ProcessHistoryLogFacility":{"properties":{"facilityGroups":{"items":{"$ref":"#/components/schemas/ProcessHistoryLogFacilityGroup"},"type":"array"},"facilityRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"type":"object","title":"ProcessHistoryLogFacility","description":"ProcessHistoryLogFacility"},"ProcessHistoryLogFacilityGroup":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"facilityGroupRef":{"type":"string"},"name":{"type":"string"},"version":{"type":"number"}},"required":["facilityGroupRef","version","nameLocalized"],"type":"object","title":"ProcessHistoryLogFacilityGroup","description":"ProcessHistoryLogFacilityGroup"},"RerouteLogPayloadBase":{"properties":{"rerouteDescription":{"$ref":"#/components/schemas/RerouteDescriptionHistoryLog"}},"type":"object","title":"RerouteLogPayloadBase","description":"RerouteLogPayloadBase"},"OrderCancellationPayload":{"properties":{"cancelationReason":{"$ref":"#/components/schemas/CancelationReasonHistoryLog"}},"type":"object","title":"OrderCancellationPayload","description":"OrderCancellationPayload"},"CancelationReasonHistoryLog":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"id":{"type":"string"},"reason":{"type":"string"},"version":{"type":"number"}},"required":["id","version"],"type":"object","title":"CancelationReasonHistoryLog","description":"CancelationReasonHistoryLog"},"OrderModificationPayloadBase":{"properties":{"reason":{"type":"string"}},"type":"object","title":"OrderModificationPayloadBase","description":"OrderModificationPayloadBase"},"ConsumerAddressModifiedLogPayload":{"properties":{"changes":{"description":"List of address changes","items":{"$ref":"#/components/schemas/ConsumerAddressModifiedLogEntry"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogPayload","description":"ConsumerAddressModifiedLogPayload"},"ConsumerAddressModifiedLogEntry":{"properties":{"addressType":{"$ref":"#/components/schemas/AddressType"},"changedFields":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"ConsumerAddressModifiedLogEntry","description":"ConsumerAddressModifiedLogEntry"},"AddressType":{"description":"Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.","enum":["POSTAL_ADDRESS","PARCEL_LOCKER","INVOICE_ADDRESS"],"type":"string","title":"AddressType"},"OrderModificationPreferredHandlingTimePayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"newPreferredHandlingTime":{"description":"Updated preferredHandlingTime value","format":"date-time","nullable":true,"type":"string"},"previousPreferredHandlingTime":{"description":"preferredHandlingTime value before an update","format":"date-time","nullable":true,"type":"string"}},"required":["previousPreferredHandlingTime","newPreferredHandlingTime"],"title":"OrderModificationPreferredHandlingTimePayload","description":"OrderModificationPreferredHandlingTimePayload"},"StatusReasonsPayload":{"properties":{"statusReason":{"allOf":[{"$ref":"#/components/schemas/OrderStatusReasonLog"}],"description":"Reason for the status change","type":"object"}},"type":"object","title":"StatusReasonsPayload","description":"StatusReasonsPayload"},"OrderStatusReasonLog":{"properties":{"reason":{"type":"string"},"status":{"$ref":"#/components/schemas/OrderStatus"}},"type":"object","title":"OrderStatusReasonLog","description":"OrderStatusReasonLog"},"OrderStatus":{"description":"The state of the order. Initially it is OPEN.","enum":["OPEN","CANCELLED","PROMISED","LOCKED","OBSOLETE"],"type":"string","title":"OrderStatus"},"OrderLineItemModifiedLogPayload":{"allOf":[{"$ref":"#/components/schemas/OrderModificationPayloadBase"}],"properties":{"articles":{"description":"List of modified articles","items":{"$ref":"#/components/schemas/ArticleHistoryLog"},"type":"array"}},"title":"OrderLineItemModifiedLogPayload","description":"OrderLineItemModifiedLogPayload"},"ArticleHistoryLog":{"properties":{"titleLocalized":{"$ref":"#/components/schemas/LocaleString"},"measurementUnit":{"properties":{"abbreviationLocalized":{"$ref":"#/components/schemas/LocaleString"}},"type":"object"},"newQuantity":{"type":"number"},"previousQuantity":{"type":"number"},"title":{"type":"string"}},"required":["title"],"type":"object","title":"ArticleHistoryLog","description":"ArticleHistoryLog"},"OperativeEntityPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"shortId":{"type":"string"}},"required":["facility"],"type":"object","title":"OperativeEntityPayloadBase","description":"OperativeEntityPayloadBase"},"ExternalActionHistoryLogPayload":{"properties":{"groups":{"items":{"type":"string"},"type":"array"}},"required":["groups"],"type":"object","title":"ExternalActionHistoryLogPayload","description":"ExternalActionHistoryLogPayload"},"ParcelLabelCreationFailedPayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"errorMessage":{"type":"string"}},"required":["errorMessage"],"type":"object","title":"ParcelLabelCreationFailedPayload","description":"ParcelLabelCreationFailedPayload"},"OperativeEntityPickingDoneIncompletePayload":{"allOf":[{"$ref":"#/components/schemas/OperativeEntityPayloadBase"}],"properties":{"shortPickedItems":{"items":{"$ref":"#/components/schemas/OperativeEntityShortPickedItem"},"type":"array"}},"title":"OperativeEntityPickingDoneIncompletePayload","description":"OperativeEntityPickingDoneIncompletePayload"},"OperativeEntityShortPickedItem":{"properties":{"article":{"$ref":"#/components/schemas/ArticleHistoryLog"},"picked":{"type":"number"},"quantity":{"type":"number"},"shortPickReason":{"$ref":"#/components/schemas/PickLineShortPickReason"}},"required":["article","picked","quantity"],"type":"object","title":"OperativeEntityShortPickedItem","description":"OperativeEntityShortPickedItem"},"PickLineShortPickReason":{"additionalProperties":false,"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Localized reason"},"reason":{"description":"translated reasonLocalized according to the given locale","type":"string"}},"required":["reasonLocalized"],"title":"PickLineShortPickReason","description":"PickLineShortPickReason"},"ReturnManagementPayloadBase":{"properties":{"facility":{"$ref":"#/components/schemas/ProcessHistoryLogFacility"},"itemReturnJobsRef":{"type":"string"},"shortId":{"type":"string"}},"type":"object","title":"ReturnManagementPayloadBase","description":"ReturnManagementPayloadBase"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/processes/{processId}/historylogs":{"get":{"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Return all logs for a given process.","operationId":"getProcessHistoryLogs","parameters":[{"in":"path","name":"processId","required":true,"schema":{"type":"string"}},{"description":"A type parameter for filtering history logs","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Reference to the username you want to get the corresponding history logs","in":"query","name":"username","required":false,"schema":{"type":"string"}},{"description":"Reference to the facility name you want to get the corresponding history logs","in":"query","name":"facilityName","required":false,"schema":{"type":"string"}},{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"type":"string"}},{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"type":"integer"}},{"description":"query process history log orderBy","in":"query","name":"orderBy","required":false,"schema":{"$ref":"#/components/schemas/ProcessHistoryLogSort"}},{"description":"control whether you want to filter consecutive duplicate logs","in":"query","name":"filterConsecutiveDuplicates","required":false,"schema":{"default":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessHistoryLogs"}}},"description":"The process logs which were found in response body"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Get process history logs","tags":["Processes"]}}}}
```


# Pricing data model

fulfillmenttools handles pricing data throughout the order lifecycle, but it doesn't make pricing decisions.

This article explains what pricing information fulfillmenttools accepts, how it stores pricing inputs, and how it derives deterministic order totals from those inputs.

You can fully reconstruct all order prices and intermediate totals at any time using only the pricing data stored with the order and the arithmetic-derived fields calculated by fulfillmenttools. Price reconstruction requires no catalog prices, defaults, or external systems.

{% hint style="warning" %}
The values calculated by fulfillmenttools, including derived fields, order totals, tax aggregates, and other calculated pricing values, are provided for operational fulfillment purposes only.

They are not intended and must not be used as an authoritative basis for invoicing, accounting, tax reporting, statutory reporting, or any other legally binding financial document.

You remain solely responsible for determining, validating, and maintaining legally compliant prices, taxes, invoices, accounting records, and financial reports using your own authoritative systems and processes.
{% endhint %}

## Responsibility split

fulfillmenttools isn't a pricing engine. It doesn't make pricing decisions.

Pricing authority lies outside fulfillmenttools and typically resides in a customer‑owned pricing engine or an authorized user acting through a backoffice application or other administrative interface with permission to create or modify pricing data.

fulfillmenttools has exactly two responsibilities:

* Store all pricing inputs verbatim
* Calculate deterministic, arithmetic-derived values based on those inputs

fulfillmenttools never applies:

* Business rules
* Pricing logic
* Tax logic
* Decision‑making logic

### Operational versus financial use

The pricing capabilities provided by fulfillmenttools are intended to support operational processes such as order management, fulfillment, picking, returns processing, operational reporting, and customer service workflows. The values calculated by fulfillmenttools are designed to provide consistent, traceable operational pricing information throughout the order lifecycle.

fulfillmenttools is not intended to serve as a financial, accounting, billing, invoicing, or tax system of record. Customers are responsible for maintaining and operating authoritative systems for financial reporting, invoice generation, accounting, tax determination, and statutory compliance.

## Pricing scopes

Pricing data exists on two distinct scopes, which can coexist within the same order. These scopes are:

* Line item pricing (item scope)
* Order pricing (order scope)

The table below outlines the key differences.

|                    | Line item pricing                                                                                                                  | Order pricing                                                                                                           |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **Applies to**     | Single order line item                                                                                                             | Entire order                                                                                                            |
| **Typical inputs** | <ul><li>Base price</li><li>Line item discounts</li><li>Line item taxes (already calculated)</li><li>Line item surcharges</li></ul> | <ul><li>Order‑wide discounts (promotions, coupons)</li><li>Order‑wide fees</li><li>Aggregated tax information</li></ul> |
| **Stored on**      | Article attribute level                                                                                                            | Top-level pricing object                                                                                                |

{% hint style="info" %}
Order pricing never modifies line item pricing.
{% endhint %}

## Core principles

### Monetary representation

All monetary values are represented using:

* `value` (integer)
* `currency` (ISO‑4217)
* `decimalPlaces`

### Deterministic arithmetic

fulfillmenttools performs deterministic arithmetic aggregation using:

* Multiplication
* Addition
* Subtraction
* Division

### No pricing logic

fulfillmenttools:

* Doesn't apply pricing logic
* Doesn't apply tax logic
* Doesn't infer missing values

### Representation normalization

fulfillmenttools doesn't perform business-rule rounding. However, some arithmetic operations (for example, percentage discounts or unit-price derivations) may produce results that can't be represented exactly using the integer-based monetary model (`value + decimalPlaces`). In such cases, fulfillmenttools applies deterministic normalization to the derived result so it can be represented using the required integer format.

For percentage-based discounts, normalization applies to the resulting subtotal after the discount is applied. The effective discount amount is then derived from the normalized subtotal.

This normalization is a technical representation constraint, not a pricing decision, and is applied consistently across all calculations.

{% hint style="info" %}
The current implementation uses standard rounding to the nearest representable minor unit based on the configured `decimalPlaces`.
{% endhint %}

Because normalization is applied to derived values rather than pricing inputs, small differences of one minor unit may occur compared to systems that apply normalization at a different calculation stage.

Such differences are expected because fulfillmenttools applies normalization to derived values rather than pricing inputs or intermediate calculation results. Systems that apply normalization at a different stage of the calculation may therefore produce slightly different results.

Customers are responsible for ensuring that downstream systems apply compatible calculation and normalization rules where consistency across systems is required. As a consequence of deterministic normalization, multiplying a normalized unit price by its quantity may result in a value that differs by up to one minor unit from the corresponding line-item total.

In such cases, the line-item total is considered the primary value for price aggregation and further calculations. The unit price represents a normalized derivation of that value.

## Line item pricing inputs

Line item pricing inputs are provided as pricing-related `attributes` on the respective order line item.

The supported pricing categories are:

* `basePrice`
* `discount`
* `tax`
* `surcharge`

For example:

```json
...
    "orderLineItems": [
    {
      "article": {
        "tenantArticleId": "TSHIRT-W-2468",
        "title": "Basic T-shirt white",
        "attributes": [
          { "category": "descriptive", "priority": 100, "key": "Size", "value": "S", "type": "STRING" },
          { "category": "basePrice", "key": "value", "value": "3000", "type": "NUMBER" },
          { "category": "basePrice", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "basePrice", "key": "decimalPlaces", "value": "2", "type": "NUMBER" },
          { "category": "discount", "key": "value", "value": "399", "type": "NUMBER" },
          { "category": "discount", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "discount", "key": "decimalPlaces", "value": "2", "type": "NUMBER" },
          { "category": "tax", "key": "value", "value": "513", "type": "NUMBER" },
          { "category": "tax", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "tax", "key": "decimalPlaces", "value": "2", "type": "NUMBER" }
        ]
      },
      "quantity": 1,
      "scannableCodes": ["829401938473"]
    }
...    
```

### Base price (input)

The base price represents the tax-inclusive unit price provided by the pricing authority.

fulfillmenttools treats base prices as authoritative input, stores them verbatim, and doesn't recalculate or infer missing values.

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Field</th><th>Definition</th></tr></thead><tbody><tr><td><code>basePrice.value</code></td><td>Unit price including all taxes applicable to the item, before discounts</td></tr><tr><td><code>basePrice.currency</code></td><td>ISO currency</td></tr><tr><td><code>basePrice.decimalPlaces</code></td><td>Decimal precision</td></tr><tr><td><code>basePrice.valueOfMeasureForBasePrice</code></td><td>Reference quantity for base price</td></tr><tr><td><code>basePrice.unitKeyOfMeasureForBasePrice</code></td><td>Measurement unit for base price (must be the same unit key in <code>quantity</code>)</td></tr></tbody></table>

In the tabs below, you'll find examples of the difference between an item purchased by weight and by piece.

{% tabs %}
{% tab title="Weighted line item" %}

```json
 ...
        [
          { "category": "basePrice", "key": "value", "value": "349", "type": "NUMBER" },
          { "category": "basePrice", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "basePrice", "key": "decimalPlaces", "value": "2", "type": "NUMBER" },
          { "category": "basePrice", "key": "valueOfMeasureForBasePrice", "value": "1000", "type": "NUMBER" },
          { "category": "basePrice", "key": "unitKeyOfMeasureForBasePrice", "value": "gram", "type": "STRING" }
        ]
      },
      "quantity": 800,
      "measurementUnitKey": "gram",
...
```

{% endtab %}

{% tab title="Piece line item" %}

```
...
        "attributes": [
          { "category": "basePrice", "key": "value", "value": "2999", "type": "NUMBER" },
          { "category": "basePrice", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "basePrice", "key": "decimalPlaces", "value": "2", "type": "NUMBER" },
        ]
      },
      "quantity": 1,
...      
```

{% endtab %}
{% endtabs %}

### Line item discounts (input)

Line item discounts only apply to the specific item.

Possible representations:

* Absolute discount amount
* Percentage discount
* Both

If both an absolute value and a percentage are provided, the absolute value is used for all fulfillmenttools‑calculated derived fields. Percentage values are treated as informational.

### Line item taxes (input)

fulfillmenttools never calculates taxes.

Tax data is:

* Provided by the pricing authority
* Stored verbatim
* Used for informational and reporting purposes only

All base prices are tax‑inclusive.

Tax values:

* Aren't price‑forming
* Aren't added on top of calculations

### Line‑item surcharges (input)

All surcharge values must be pre‑calculated by the pricing authority. The surcharge applies to the entire line item, not per quantity.

## Order pricing inputs

Order inputs are provided in the top‑level `pricing` object of the order entity.

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/orders
```

For example:

```json
...
{
    "pricing": {
       "discounts": [
            {
                "name": "Summer promotion",
                "nameLocalized": {
                    "en_US": "Coupon SUMMER2026",
                    "de_DE": "Coupon SOMMER2026"
                },
                "type": "PERCENTAGE",
                "percentage": 10,
                "context": "PROMOTION",
                "tenantDiscountId": "summer-2026"
            },
       ], 
       "fees": [
         {
          "name": "Shipping fee",
          "value": { "value": 499, "currency": "EUR", "decimalPlaces": 2 }
         }
       ],
       "taxes": [
         {
           "type": "VAT",
           "ratePercent": 19,
           "value": { "value": 2565, "currency": "EUR", "decimalPlaces": 2 },
           "scope": "DOMESTIC",
           "taxableValue": { "value": 13493, "currency": "EUR", "decimalPlaces": 2 }
         }
       ]
...       
```

### Order discounts (input)

Apply to the entire order only.

Examples:

* Campaign promotions
* Vouchers
* Coupons

Order discounts:

* Don't affect individual line item prices
* Aren't redistributed to items
* Are treated as fixed inputs

If both a percentage and an absolute value are provided, the absolute value takes precedence.

#### Gift cards or prepaid instruments

This pricing model doesn't support gift cards, prepaid instruments, or store credit. Within this documentation, vouchers refer to discount codes that reduce the price of goods. Instruments carrying a monetary balance are not discounts. They are payment methods and don't reduce the value of the goods themselves. Such instruments may have their own redemption, balance management, and tax treatment rules, which are outside the scope of fulfillmenttools and aren't represented by this pricing model.

A voucher code may be carried through the order as an order-level discount by storing the code in `tenantDiscountId` and providing a discount value of 0. fulfillmenttools passes the code through without validation and doesn't derive any discount value from it.

External systems remain responsible for voucher redemption, remaining balance calculations, payment handling, and tax treatment.

### Order fees (input)

Order fees apply once per order. They are treated as fixed order inputs. They aren't automatically recalculated or redistributed when you add, remove, or change line items.

Examples:

* Packaging
* Service fees
* Handling fees

### Order taxes (input)

Order taxes represent aggregated, informational tax summaries.

They can coexist with line item tax data.

fulfillmenttools:

* Doesn't calculate taxes
* Doesn't reconcile line item and order taxes
* Doesn't validate tax consistency

## Derived price components (fulfillmenttools‑calculated)

### General rules

fulfillmenttools performs only deterministic arithmetic aggregation:

* Multiplication
* Addition
* Subtraction

fulfillmenttools:

* Doesn't apply pricing logic
* Applies no tax logic
* Performs no business-rule rounding. When derived values can't be represented exactly using the target integer representation (`value + decimalPlaces`), fulfillmenttools applies deterministic normalization to the derived result.
* Infers no missing values

### Derived fields: Line item

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="151.453125">Field</th><th width="213.05859375">Formula</th><th width="224.453125">Can't calculate when</th><th>Result when it can't be calculated</th></tr></thead><tbody><tr><td><code>subtotalBeforeDiscounts</code></td><td><p><code>basePrice.value</code> × <code>quantity</code></p><p>or<br><br><code>basePrice.value</code> × (<code>quantity</code> / <code>valueOfMeasureForBasePrice</code>)</p></td><td>Missing <code>basePrice</code> or <code>quantity</code></td><td><code>null</code></td></tr><tr><td><code>subtotalAfterDiscounts</code></td><td><code>subtotalBeforeDiscounts</code> − <code>discount.value</code></td><td>Missing inputs</td><td><code>null</code></td></tr><tr><td><code>finalUnitPrice</code></td><td><code>subtotalAfterDiscount</code> / <code>quantity</code></td><td>Missing inputs</td><td><code>null</code></td></tr><tr><td><code>finalLineItemPrice</code></td><td><code>(finalUnitPrice</code> × <code>quantity</code>) + <code>surcharge.value</code></td><td>Missing inputs</td><td><code>null</code></td></tr></tbody></table>

If required inputs are missing, fulfillmenttools doesn't perform partial calculations and logs an internal warning.

### Derived fields: Order totals

fulfillmenttools also calculates order totals based on:

* Line item derived values
* Order pricing inputs

Within the `pricing` object, you'll find the below fields within the `total.priceBreakdown`:

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Field</th><th>Meaning</th><th>Can't calculate when</th><th>Result when it can't be calculated</th></tr></thead><tbody><tr><td><code>subTotal</code></td><td>Sum of all line item <code>subtotalBeforeDiscounts</code></td><td>Any subtotal missing</td><td><code>null</code></td></tr><tr><td><code>totalDiscounts</code></td><td>Sum of all discounts affecting order total (item + order scope)</td><td>No discounts present</td><td><code>0</code></td></tr><tr><td><code>totalLineItemSurcharges</code></td><td>Sum of (surcharges.value)</td><td>No surcharge present</td><td><code>0</code></td></tr><tr><td><code>totalFees</code></td><td>Sum of order‑level fees</td><td>No fees present</td><td><code>0</code></td></tr><tr><td><code>totalTaxes</code></td><td>Sum of (tax.value (line-item)) + sum of (tax.value (order-level))<br><br>No VAT calculations in the totals. These are just for information.</td><td>Missing tax values</td><td><code>null</code></td></tr><tr><td><code>total</code></td><td><code>subTotal</code> − <code>totalDiscounts</code> + <code>totalFees</code> + <code>totalLineItemSurcharges</code></td><td>Any required input missing</td><td><code>null</code></td></tr></tbody></table>

## Behavior when pricing is missing

If required pricing inputs for a derived field are missing, fulfillmenttools doesn't calculate that derived field, sets it to `null`, and logs an internal warning.

Derived pricing is calculated only when all required inputs are present. No partial derivations are performed.

Missing values are never interpreted as zero. You must explicitly provide a base price of `0` to indicate a free item. Derived values are only calculated when all inputs required for the respective calculation are present.

## Price reconstruction guarantee

The final order price and all intermediate totals can be fully reconstructed using:

* Stored pricing inputs
* fulfillmenttools-calculated arithmetic derived fields

No catalog prices, defaults, assumptions, or external systems are required.

The reconstruction guarantee applies to price calculation and traceability. The pricing authority remains responsible for pricing correctness.

## Contractual scope

This document describes the technical behavior of fulfillmenttools pricing functionality.

The contractual scope of fulfillmenttools responsibilities is defined exclusively by the applicable contractual agreements between fulfillmenttools and the customer.

This documentation doesn't constitute a contractual warranty, legal opinion, accounting guidance, tax guidance, or guarantee regarding the correctness, validity, or compliance of pricing, tax, accounting, or invoicing data.

## Example

{% tabs %}
{% tab title="Endpoint" %}

```http
POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/orders
```

{% endtab %}

{% tab title="Request" %}

```json
{
    "orderDate": "{{$isoTimestamp}}",
    "consumer": {
        "email": "phil.bison@fulfillmenttools.com",
        "addresses": [
            {
                "street": "42nd street",
                "houseNumber": "42",
                "postalCode": "42420",
                "city": "Los Angeles",
                "country": "US",
                "firstName": "Phil",
                "lastName": "Bison"
            }
        ]
    },
    "tenantOrderId": "R42424242",
    "status": "OPEN",
  "orderLineItems": [
    {
      "article": {
        "tenantArticleId": "TSHIRT-W-2468",
        "title": "Basic T-shirt white",
        "attributes": [
          { "category": "descriptive", "priority": 100, "key": "Size", "value": "S", "type": "STRING" },
          { "category": "basePrice", "key": "value", "value": "3000", "type": "NUMBER" },
          { "category": "basePrice", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "basePrice", "key": "decimalPlaces", "value": "2", "type": "NUMBER" },
          { "category": "discount", "key": "value", "value": "399", "type": "NUMBER" },
          { "category": "discount", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "discount", "key": "decimalPlaces", "value": "2", "type": "NUMBER" },
          { "category": "tax", "key": "value", "value": "513", "type": "NUMBER" },
          { "category": "tax", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "tax", "key": "decimalPlaces", "value": "2", "type": "NUMBER" }
        ]
      },
      "quantity": 1,
      "scannableCodes": ["829401938473"]
    },
    {
      "article": {
        "tenantArticleId": "SNEAK-W-4891",
        "title": "White sneakers",
        "attributes": [
          { "category": "descriptive", "priority": 100, "key": "Size", "value": "44", "type": "STRING" },
          { "category": "basePrice", "key": "value", "value": "8999", "type": "NUMBER" },
          { "category": "basePrice", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "basePrice", "key": "decimalPlaces", "value": "2", "type": "NUMBER" },
          { "category": "discount", "key": "value", "value": "999", "type": "NUMBER" },
          { "category": "discount", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "discount", "key": "decimalPlaces", "value": "2", "type": "NUMBER" },
          { "category": "tax", "key": "value", "value": "1539", "type": "NUMBER" },
          { "category": "tax", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "tax", "key": "decimalPlaces", "value": "2", "type": "NUMBER" },
          { "category": "surcharge", "key": "value", "value": "299", "type": "NUMBER" },
          { "category": "surcharge", "key": "currency", "value": "EUR", "type": "CURRENCY" },
          { "category": "surcharge", "key": "decimalPlaces", "value": "2", "type": "NUMBER" }
        ]
      },
      "quantity": 1,
      "scannableCodes": ["738502847562"]
    }
  ],
  "paymentInfo": {
    "currency": "EUR"
  },
  "pricing": {
       "discounts": [
            {
                "name": "Summer promotion",
                "nameLocalized": {
                    "en_US": "Coupon SUMMER2026",
                    "de_DE": "Coupon SOMMER2026"
                },
                "type": "PERCENTAGE",
                "percentage": 10,
                "context": "PROMOTION",
                "tenantDiscountId": "summer-2026"
            },
            {
                "name": "First order promotion",
                "nameLocalized": {
                    "en_US": "First order promotion",
                    "de_DE": "Neukunde Promotion"
                },
                "type": "ABSOLUTE",
                "value": {
                    "value": 1000,
                    "decimalPlaces": 2,
                    "currency": "EUR"
                },
                "context": "PROMOTION",
                "tenantDiscountId": "first-order"
              }
           ],
    "fees": [
      {
        "name": "Packaging fee",
        "value": { "value": 199, "currency": "EUR", "decimalPlaces": 2 }
      },
      {
        "name": "Shipping fee",
        "value": { "value": 499, "currency": "EUR", "decimalPlaces": 2 }
      }
    ],
    "taxes": [
       {
         "type": "VAT",
         "ratePercent": 19,
         "value": { "value": 2565, "currency": "EUR", "decimalPlaces": 2 },
         "scope": "DOMESTIC",
         "taxableValue": { "value": 13493, "currency": "EUR", "decimalPlaces": 2 }
       },
       {
         "type": "VAT",
         "ratePercent": 7,
         "value": { "value": 22, "currency": "EUR", "decimalPlaces": 2 },
         "scope": "DOMESTIC",
         "taxableValue": { "value": 319, "currency": "EUR", "decimalPlaces": 2 }
       }
    ]
  }
}
```

{% endtab %}

{% tab title="Response" %}

```json
{
    "orderDate": "2026-07-13T08:01:50.324Z",
    "consumer": {
        "email": "phil.bison@fulfillmenttools.com",
        "addresses": [
            {
                "street": "42nd street",
                "houseNumber": "42",
                "postalCode": "42420",
                "city": "Los Angeles",
                "country": "US",
                "firstName": "Phil",
                "lastName": "Bison",
                "addressType": "POSTAL_ADDRESS"
            }
        ]
    },
    "tenantOrderId": "R42424242",
    "status": "OPEN",
    "orderLineItems": [
        {
            "article": {
                "tenantArticleId": "TSHIRT-W-2468",
                "title": "Basic T-shirt white",
                "attributes": [
                    {
                        "category": "descriptive",
                        "priority": 100,
                        "key": "Size",
                        "value": "S",
                        "type": "STRING"
                    },
                    {
                        "category": "basePrice",
                        "key": "value",
                        "value": "3000",
                        "type": "NUMBER"
                    },
                    {
                        "category": "basePrice",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "basePrice",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "discount",
                        "key": "value",
                        "value": "399",
                        "type": "NUMBER"
                    },
                    {
                        "category": "discount",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "discount",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "tax",
                        "key": "value",
                        "value": "570",
                        "type": "NUMBER"
                    },
                    {
                        "category": "tax",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "tax",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "subtotalBeforeDiscounts",
                        "key": "value",
                        "value": "3000",
                        "type": "NUMBER"
                    },
                    {
                        "category": "subtotalBeforeDiscounts",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "subtotalBeforeDiscounts",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "subtotalAfterDiscounts",
                        "key": "value",
                        "value": "2601",
                        "type": "NUMBER"
                    },
                    {
                        "category": "subtotalAfterDiscounts",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "subtotalAfterDiscounts",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "finalUnitPrice",
                        "key": "value",
                        "value": "2601",
                        "type": "NUMBER"
                    },
                    {
                        "category": "finalUnitPrice",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "finalUnitPrice",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "finalLineItemPrice",
                        "key": "value",
                        "value": "2601",
                        "type": "NUMBER"
                    },
                    {
                        "category": "finalLineItemPrice",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "finalLineItemPrice",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    }
                ]
            },
            "quantity": 1,
            "scannableCodes": [
                "829401938473"
            ],
            "id": "019f5a7f-6ec5-746a-83dc-3127fea1b97e"
        },
        {
            "article": {
                "tenantArticleId": "SNEAK-W-4891",
                "title": "White sneakers",
                "attributes": [
                    {
                        "category": "descriptive",
                        "priority": 100,
                        "key": "Size",
                        "value": "44",
                        "type": "STRING"
                    },
                    {
                        "category": "basePrice",
                        "key": "value",
                        "value": "11900",
                        "type": "NUMBER"
                    },
                    {
                        "category": "basePrice",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "basePrice",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "discount",
                        "key": "value",
                        "value": "999",
                        "type": "NUMBER"
                    },
                    {
                        "category": "discount",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "discount",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "tax",
                        "key": "value",
                        "value": "2261",
                        "type": "NUMBER"
                    },
                    {
                        "category": "tax",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "tax",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "surcharge",
                        "key": "value",
                        "value": "299",
                        "type": "NUMBER"
                    },
                    {
                        "category": "surcharge",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "surcharge",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "subtotalBeforeDiscounts",
                        "key": "value",
                        "value": "11900",
                        "type": "NUMBER"
                    },
                    {
                        "category": "subtotalBeforeDiscounts",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "subtotalBeforeDiscounts",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "subtotalAfterDiscounts",
                        "key": "value",
                        "value": "10901",
                        "type": "NUMBER"
                    },
                    {
                        "category": "subtotalAfterDiscounts",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "subtotalAfterDiscounts",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "finalUnitPrice",
                        "key": "value",
                        "value": "10901",
                        "type": "NUMBER"
                    },
                    {
                        "category": "finalUnitPrice",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "finalUnitPrice",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    },
                    {
                        "category": "finalLineItemPrice",
                        "key": "value",
                        "value": "11200",
                        "type": "NUMBER"
                    },
                    {
                        "category": "finalLineItemPrice",
                        "key": "currency",
                        "value": "EUR",
                        "type": "CURRENCY"
                    },
                    {
                        "category": "finalLineItemPrice",
                        "key": "decimalPlaces",
                        "value": "2",
                        "type": "NUMBER"
                    }
                ]
            },
            "quantity": 1,
            "scannableCodes": [
                "738502847562"
            ],
            "id": "019f5a7f-6ec5-746a-83dc-37f1f22e0af6"
        }
    ],
    "paymentInfo": {
        "currency": "EUR"
    },
    "pricing": {
        "discounts": [
            {
                "name": "Summer promotion",
                "nameLocalized": {
                    "en_US": "Coupon SUMMER2026",
                    "de_DE": "Coupon SOMMER2026"
                },
                "type": "PERCENTAGE",
                "percentage": 10,
                "context": "PROMOTION",
                "tenantDiscountId": "summer-2026"
            },
            {
                "name": "First order promotion",
                "nameLocalized": {
                    "en_US": "First order promotion",
                    "de_DE": "Neukunde Promotion"
                },
                "type": "ABSOLUTE",
                "value": {
                    "value": 1000,
                    "decimalPlaces": 2,
                    "currency": "EUR"
                },
                "context": "PROMOTION",
                "tenantDiscountId": "first-order"
            }
        ],
        "fees": [
            {
                "name": "Packaging fee",
                "value": {
                    "value": 199,
                    "currency": "EUR",
                    "decimalPlaces": 2
                }
            },
            {
                "name": "Shipping fee",
                "value": {
                    "value": 499,
                    "currency": "EUR",
                    "decimalPlaces": 2
                }
            }
        ],
        "taxes": [
            {
                "type": "VAT",
                "ratePercent": 19,
                "value": {
                    "value": 2622,
                    "currency": "EUR",
                    "decimalPlaces": 2
                },
                "scope": "DOMESTIC",
                "taxableValue": {
                    "value": 13801,
                    "currency": "EUR",
                    "decimalPlaces": 2
                }
            }
        ],
        "total": {
            "priceBreakdown": {
                "subTotal": {
                    "value": 14900,
                    "currency": "EUR",
                    "decimalPlaces": 2
                },
                "totalDiscounts": {
                    "value": {
                        "value": 3407,
                        "currency": "EUR",
                        "decimalPlaces": 2
                    },
                    "breakdown": {
                        "lineItemDiscounts": {
                            "value": 1099,
                            "currency": "EUR",
                            "decimalPlaces": 2
                        },
                        "orderDiscounts": {
                            "value": 2308,
                            "currency": "EUR",
                            "decimalPlaces": 2
                        }
                    }
                },
                "totalTaxes": {
                    "value": 2622,
                    "currency": "EUR",
                    "decimalPlaces": 2
                },
                "totalFees": {
                    "value": 698,
                    "currency": "EUR",
                    "decimalPlaces": 2
                },
                "totalLineItemSurcharges": {
                    "value": 299,
                    "currency": "EUR",
                    "decimalPlaces": 2
                },
                "total": {
                    "value": 15112,
                    "currency": "EUR",
                    "decimalPlaces": 2
                }
            }
        }
    },
    "deliveryPreferences": {
        "shipping": {
            "serviceLevel": "DELIVERY"
        }
    },
    "version": 1,
    "processId": "019f5a7f-6ec4-72d8-b21a-f5510a7c8e33",
    "lastModified": "2026-07-13T08:02:08.750Z",
    "created": "2026-07-13T08:02:08.750Z",
    "id": "019f5a7f-6ec4-72d8-b21a-f144b550b615"
}
```

{% endtab %}
{% endtabs %}


# GDPR configuration

As mentioned in the [GDPR section of the Helpful information article](https://docs.fulfillmenttools.com/documentation/about-fulfillmenttools/helpful-information#general-data-protection-regulation-gdpr), fulfillmenttools is GDPR-compliant.

All customer-related data that was needed for the fulfillment process (like names, addresses, and contact details) is anonymized once all evolved entities are operationally in a final state. The exact date for anonymization is configurable via API.

{% hint style="info" %}
This retention time affects all parts of the operational process, including returns, so you should ensure this timeframe includes your return policy date.
{% endhint %}

## Change GDPR configuration

{% hint style="success" %}

#### Prerequisites

* Have an Administrator role
  {% endhint %}

The values of the GDPR configuration are:

* `retentionTime` defines how many days after creation, operationally finished processes are anonymized. Default value: 30 days after the process is operationally finished.
* `deletionTimeAfterRetention` defines when anonymized entities are deleted. Default value: 180 days.

{% hint style="success" %}
This deletion functionality only deletes operational data. The anonymized data is still stored for analytics.
{% endhint %}

To check the current configuration, use the below endpoint:

{% tabs %}
{% tab title="GET endpoint" %}

```http
GET https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/gdpr
```

{% endtab %}

{% tab title="Response body" %}
Below is the default values for all customers:

```json
{
    "retentionTime": 30,
    "deletionTimeAfterRetention": 180,
    "version": 0,
    "id": "gdpr",
    "actorAnonymization": true
}
```

`actorAnonymization: true` means `username` and `userId` are stored anonymized in the audit entry. If set to `false`, the data is written without anonymization.
{% endtab %}
{% endtabs %}

To change the default values, use the below endpoint:

{% tabs %}
{% tab title="PUT endpoint" %}

```http
PUT https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/configurations/gdpr
```

{% endtab %}

{% tab title="Request body" %}

```json
{
    "retentionTime": 15,
    "deletionTimeAfterRetention": 5,
    "actorAnonymization": true,
    "version": 1
}
```

{% hint style="info" %}
Remember to increase the version number from the original number in the `GET` response.
{% endhint %}
{% endtab %}

{% tab title="Response body" %}

```json
{
    "id": "gdpr",
    "version": 2,
    "actorAnonymization": true,
    "created": "2025-12-30T13:01:39.055Z",
    "deletionTimeAfterRetention": 5,
    "lastModified": "2025-12-30T13:01:39.055Z",
    "retentionTime": 15
}
```

{% endtab %}
{% endtabs %}

In the above example, we've set a `retentionTime` of `15` days and a `deletionTimeAfterRetention` of `5` days. If an order is created on `2026-01-01`, the platform calculates:

* Anonymization date: `2026-01-15`
* Deletion date: `2026-01-20`

{% hint style="info" %}
Changes to `actorAnonymization` might take up to an hour to take effect.
{% endhint %}

Once updated, the change will apply retroactively to all orders (including finished orders). It will also recalculate each time you change the setting.


# GDPR configuration endpoints

## The GdprConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"GdprConfiguration":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"actorAnonymization":{"default":true,"description":"If true, the actor information will be stored anonymized for auditing. Might take up to 1 hour to be take into effect","type":"boolean"},"deletionTimeAfterRetention":{"description":"Number of days since anonymization until deletion is triggered","minimum":1,"type":"number"},"id":{"type":"string"},"retentionTime":{"description":"Number of days after that anonymization is triggered.","minimum":1,"type":"number"},"version":{"format":"int64","type":"integer"}},"required":["retentionTime","version"],"type":"object","title":"GdprConfiguration","description":"GdprConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"}}}}
```

## GET /api/configurations/gdpr

> Get GDPR config

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to update and read general configuration of fulfillmenttools.","name":"Configurations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"GdprConfiguration":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"actorAnonymization":{"default":true,"description":"If true, the actor information will be stored anonymized for auditing. Might take up to 1 hour to be take into effect","type":"boolean"},"deletionTimeAfterRetention":{"description":"Number of days since anonymization until deletion is triggered","minimum":1,"type":"number"},"id":{"type":"string"},"retentionTime":{"description":"Number of days after that anonymization is triggered.","minimum":1,"type":"number"},"version":{"format":"int64","type":"integer"}},"required":["retentionTime","version"],"type":"object","title":"GdprConfiguration","description":"GdprConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/gdpr":{"get":{"description":"","operationId":"getGdprConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GdprConfiguration"}}},"description":"Gdpr configuration was found & you were allowed to access it. The result is in the body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Gdpr configuration not found"}},"summary":"Get GDPR config","tags":["Configurations"]}}}}
```

## PUT /api/configurations/gdpr

> Update GDPR config

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to update and read general configuration of fulfillmenttools.","name":"Configurations"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"GdprConfiguration":{"additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/VersionedResource"}],"properties":{"actorAnonymization":{"default":true,"description":"If true, the actor information will be stored anonymized for auditing. Might take up to 1 hour to be take into effect","type":"boolean"},"deletionTimeAfterRetention":{"description":"Number of days since anonymization until deletion is triggered","minimum":1,"type":"number"},"id":{"type":"string"},"retentionTime":{"description":"Number of days after that anonymization is triggered.","minimum":1,"type":"number"},"version":{"format":"int64","type":"integer"}},"required":["retentionTime","version"],"type":"object","title":"GdprConfiguration","description":"GdprConfiguration"},"VersionedResource":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["version"],"type":"object","title":"VersionedResource","description":"VersionedResource"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/configurations/gdpr":{"put":{"description":"","operationId":"putGdprConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GdprConfiguration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GdprConfiguration"}}},"description":"Gdpr configuration was written successfully"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Gdpr configuration not found"}},"summary":"Update GDPR config","tags":["Configurations"]}}}}
```


# Audits

The audit logs in fulfillmenttools ensure transparency and security. The logs track which user performed an operation and when it occurred, providing a clear history of modifications to entities. This function is implemented for numerous entities, including `pick job`, `handover job`, `facility`, `parcel`, and `stow job`.

{% hint style="warning" %}
Audits are anonymized by default to conform with GDPR regulations. This behavior can be changed via the [GDPR API](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/configurations/gdpr) by setting the `actorAnonymization` parameter to `false`. **Changes to this value may take up to an hour to take effect.**
{% endhint %}

## Retrieving audits

Retrieve audit logs by making a request to the following endpoint.

```http
GET https://ocff-{projectId}.api.fulfillmenttools.com/api/audits
```

The response can be narrowed down using filter parameters. For a complete list of available parameters, refer to the [Audit endpoint documentation in the REST API reference](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/audits). The API returns a list of audit entries, structured as shown in the example below:

```json
{
    "id": "67a1bf95bdcc1ede1ea1447d",
    "entityRef": "e4de35b3-6662-46b9-a9ad-e17ccc0f0168",
    "entityType": "PACK_JOB",
    "entityVersion": 1,
    "entityCreated": "2025-02-04T07:19:35.329Z",
    "eventId": "32566960-aa0f-4942-90af-b1ffe0d02f37",
    "anonymizationDate": "2025-03-06T07:19:35.329Z",
    "deletionDate": "2025-09-02T07:19:35.329Z",
    "isAnonymized": false,
    "version": 1,
    "trace": "1fb1eee25abf25660fd24a49aa27cebf",
    "actor": {
        "id": "NtwfRbu82fMPQspHkOdvv5UeLK83",
        "details": {
            "username": "user@ocff-tenant.com"
        }
    },
    "globalActor": {
        "id": "NtwfRbu82rrrQspHkOdYR5UeLK83",
        "details": {
            "username": "user@ocff-tenant.com"
        }
    },
    "operation": {
        "name": "POST /api/packjobs/",
        "start": "2025-02-04T07:19:35.153Z"
    },
    "client": {
        "api": "http",
        "rawInfo": "PostmanRuntime/7.43.0"
    },
    "lastModified": "2025-02-04T07:19:49.794Z",
    "created": "2025-02-04T07:19:49.794Z"
}
```

## Actor

Two types of actors are available: the `globalActor` and the `actor`. A single user interaction, such as creating an order, can result in multiple audit entries for different processes, like the creation of a `routing plan` and a `pick job`.

The `globalActor` always represents the original initiator of the interaction, for example, the API user who created the order.

The `actor` represents the direct initiator of the specific audited operation. For a subsequent process triggered by the system, this might be a fulfillmenttools technical user, such as `order-created_event-v1`.


# Audits endpoints

## The AuditSearchPayload object

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"AuditSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/AuditSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/AuditSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"AuditSearchPayload","type":"object","description":"AuditSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"AuditSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/AuditSearchQuery"},"maxItems":500,"type":"array"},"entityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by entityRef"},"entityType":{"allOf":[{"$ref":"#/components/schemas/AuditedEntityTypeEnumFilter"}],"description":"Search by entityType"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/AuditSearchQuery"},"maxItems":500,"type":"array"},"trace":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by trace"}},"title":"AuditSearchQuery","type":"object","description":"AuditSearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"AuditedEntityTypeEnumFilter":{"properties":{"eq":{"description":"Search by entityType","enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB","EXPORT"],"type":"string"},"in":{"description":"Search by entityType","items":{"enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB","EXPORT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by entityType","enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB","EXPORT"],"type":"string"}},"title":"AuditedEntityTypeEnumFilter","type":"object","description":"AuditedEntityTypeEnumFilter"},"AuditSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"}},"title":"AuditSort","type":"object","description":"AuditSort"}}}}
```

## List audits (search)

> This part of the API is in Beta status. For details, see the \<a href="<https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview>" target="\_blank">API release lifecycle documentation\</a>.\<br />\<br />Search for Audit

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to help determine who did what when.","name":"Audits"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AuditSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"allOf":[{"$ref":"#/components/schemas/SearchOptions"}],"description":"Additional options for the search request."},"query":{"$ref":"#/components/schemas/AuditSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/AuditSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"AuditSearchPayload","type":"object","description":"AuditSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"AuditSearchQuery":{"properties":{"and":{"description":"Matches if all of the given queries match. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/AuditSearchQuery"},"maxItems":500,"type":"array"},"entityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by entityRef"},"entityType":{"allOf":[{"$ref":"#/components/schemas/AuditedEntityTypeEnumFilter"}],"description":"Search by entityType"},"or":{"description":"Matches if at least one of the given queries matches. Combined with the other filters on the same level by AND. Can be nested.","items":{"$ref":"#/components/schemas/AuditSearchQuery"},"maxItems":500,"type":"array"},"trace":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by trace"}},"title":"AuditSearchQuery","type":"object","description":"AuditSearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"description":"Matches all values not equal to the given value, including entities where the field is not set","maxLength":256,"type":"string"},"notIn":{"description":"Matches all values not contained in the given list, including entities where the field is not set","items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"AuditedEntityTypeEnumFilter":{"properties":{"eq":{"description":"Search by entityType","enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB","EXPORT"],"type":"string"},"in":{"description":"Search by entityType","items":{"enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB","EXPORT"],"type":"string"},"maxItems":500,"type":"array"},"notEq":{"description":"Search by entityType","enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB","EXPORT"],"type":"string"}},"title":"AuditedEntityTypeEnumFilter","type":"object","description":"AuditedEntityTypeEnumFilter"},"AuditSort":{"properties":{"created":{"enum":["ASC","DESC"],"type":"string"}},"title":"AuditSort","type":"object","description":"AuditSort"},"AuditPaginatedResult":{"properties":{"audits":{"items":{"$ref":"#/components/schemas/Audit"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","audits"],"title":"AuditPaginatedResult","type":"object","description":"AuditPaginatedResult"},"Audit":{"properties":{"actor":{"$ref":"#/components/schemas/AuditActor"},"additionalInfo":{"allOf":[{"$ref":"#/components/schemas/AuditAdditionalInfo"}],"description":"Additional information about the audited operation"},"anonymizationDate":{"format":"date-time","type":"string"},"client":{"$ref":"#/components/schemas/AuditClient"},"created":{"description":"Creation date of the entity, auto-generated if not provided","format":"date-time","type":"string"},"deletionDate":{"format":"date-time","type":"string"},"entityCreated":{"format":"date-time","type":"string"},"entityRef":{"type":"string"},"entityType":{"enum":["PACK_JOB","PICK_JOB","PICK_RUN","HANDOVER_JOB","SHIPMENT","PARCEL","CUSTOM_SERVICE","SERVICE_JOB","LINKED_SERVICE_JOBS","ORDER","ROUTING_PLAN","FACILITY","FACILITY_GROUP","FACILITY_CARRIER_CONNECTION","FACILITY_CUSTOM_SERVICE","ROUTING_STRATEGY","STOW_JOB","EXPORT"],"type":"string"},"entityVersion":{"type":"number"},"eventId":{"type":"string"},"globalActor":{"$ref":"#/components/schemas/AuditActor"},"id":{"type":"string"},"isAnonymized":{"type":"boolean"},"lastModified":{"description":"Service-generated last modification date of the entity","format":"date-time","type":"string"},"operation":{"$ref":"#/components/schemas/AuditOperation"},"trace":{"type":"string"},"version":{"description":"The version of the entity, used for optimistic locking mechanisms","type":"number"}},"required":["id","eventId","entityRef","entityType","entityVersion","isAnonymized","entityCreated","deletionDate","anonymizationDate","trace","actor","globalActor","client","operation","version"],"title":"Audit","type":"object","description":"Audit"},"AuditActor":{"properties":{"details":{"$ref":"#/components/schemas/AuditActorDetails"},"id":{"type":"string"}},"required":["id","details"],"title":"AuditActor","type":"object","description":"AuditActor"},"AuditActorDetails":{"properties":{"topic":{"type":"string"},"username":{"type":"string"}},"required":["topic","username"],"title":"AuditActorDetails","type":"object","description":"AuditActorDetails"},"AuditAdditionalInfo":{"properties":{"export":{"allOf":[{"$ref":"#/components/schemas/AuditExportInfo"}],"description":"Only present for audits of entity type EXPORT"}},"title":"AuditAdditionalInfo","type":"object","description":"AuditAdditionalInfo"},"AuditExportInfo":{"properties":{"rowCount":{"description":"The number of exported rows","minimum":0,"type":"number"},"type":{"description":"The query the export is derived from","enum":["PROCESS_AGGREGATE"],"type":"string"},"usedConfiguration":{"additionalProperties":true,"description":"The configuration the export was created with. Removed when the audit is anonymized","type":"object"}},"required":["type","rowCount"],"title":"AuditExportInfo","type":"object","description":"AuditExportInfo"},"AuditClient":{"properties":{"api":{"type":"string"},"rawInfo":{"type":"string"}},"required":["api","rawInfo"],"title":"AuditClient","type":"object","description":"AuditClient"},"AuditOperation":{"properties":{"name":{"type":"string"},"start":{"format":"date-time","type":"string"}},"required":["name","start"],"title":"AuditOperation","type":"object","description":"AuditOperation"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/audits/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details, see the <a href=\"https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview\" target=\"_blank\">API release lifecycle documentation</a>.<br /><br />Search for Audit","operationId":"searchAudit","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List audits (search)","tags":["Audits"]}}}}
```


# Advanced Order Routing

Our Advanced Order Routing pillar ensures the optimal allocation of customer orders to fulfillment locations based on configurable rules and our pack-first routing algorithm. You can manage accepted orders manually or automatically based on customizable configurations.

Dynamic routing in fulfillmenttools finds the best option (facility) to fulfill an order. You can define multiple factors that should be considered when making the decision for the best fulfillment location.

The order routing can receive orders and order requests from any commerce channel and decides from where and how they can be fulfilled best, taking various flexible and configurable routing rules into account. If no fixed facility is defined where the order has to be fulfilled, fulfillmenttools determines which facility is the best fit for fulfilling an order.

fulfillmenttools lets you define fences and ratings:

* [**Fences**](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/fences): Exclude facilities from order routing according to the fences selected
* [**Ratings**](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/ratings): Weigh facilities against each other according to the ratings selected

## Routing plan

The routing plan is the main routing entity. It can be seen as a vehicle that informs and enables the fulfillment process (like picking) about the routing decision.

The routing plan contains all information relevant to orchestrating an order, such as ordered items or delivery preferences. Ultimately, the routing plan contains the result(s) of the routing decision.

{% hint style="info" %}
More information about the routing plans can be found in the [routing plans REST API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/routingplans).
{% endhint %}

### Difficulties while routing

It's possible that an order couldn't be routed, for example, because all available facilities don't pass a fence. In that case, the order is retried whenever another order is passed to the routing. After a configurable amount of time, such an order is set to an "unroutable" state if it could not be routed to any facility beforehand. The default is set to 8 hours.

{% hint style="info" %}
More information on unroutable orders can be found in the [Unroutable orders article](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/unroutable-orders).
{% endhint %}

### Examples of routing decisions for an order

An order can be assigned directly to a facility:

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2F82seNCSyhJJt16eJHHKp%2FOrder%20directly%20assigned%20to%20a%20facility.png?alt=media&amp;token=c7b7dca9-40de-42f5-bb99-9b1eedbf5e5d" alt="" width="375"><figcaption></figcaption></figure>

An order can be split and assigned to multiple facilities:

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FAGVjeAY0wrW9ueMA2RCL%2FOrder%20split%20to%20multiple%20facilities.png?alt=media&amp;token=4eecf76d-afa5-41c8-84f6-b75494407131" alt="" width="375"><figcaption></figcaption></figure>

An order can become unroutable:

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FeVEsHHqkTO9Hcpxd0Wv3%2FUnroutable%20order.png?alt=media&amp;token=34086eae-5b90-49a5-9455-85286ec24b76" alt="" width="375"><figcaption></figcaption></figure>

An order might have to wait for routing:

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FHBvoItyvciKTbqZoFCYZ%2FOrder%20waiting%20for%20routing.png?alt=media&amp;token=8b0d77b9-adce-4727-b664-98bc183fc520" alt="" width="375"><figcaption></figcaption></figure>

An order can be routed but be locked to avoid direct fulfillment:

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FhhcrBBBiR5VlZb6oD7cr%2FLocked%20order.png?alt=media&amp;token=3e09d4d3-6030-4f34-935c-6fc8ab85fca3" alt="" width="375"><figcaption></figcaption></figure>

An order can have a mixture of the above decisions:

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2FqBb7HA6Wa52NleeDFlq1%2FOrder%20with%20mixture%20of%20decisions.png?alt=media&amp;token=73710b8b-d530-43b1-a543-1bcd32f3d541" alt="" width="375"><figcaption></figcaption></figure>

fulfillmenttools routes orders to the optimal facility for fulfillment using a combination of fences (mandatory criteria) and ratings (preference criteria) to determine the best facility.

Historically, routing was based on static rulesets. fulfillmenttools enables these rules to be dynamic, allowing fulfillmenttools to select the most suitable facility at the moment of routing.

## Fences

Fences function as filters, removing facilities that don't match defined criteria. For example, a tenant, LU.XY, wants to ensure that the service type requested in an order matches the service type offered by the facility. Additionally, they are connected to a marketplace that preselects which facilities LU.XY can use for fulfillment.

To handle this, the following fences must be enabled:

* Service type
* Preselected facilities

## Ratings

After fulfillmenttools applies fences, a subset of facilities remains. Without ratings, fulfillmenttools would randomly assign a pick job to an eligible facility. Ratings let fulfillmenttools score each remaining facility to determine the best option for a given pick job.

In the LU.XY example, the business prefers the facility that is closest to the customer and offers the fastest delivery. Since employee performance is measured by Key Performance Indicators (KPIs), the workload should also be balanced across facilities. Furthermore, stores are categorized as "A stores" and "B stores." A stores have high foot traffic from walk-in customers, so online orders should be preferentially routed to B stores.

To achieve this, the following ratings are applied:

* Geodistance
* Workload balancing
* A custom rating based on facility tags

The details of these ratings are explained below. To maximize fulfillment potential, order splitting is also activated in the routing ruleset.

## Standard routing rules

{% hint style="info" %}
For more details, see the [Routing strategies API documentation](broken://pages/9f8966dfaaec99d4ef9b933bdfc2b2ace7f15641).
{% endhint %}

To begin configuring routing options, first retrieve the current ruleset with a `GET` request.

```http
GET https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/routing/strategies
```

<details>

<summary><code>200 OK</code> response</summary>

```json
{
    "version": 13,
    "created": "2023-07-10T12:55:06.393Z",
    "globalRoutingConfiguration": {
        "defaultPrice": 10
    },
    "lastModified": "2024-01-30T10:05:20.077Z",
    "prioritizationRules": [],
    "routingRule": {
        "fences": [
            {
                "implementation": "FACILITY-BUSINESSTYPE",
                "active": false,
                "id": "07573113-10b1-44d9-b9ea-28c343684a32",
                "name": "Service type",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Facilities that do not support the service type required by an order are not taken into consideration when performing an order routing."
            },
            {
                "implementation": "STOCK-AVAILABILITY",
                "active": false,
                "id": "d98effb6-cf9f-4aeb-889f-9b1e876463ac",
                "name": "Complete stock",
                "supportedModes": [
                    "static",
                    "reactive"
                ],
                "activeMode": "static",
                "description": "Facilities that do not have all ordered items in stock are not taken into consideration when performing an order routing."
            },
            {
                "implementation": "FACILITY-CARRIERAVAILABILITY",
                "active": false,
                "id": "5e0d9990-331f-407c-9b50-d6ba73e2bdc0",
                "name": "Carrier availability",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Facilities that do not support a specific carrier which has been requested by a customer are not taken into consideration when performing an order routing."
            },
            {
                "implementation": "FACILITY-COUNTRY",
                "active": false,
                "id": "8a23fd25-9023-45bf-8aab-3c56c24ba2e5",
                "name": "Country borders",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Cross-country routing is prevented."
            },
            {
                "implementation": "FACILITY-PICKING-TIME-CAPACITY",
                "active": false,
                "id": "33c5ff6d-a0a1-4b91-be2c-a49c72d0d196",
                "name": "Facility capacity",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Facilities, for which the maximum amount of orders that can be fulfilled has been exceeded are not taken into consideration when performing an order routing."
            },
            {
                "implementation": "PRESELECTED-FACILITY",
                "active": true,
                "id": "a68c4f4e-dd31-4eb2-917b-d21f18150008",
                "name": "Preselected facilities",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Facilities that are not specified in a predefined list are not taken into consideration when performing an order routing."
            },
            {
                "implementation": "SAMEDAY-POSSIBLE",
                "active": false,
                "id": "204899bb-1247-45c2-a26f-aae4761b7ec5",
                "name": "Same Day delivery possible",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Facilities that cannot ensure a same day delivery are not taken into consideration when performing an order routing."
            }
        ],
        "ratings": [
            {
                "implementation": "STOCK-BALANCING",
                "active": false,
                "id": "de855bab-b318-4815-8a71-a26658ebd4e9",
                "name": "Stock balancing",
                "maxPenalty": 0,
                "description": "Facilities that have high stock levels of the ordered items are favored by this rating."
            },
            {
                "implementation": "GEO-DISTANCE",
                "active": false,
                "id": "07bceadb-95ed-49f0-aa3c-73816ba17fc4",
                "name": "Geodistance",
                "maxPenalty": 0,
                "description": "Facilities that are nearby a consumer are favored by this rating."
            },
            {
                "implementation": "TURNOVER",
                "active": false,
                "id": "bd9d5cb8-2d2b-4698-b7f2-7e2b67fe5c8e",
                "name": "Maximizing turnover",
                "maxPenalty": 0,
                "description": "Facilities that generate the highest turnover based on what the customer has ordered are favored by this rating."
            },
            {
                "implementation": "STOCK-AVAILABILITY",
                "active": false,
                "id": "a7eed71c-ee15-4f04-8d99-74cab2c31de8",
                "name": "Stock availability",
                "maxPenalty": 0,
                "description": "Facilities that have the highest amount of items in stock that are ordered by a customer are favored by this rating."
            },
            {
                "implementation": "WORKLOAD-BALANCING",
                "active": false,
                "id": "296b8469-2e54-440a-a793-c38514755394",
                "name": "Workload balancing",
                "maxPenalty": 0,
                "description": "Facilities that have a low workload while performing a routing decision are favored by this rating."
            },
            {
                "implementation": "MATCHING-BUSINESSTYPE",
                "active": false,
                "id": "c2207eb3-5cf5-491c-b4bd-d148d5e9b97b",
                "name": "Matching service type",
                "maxPenalty": 0,
                "description": "Facilities that have the same service type as requested in the order are favored by this rating."
            },
            {
                "implementation": "PREFER-STORE",
                "active": false,
                "id": "68f870f0-f379-466f-83d5-6ee565bf6506",
                "name": "Prefer stores",
                "maxPenalty": 0,
                "description": "Facilities that have the facility type store are favored by this rating."
            },
            {
                "implementation": "PREFER-WAREHOUSE",
                "active": false,
                "id": "ba888667-b678-4af4-bcad-eee92c92bea7",
                "name": "Prefer warehouses",
                "maxPenalty": 0,
                "description": "Facilities that have the facility type warehouse are favored by this rating."
            },
            {
                "implementation": "ZONE",
                "active": false,
                "id": "34975c54-7ee2-41cd-b0ce-e15d0fa2b2dc",
                "name": "Stocks in preferred zone",
                "maxPenalty": 0,
                "description": "Facilities where the ordered inventory is located in a preferred zone are given priority in routing."
            },
            {
                "implementation": "EXPIRY-DATE",
                "active": false,
                "id": "1d908d52-b1ac-42ba-a81b-23e66396f6f4",
                "name": "Expiration/Best-before date",
                "maxPenalty": 0,
                "description": "Facilities where demanded inventory has a shorter expiration date are given priority in routing. Markdowns are reduced as a result."
            },
            {
                "implementation": "CAPACITY",
                "active": false,
                "id": "8fa06ea4-eb88-473b-89bc-84c0382e97d0",
                "name": "Capacity",
                "maxPenalty": 0,
                "description": "Facilities where capacity for fulfillment is available in a timely manner are given priority in routing."
            },
            {
                "implementation": "DELIVERY-COSTS",
                "active": false,
                "id": "b134593a-6e90-4214-ad17-66014186b2ce",
                "name": "Lowest delivery fee",
                "maxPenalty": 0,
                "description": "TODO"
            },
            {
                "implementation": "DELIVERY-TIME",
                "active": false,
                "id": "22c92c9c-2766-41e7-a2df-f6299022bb9a",
                "name": "Fastest delivery speed",
                "maxPenalty": 0,
                "description": "TODO"
            }
        ],
        "orderSplit": {
            "active": false,
            "orderSplitType": "FIXED_COUNT"
        }
    }
}
```

</details>

* `globalRoutingConfiguration.defaultPrice`: This value is used for the `Maximizing turnover` rating. It should be a standard value for the industry (e.g., 100 EUR for fashion, 500 EUR for electronics).
* `prioritizationRules`: This is a legacy field that is no longer used.
* `routingRule.fences`: This array lists all available standard `fences`. To activate a fence, use the properties `id`, `active` and `activeMode`.
* `routingRule.ratings`: This array lists all standard `ratings`. The `maxPenalty` property defines the weight of each rating in the routing decision. A higher `maxPenalty` gives the rating more importance. While the Backoffice UI limits this value to a range of 1 to 10, the API allows higher values.
* `orderSplit`: This object controls whether order splitting is active.

For this use case, activate `orderSplit` and the required fences. The `ratings` will be weighted as follows:

* `GEO-DISTANCE`: 1
* `WORKLOAD-BALANCING`: 4

Apply the desired rules by sending a `PATCH` request to the routing configuration endpoint.

<details>

<summary><code>PATCH https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/routing</code></summary>

```json
{
  "version": 13,
  "actions": [
    {
      "action": "ModifyOrderSplit",
      "active": true
    },
    {
      "action": "ModifyFence",
      "id": "07573113-10b1-44d9-b9ea-28c343684a32",
      "active": true,
      "activeMode": "static"
    },
    {
      "action": "ModifyFence",
      "id": "a68c4f4e-dd31-4eb2-917b-d21f18150008",
      "active": true,
      "activeMode": "static"
    },
    {
      "action": "ModifyRating",
      "id": "07bceadb-95ed-49f0-aa3c-73816ba17fc4",
      "maxPenalty": 1
    },
    {
      "action": "ModifyRating",
      "id": "296b8469-2e54-440a-a793-c38514755394",
      "maxPenalty": 4
    }
  ]
}
```

</details>

<details>

<summary><code>200 OK</code> response</summary>

```json
{
    "id": "routing",
    "version": 14,
    "created": "2023-07-10T12:55:06.393Z",
    "globalRoutingConfiguration": {
        "defaultPrice": 10
    },
    "lastModified": "2024-01-31T12:48:35.274Z",
    "prioritizationRules": [],
    "routingRule": {
        "fences": [
            {
                "implementation": "FACILITY-BUSINESSTYPE",
                "active": true,
                "id": "07573113-10b1-44d9-b9ea-28c343684a32",
                "name": "Service type",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Facilities that do not support the service type required by an order are not taken into consideration when performing an order routing."
            },
            {
                "implementation": "STOCK-AVAILABILITY",
                "active": false,
                "id": "d98effb6-cf9f-4aeb-889f-9b1e876463ac",
                "name": "Complete stock",
                "supportedModes": [
                    "static",
                    "reactive"
                ],
                "activeMode": "static",
                "description": "Facilities that do not have all ordered items in stock are not taken into consideration when performing an order routing."
            },
            {
                "implementation": "FACILITY-CARRIERAVAILABILITY",
                "active": false,
                "id": "5e0d9990-331f-407c-9b50-d6ba73e2bdc0",
                "name": "Carrier availability",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Facilities that do not support a specific carrier which has been requested by a customer are not taken into consideration when performing an order routing."
            },
            {
                "implementation": "FACILITY-COUNTRY",
                "active": false,
                "id": "8a23fd25-9023-45bf-8aab-3c56c24ba2e5",
                "name": "Country borders",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Cross-country routing is prevented."
            },
            {
                "implementation": "FACILITY-PICKING-TIME-CAPACITY",
                "active": false,
                "id": "33c5ff6d-a0a1-4b91-be2c-a49c72d0d196",
                "name": "Facility capacity",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Facilities, for which the maximum amount of orders that can be fulfilled has been exceeded are not taken into consideration when performing an order routing."
            },
            {
                "implementation": "PRESELECTED-FACILITY",
                "active": true,
                "id": "a68c4f4e-dd31-4eb2-917b-d21f18150008",
                "name": "Preselected facilities",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Facilities that are not specified in a predefined list are not taken into consideration when performing an order routing."
            },
            {
                "implementation": "SAMEDAY-POSSIBLE",
                "active": false,
                "id": "204899bb-1247-45c2-a26f-aae4761b7ec5",
                "name": "Same Day delivery possible",
                "supportedModes": [
                    "static"
                ],
                "activeMode": "static",
                "description": "Facilities that cannot ensure a same day delivery are not taken into consideration when performing an order routing."
            }
        ],
        "ratings": [
            {
                "implementation": "STOCK-BALANCING",
                "active": false,
                "id": "de855bab-b318-4815-8a71-a26658ebd4e9",
                "name": "Stock balancing",
                "maxPenalty": 0,
                "description": "Facilities that have high stock levels of the ordered items are favored by this rating."
            },
            {
                "implementation": "GEO-DISTANCE",
                "active": false,
                "id": "07bceadb-95ed-49f0-aa3c-73816ba17fc4",
                "name": "Geodistance",
                "maxPenalty": 1,
                "description": "Facilities that are nearby a consumer are favored by this rating."
            },
            {
                "implementation": "TURNOVER",
                "active": false,
                "id": "bd9d5cb8-2d2b-4698-b7f2-7e2b67fe5c8e",
                "name": "Maximizing turnover",
                "maxPenalty": 0,
                "description": "Facilities that generate the highest turnover based on what the customer has ordered are favored by this rating."
            },
            {
                "implementation": "STOCK-AVAILABILITY",
                "active": false,
                "id": "a7eed71c-ee15-4f04-8d99-74cab2c31de8",
                "name": "Stock availability",
                "maxPenalty": 0,
                "description": "Facilities that have the highest amount of items in stock that are ordered by a customer are favored by this rating."
            },
            {
                "implementation": "WORKLOAD-BALANCING",
                "active": false,
                "id": "296b8469-2e54-440a-a793-c38514755394",
                "name": "Workload balancing",
                "maxPenalty": 4,
                "description": "Facilities that have a low workload while performing a routing decision are favored by this rating."
            },
            {
                "implementation": "MATCHING-BUSINESSTYPE",
                "active": false,
                "id": "c2207eb3-5cf5-491c-b4bd-d148d5e9b97b",
                "name": "Matching service type",
                "maxPenalty": 0,
                "description": "Facilities that have the same service type as requested in the order are favored by this rating."
            },
            {
                "implementation": "PREFER-STORE",
                "active": false,
                "id": "68f870f0-f379-466f-83d5-6ee565bf6506",
                "name": "Prefer stores",
                "maxPenalty": 0,
                "description": "Facilities that have the facility type store are favored by this rating."
            },
            {
                "implementation": "PREFER-WAREHOUSE",
                "active": false,
                "id": "ba888667-b678-4af4-bcad-eee92c92bea7",
                "name": "Prefer warehouses",
                "maxPenalty": 0,
                "description": "Facilities that have the facility type warehouse are favored by this rating."
            },
            {
                "implementation": "ZONE",
                "active": false,
                "id": "34975c54-7ee2-41cd-b0ce-e15d0fa2b2dc",
                "name": "Stocks in preferred zone",
                "maxPenalty": 0,
                "description": "Facilities where the ordered inventory is located in a preferred zone are given priority in routing."
            },
            {
                "implementation": "EXPIRY-DATE",
                "active": false,
                "id": "1d908d52-b1ac-42ba-a81b-23e66396f6f4",
                "name": "Expiration/Best-before date",
                "maxPenalty": 0,
                "description": "Facilities where demanded inventory has a shorter expiration date are given priority in routing. Markdowns are reduced as a result."
            },
            {
                "implementation": "CAPACITY",
                "active": false,
                "id": "8fa06ea4-eb88-473b-89bc-84c0382e97d0",
                "name": "Capacity",
                "maxPenalty": 0,
                "description": "Facilities where capacity for fulfillment is available in a timely manner are given priority in routing."
            },
            {
                "implementation": "DELIVERY-COSTS",
                "active": false,
                "id": "b134593a-6e90-4214-ad17-66014186b2ce",
                "name": "Lowest delivery fee",
                "maxPenalty": 0,
                "description": "TODO"
            },
            {
                "implementation": "DELIVERY-TIME",
                "active": false,
                "id": "22c92c9c-2766-41e7-a2df-f6299022bb9a",
                "name": "Fastest delivery speed",
                "maxPenalty": 0,
                "description": "TODO"
            }
        ],
        "orderSplit": {
            "active": true,
            "orderSplitType": "FIXED_COUNT",
            "activeForSameDay": false,
            "fixedCountConfiguration": {
                "maxSplitCount": 1
            }
        }
    }
}
```

</details>

## Facility rating

The facility rating is implemented using a `tag`. First, a tag definition must be created before it can be assigned to a facility.

{% hint style="info" %}
For more details, see the [Tags API documentation](https://fulfillmenttools.github.io/fulfillmenttools-api-reference-ui/#get-/api/tags).
{% endhint %}

<details>

<summary><code>POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/tags</code></summary>

```json
{
  "id": "facilityRating",
  "allowedValues": [
    "A",
    "B"
  ]
}
```

</details>

<details>

<summary><code>201 CREATED</code> response</summary>

```json
{
    "id": "facilityRating",
    "allowedValues": [
        "A",
        "B"
    ],
    "version": 1,
    "created": "2024-01-30T14:58:24.468Z",
    "lastModified": "2024-01-30T14:58:24.468Z"
}
```

</details>

Next, assign this tag to a facility using a `PATCH` request to the facility endpoint.

<details>

<summary><code>PATCH https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/facilities/{FACILITY-ID}</code></summary>

```json
{
    "version": 3,
    "actions": [
        {
            "action": "ModifyFacility",
            "tags": [
                {
                    "id": "facilityRating",
                    "value": "B"
                }
            ]
        }
    ]
}
```

</details>

The API responds with `200 OK` and the complete facility object.

<details>

<summary><code>200 OK</code> response</summary>

```json
{
    "name": "LU.XY Fashion flagship store",
    "address": {
        "companyName": "lu.xy fashion GmbH",
        "country": "DE",
        "postalCode": "60316",
        "city": "Frankfurt",
        "street": "Sandweg",
        "houseNumber": "61",
        "phoneNumbers": [
            {
                "value": "+49 69 580775",
                "type": "PHONE",
                "label": "Landline"
            }
        ],
        "emailAddresses": [
            {
                "value": "lu.xy.flagship.FRA1@example.com",
                "recipient": "LU.XY Frankfurt 1"
            }
        ],
        "resolvedCoordinates": {
            "lon": 8.69702981904918,
            "lat": 50.1203720202354
        },
        "resolvedTimeZone": {
            "offsetInSeconds": 3600,
            "timeZoneId": "Europe/Berlin",
            "timeZoneName": "W. Europe Standard Time"
        }
    },
    "locationType": "STORE",
    "tenantFacilityId": "1",
    "status": "ONLINE",
    "services": [
        {
            "type": "SHIP_FROM_STORE"
        },
        {
            "type": "PICKUP"
        }
    ],
    "pickingTimes": {
        "monday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 20
            }
        ],
        "tuesday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 20
            }
        ],
        "wednesday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 20
            }
        ],
        "thursday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 20
            }
        ],
        "friday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 15
            }
        ],
        "saturday": [
            {
                "start": {
                    "hour": 8,
                    "minute": 0
                },
                "end": {
                    "hour": 17,
                    "minute": 0
                },
                "capacity": 10
            }
        ]
    },
    "fulfillmentProcessBuffer": 240,
    "capacityEnabled": false,
    "pickingMethods": null,
    "created": "2023-11-14T15:26:43.165Z",
    "lastModified": "2024-01-30T15:06:30.562Z",
    "version": 4,
    "id": "d286e108-698b-4f6c-97b7-21f090f17e46",
    "tags": [
        {
            "id": "facilityRating",
            "value": "B"
        }
    ]
}
```

</details>

## Custom routing rules

If the standard routing configurations do not meet specific business needs, you can create custom routing rules. For the LU.XY use case, a custom rating is needed to prefer certain facilities.

Custom routing rules compare attributes between two entities, such as an `order`, a `facility`, or a `carrierconnection`. A typical rule compares an attribute on the `order` with an attribute on the `facility`.

In this example, the goal is to create a rating that applies to all orders and prefers facilities tagged as "B-stores".

* The `order` side of the rule will check for a property that is always present, such as the `order.id`, to ensure it applies universally.
* The `facility` side of the rule will check if the `facilityRating` tag has a value of `B`.

A `maxPenalty` of 40 is recommended to give this rating a high weight.

{% hint style="info" %}
For more details, see the [Routing strategy API documentation](https://docs.fulfillmenttools.com/documentation/apis/api-reference/routing-strategies).
{% endhint %}

<details>

<summary><code>POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/routing/toolkit/ratings</code></summary>

```json
{
    "entity1": "ORDER",
    "entity2": "FACILITY",
    "active": true,
    "name": "Prefer B Stores",
    "nameLocalized": {
        "de_DE": "Bevorzuge B-Filialen",
        "en_UK": "Prefer B-Stores"
    },
    "description": "Prefer B Stores for all orders",
    "rule": {
        "operator": "EQUALS",
        "leftPart": {
            "predicates": [
                {
                    "entityOperator": "VALUE_NOT_EQUALS",
                    "expectedValue": " ",
                    "propertyPath": "$.id"
                }
            ]
        },
        "rightPart": {
            "predicates": [
                {
                    "entityOperator": "EVERY_VALUE_EQUALS",
                    "expectedValue": "B",
                    "propertyPath": "$.tags[?(@.id === \"facilityRating\")].value"
                }
            ]
        }
    },
    "maxPenalty": 10
}
```

</details>

<details>

<summary><code>201 CREATED</code> response</summary>

```json
{
    "entity1": "ORDER",
    "entity2": "FACILITY",
    "active": true,
    "name": "Prefer B Stores",
    "nameLocalized": {
        "de_DE": "Bevorzuge B-Filialen",
        "en_UK": "Prefer B-Stores"
    },
    "description": "Prefer B Stores for all orders",
    "rule": {
        "operator": "EQUALS",
        "leftPart": {
            "predicates": [
                {
                    "entityOperator": "VALUE_NOT_EQUALS",
                    "expectedValue": " ",
                    "propertyPath": "$.id"
                }
            ],
            "predicateConnector": "AND"
        },
        "rightPart": {
            "predicates": [
                {
                    "entityOperator": "EVERY_VALUE_EQUALS",
                    "expectedValue": "B",
                    "propertyPath": "$.tags[?(@.id === \"facilityRating\")].value"
                }
            ],
            "predicateConnector": "AND"
        }
    },
    "maxPenalty": 10,
    "created": "2024-01-31T14:18:52.255Z",
    "lastModified": "2024-01-31T14:18:52.255Z",
    "version": 1,
    "id": "c1104460-4bd2-4082-b4b1-53d1b2787171"
}
```

</details>

Additional rules can be created for other store ratings (for example, A stores, B stores, and C stores). A separate API call is required for each custom rule.

{% hint style="info" %}
Our Advanced Order Routing is a powerful and complex feature. For further assistance with advanced routing configurations, contact our Support team.
{% endhint %}


# Fences

A fence can be part of the routing rules and is required for a routing decision. If a facility can't meet the requirements of an order, the facility is excluded from the routing decision. This can lead to a situation in which no facility can meet the order's requirements. If this is the case, the order is returned to the pool and either included in upcoming routing decisions or deemed [unroutable](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/unroutable-orders).

{% hint style="info" %}
See the [Routing strategy API documentation](https://docs.fulfillmenttools.com/documentation/apis/api-reference/routing-strategies).
{% endhint %}

A fence can be static or reactive.

A static fence has no event trigger. If an order becomes [unroutable](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/unroutable-orders) because of a static fence, this order will remain in the unroutable order section.

A reactive fence has an event trigger. This means fulfillmenttools constantly checks for events that might dissolve this fence so the order becomes routable.

For now, only the complete stock fence can be set as a reactive fence. If an order becomes unroutable due to an out-of-stock situation and the items are [preorderable or backorderable](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/pre-and-backorders), the order gets routed automatically if stock becomes available.

To determine which reactive fences would have made an order unroutable, fulfillmenttools sorts fences from static to reactive and ensures all reactive fences are processed with all entities.

## Standard fences

fulfillmenttools provides predefined fences. See the table below.

<table><thead><tr><th>Fence</th><th>Description</th><th>Notes</th><th>Fence type<select><option value="rABTXMiL4FjC" label="Reactive" color="blue"></option><option value="kIBll4CxdGzU" label="Static" color="blue"></option></select></th></tr></thead><tbody><tr><td>Complete stock</td><td>Checks if all ordered items are available in the facility. This check already accounts for reservations and other stock that is unavailable for certain reasons.</td><td>The complete stock fence can't be combined with an order split.</td><td><span data-option="rABTXMiL4FjC">Reactive</span></td></tr><tr><td>Service type</td><td>Checks whether the facility can fulfill the order's <a href="https://docs.fulfillmenttools.com/documentation/getting-started/facilities#service-type">service type</a> (ship-from-store standard, ship-from-store same day, or click-and-collect).</td><td></td><td><span data-option="kIBll4CxdGzU">Static</span></td></tr><tr><td>Preselected facilities</td><td>Reduces the facility candidates considered from all facilities in the network to only the specified ones. This list must include at least one facility and applies only to ship-from-store orders.</td><td></td><td><span data-option="kIBll4CxdGzU">Static</span></td></tr><tr><td>Carrier availability</td><td>Checks whether the consumer's chosen carrier is enabled at a given facility and can fulfill the order.</td><td></td><td><span data-option="kIBll4CxdGzU">Static</span></td></tr><tr><td>Same-day delivery possible</td><td>Checks if there is a facility that has the service type ship-from-store and at least one active <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/carrier-management/carrier-features-and-requirements#same-day-delivery">same-day</a> carrier, and whether there is enough time for the facility to perform a same-day delivery.</td><td></td><td><span data-option="kIBll4CxdGzU">Static</span></td></tr><tr><td>Country</td><td>Checks whether the facility's address is in the same country as the consumer's address. Only those facilities are considered.</td><td></td><td><span data-option="kIBll4CxdGzU">Static</span></td></tr><tr><td>Facility capacity</td><td>Checks if there are any free <a href="https://docs.fulfillmenttools.com/documentation/getting-started/facilities#facilities-fulfillmentcapacity">fulfillment capacity slots</a> available for a facility within a predefined future timeframe.</td><td></td><td><span data-option="kIBll4CxdGzU">Static</span></td></tr><tr><td>Ensure minimum picking</td><td>Checks that at least one ordered item is in stock. If not, the facility is excluded from order routing.</td><td>Items bundled so they are not split during routing (see the <a href="https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/custom-services">custom services article</a>) are treated as one in this fence. Meaning that if one item is missing in such a bundle, all items within this bundle are seen as missing.</td><td><span data-option="kIBll4CxdGzU">Static</span></td></tr></tbody></table>


# Ratings

Ratings are used to rank facilities so that the best possible facility for order fulfillment is determined. For each rating, a penalty is applied to all the available facilities. The range of this penalty is 1-10 (where 1 means not important and 10 means very important) and can be defined individually per rating. After considering all ratings during order routing, the facility with the lowest penalty sum is selected for order fulfillment. Ratings are applied after the facilities are filtered out by [fences](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/fences).

{% hint style="info" %}
See the [Routing strategy API endpoints](https://docs.fulfillmenttools.com/documentation/apis/api-reference/routing-strategies) for more.
{% endhint %}

## Standard ratings

### **Geodistance** <a href="#ratings-geodistance" id="ratings-geodistance"></a>

This geodistance rating is two-fold. Within Germany, the rating ranks the facilities nearest to the customer by determining the geographical distance using the coordinates of both zip codes. A lookup table is used that knows all distances for a given zip code to all other existing zip codes. This feature is only available for German zip codes.

Outside of Germany, this rating ranks the facility nearest to the customer like the zip code based rating but enhances it by using geolocation information, e.g., beeline. This fine-tunes the zip code based rating and covers situations where the distance of the center of two zip codes does not accurately represent the reality. This can happen if the tenant has more than one facility within the same zip code or where a facility is located next to the border of a zip code.

{% hint style="info" %}

* In case the address of the consumer is not known and only the country is known, we use the coordinates of the country's capital in order to execute the rating.
* Using the geodistance rating will generate extra costs since it relies on Google Maps.
  {% endhint %}

### **Stock availability** <a href="#ratings-amountofavailablestock" id="ratings-amountofavailablestock"></a>

The stock availability rating ranks facility higher that have a larger number of the ordered items in stock. Only stock that is [available for picking](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability) is used for this rating. Listings without stocks are treated the same way as listings that have a stock level of 0.

After calculating the sum of all available items, the facilities are ranked by this amount.

{% hint style="warning" %}
This does not necessarily mean that a facility can be found that is able to fulfill *all* the requested items by the customer. If this is required, please consider the complete stock fence instead.
{% endhint %}

**Example:**

* customer orders products A(9), B(6), C(3). Sum of all items = 18
* Facility 1 has A(4), B(5), C(1). Sum of all applicable items for the customer's order = 10
* Facility 2 has A(9), B(5), C(1). Sum of all applicable items for the customer's order = 15
* Facility 3 has A(6), B(0), C(20), D(10). Sum of all applicable items for the customer's order = 9 (A(6) + C(3))
* Ranking would be: Facility 2 -> Facility 1 -> Facility 3

{% hint style="info" %}
Items which are [bundled](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/bundled-line-items) so that they are not split within routing (see the [Custom services](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/services/custom-services) article) are considered as one in this rating. Meaning that if one item is missing in a bundle, all items within the bundle are seen as missing.
{% endhint %}

### **Maximizing turnover** <a href="#ratings-maximizingturnover" id="ratings-maximizingturnover"></a>

The maximizing turnover rating calculates the turnover that would be made for an order for each facilities. This is done by multiplying the price of each listing with the amount of the available units of a listing. The more items are available, the higher the potential turnover.

When no facility is able to fulfill all items, it might be more desirable to choose a facility that's able to fulfill the more expensive items.

**Example:**

| Item       | Price | Facility 1 stock | Facility 2 stock |
| ---------- | ----- | ---------------- | ---------------- |
| Smartphone | €299  | 1                | 0                |
| Pencil     | €2    | 0                | 20               |

A consumer orders 1 smartphone and 5 pencils. The rating would choose facility 1 since this facility would generate a turnover of €299 versus facility 2, which only generates 5 x €2 = €10 turnover. The available stock rating, in contrast, would choose facility 2, since it is able to fulfill 5/6 items, whereas facility 1 only is able to fulfill 1/6 items.

{% hint style="info" %}
The maximizing turnover rating uses EUR as a currency.
{% endhint %}

### **Stock balancing** <a href="#ratings-stock-balancing" id="ratings-stock-balancing"></a>

The stock balancing rating balances different stock levels in the fulfillment network. When routing an order with stock-balancing activated, fulfillmenttools sums up the amount of items the consumer has ordered and compares to the amount of items which are available for those products the customer has ordered per facility. The facility with the highest stock deviation gets the maximum penalty:

| Item       | Ordered amount | Facility 1 | Facility 2 |
| ---------- | -------------- | ---------- | ---------- |
| Smartphone | 1              | 1          | 5          |
| Pencil     | 1              | 10         | 5          |

Deviation facility 1: (1+1)/(1+10) = 2/11 = 18%

Deviation facility 2: (1+1)/(5+5) = 2/10 = 20%

### **Workload balancing** <a href="#ratings-workload-balancing" id="ratings-workload-balancing"></a>

When routing an order with workload-balancing activated, the system favors a facility with a lower workload (for example, less tasks in state open which need to be fulfilled) than a facility which already has a high workload. This helps to avoid choosing facilities which suffer from a high workload of their employees.

### **Matching business type** <a href="#ratings-matchingbusinesstype" id="ratings-matchingbusinesstype"></a>

There are certain situations where an order might contain a list of preselected facilities which have different business types although the customer demanded for a certain business type.

**Example:**\
A customer creates a click-and-collect order. The system, however, supplies a click-and-collect facility with type of store as well as a ship-from-store facility with type of warehouse. This could happen because the warehouse can be used as a fallback to pick the items and send them over to the store in case the store can't fulfill the order of the customer. Still, if both facilities are rated equally good, the system should assign the order to the store to avoid shipping costs.

### **Prefer facilities with business type \`store\`** <a href="#ratings-preferfacilitieswhichhavethebusinesstype-store" id="ratings-preferfacilitieswhichhavethebusinesstype-store"></a>

When routing an order with this rating activated, facilities with the business type `store` are favored against facilities with a different business type.

### **Prefer facilities with business type \`warehouse\`** <a href="#ratings-preferfacilitieswhichhavethebusinesstype-warehouse" id="ratings-preferfacilitieswhichhavethebusinesstype-warehouse"></a>

When routing an order with this rating activated, facilities with the business type `warehouse` are favored against facilities with a different business type.

### **Prefer stock with a high score** <a href="#ratings-preferstockwithahighscore" id="ratings-preferstockwithahighscore"></a>

[Stocks](https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock) have a score which can be used to prefer some stocks over others during routing. The score can represent different attributes of the stock like zone, storage location, expiry date or date of receipt. A stock with a high quantity is used preferably over stock with lower quantity.

### **Prefer facilities with lower shipping costs** <a href="#ratings-nextfreecapacity" id="ratings-nextfreecapacity"></a>

The shipping cost rating compares possible shipping options (if not predetermined by the consumer). When routing an order with this rating active, facilities with an active carrier that is able to deliver the order for the lowest costs are favored. Facilities with lower costs get a better score in the routing than a facilities with higher costs.

Delivery costs are only compared within the same delivery category. For example, if the order requires an express delivery, only carrier costs for express delivery are considered (otherwise the standard option would always prioritized due to lower costs).

In case the order line requires a specific carrier product category only delivery costs of carrier products of this particular carrier product category are taken into account.

{% hint style="info" %}
The shipping cost rating uses EUR as a currency.
{% endhint %}

### **Prefer facilities with faster shipping** <a href="#ratings-nextfreecapacity" id="ratings-nextfreecapacity"></a>

The shipping time rating compares shipping/delivery times of different carriers (if not predetermined by the consumer). When routing an order with this rating active facilities with an active carrier that is able to deliver the order the fastest are favored. In order to determine this, possible pickup times of different carriers as well as delivery times are checked. Delivery times can be carrier specific or even delivery area specific.

Delivery speed is only compared within the same delivery category. For example, if the order requires a standard delivery, only delivery speed of carriers with standard delivery is compared (otherwise express carriers would always be prioritized).

In case the order line requires a specific carrier product category only delivery times of carrier products of this particular carrier product category are taken into account.

#### Calculation of the estimated delivery time

To calculate the estimated delivery time, several factors are taken into account:

* **EarliestPickingStart:** This determines the earliest possible start of the picking process, considering the configured picking times of a location and any defined capacity slots.
* **FulfillmentProcessBuffer:** This is a location-specific buffer that defines the average processing time required to complete an order.
* **(Earliest reachable) CutoffTime:** Based on the previous factors, the earliest possible pickup time by the carrier is determined. Carrier-specific capacity constraints, if configured, are also considered.
* **TransitTime:** This represents the average shipping duration as defined by the carrier, i.e., the time from order pickup at the location to final delivery to the customer.

By factoring in these elements, the total delivery time — from order placement to final delivery — is calculated in business days.

<figure><img src="https://4170739437-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLrrr5jgTsDuR38gNJIrm%2Fuploads%2Fum7NubwM4idheiHhNVmi%2Fimage.png?alt=media&amp;token=f56d5f76-9701-46c5-8f04-c36b12943c24" alt=""><figcaption></figcaption></figure>

### **Next free capacity** <a href="#ratings-nextfreecapacity" id="ratings-nextfreecapacity"></a>

The next free capacity rating favors facilities with the next free capacity slot available. The time frame between order created and next free capacity slot is rated (otherwise, next free capacity slot might be the present slot when the order is created). A free capacity means capacity to fulfill an order in the facility.

* If an order gets [rerouted](https://docs.fulfillmenttools.com/documentation/by-pillar/advanced-order-routing/reroute) or is manually assigned elsewhere the reserved capacity of the “old” corresponding facilities is cancelled and the capacity can be used / planned again.
* If capacities are changed, only new upcoming orders are affected by this change.
* If a capacity information is a decimal number it is **rounded down**.

#### What does “**next free capacity slot”** mean?

* Example 1: Order comes in @ 2:30 pm and there is the following network information available:
  * Facility 1: Slot: 12 pm - 3 pm / max. capacity: 10 → p. hour 3,3 - @2:30 pm (cutoff time) free capacity is 1,65 → round down = 1 order capacity available for 2:30 pm
  * Facility 2: 2-3 pm / cap.10 → p. hour 10 - @ 2:30 pm → 5 order capacity available for 2:30 pm\
    -> Facility 1 and Facility 2 get the same penalty
* Example 2: Order comes in @ 14:59
  * Facility 1: 12 pm - 3 pm cap: 10 → p. hour 3,3 -\@2:30 pm → 0,055 → round down = 0 order capacity available for 2:59 pm
  * Facility 2: 12 pm - 3 pm cap.10 → p. hour 10 - @ 2:59 pm → 0,167 → round down = 0 order capacity available for 2:59 pm\
    -> Facility 1 and Facility 2 get the same penalty

    -> looking on the next free slot

#### **Calculating the target time with capacities**

Planning capacities has impact on the [target time](https://docs.fulfillmenttools.com/documentation/by-pillar/store-operations/picking/pick-job-target-time) of a pick job, if the fulfillment of an order is planned for an upcoming day. For example, when an order comes in on Monday and the capacity on Wednesday is already planned, the target time can no longer be the CEP-Pickup-Time on Monday.

Nevertheless, if the target time comes within the order (“hard” target time) the target time is passed on.

In order to do this we check for the next pickup-time of the selected carrier which is reachable when the order is picked within the planned fulfillment-slot. Only if the pickup-time can be reached including free capacity this pickup time is selected as the new target time

**Example:**

* Order comes in on Monday 14:00
* Average fulfillment duration 30 min
* Order should be fulfilled by DHL, DHL' pickup-time is daily 16:00
* If we **do not** plan capacities (rating / fence is inactive) the TT would be Monday 16:00
* If we **do** plan capacities and the slot is planned < Monday 15:30 the TT would be Monday 16:00
* If we **do** plan capacities and the slot is planned e.g., Wednesday 15:00 the TT would be Wednesday 16:00
  * we use the starting point of the future capacity slot
    * if starting point + avg. duration < pickup time (1) then pickup time (1) otherwise pickup time (2 (next TT))
    * if date now is within the slot, we use date now + avg. duration < pickup time (1) then pickup time

To make sure that our systems does not occupy capacities which lie too far in the future. We introduced a limit which defines how many days in the future capacities can be used and “booked”. This is the base for our capacity Fence.

This value includes always the capacity of a calendar day (and not days with fulfillment times (opening day)).

This value can be set as a tenant-wide default via the api and/or via the backoffice or for a specific facility (only via API). If one changes the default, only the facilities using the default value change - facilities which have their own number saved, are not changed (even if this value is the same than the default).

**Example:**

* Today is 14:00 Monday
* The parameter is set to 3 days
* The capacity until Thursday (including Thursday) can be used for planning




---

[Next Page](https://docs.fulfillmenttools.com/documentation/llms-full.txt/1)

