Datapel Systems

## 🚀 Theneo

Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

**⚠️ Note:** All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://assets.website-files.com/61f7e03934c23c1dcc9c3cd4/6306089ecc13c15fe0a7e006_Main page_2 (with visual studoi code logo) 2.svg" alt="" height="237" width="322">

### Generate API Documentation

- Build interactive API docs
- Tailor you documentation
- Create and launch quickly
- Update easily within seconds
- Built for everyone
    

# Integrations

Import your collections manually or use our integrations to automatically migrate your work from:

- Swagger
- Postman
- Github
    

[  
](https://www.theneo.io/#)

[  
](https://app.theneo.io/signup)

Datapel API Reference

How it Works

OData Standards Support

OData Web Components

OData Best Practices

🚀 Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

⚠️ Note**:** All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://assets.website-files.com/61f7e03934c23c1dcc9c3cd4/6306089ecc13c15fe0a7e006_Main page_2 (with visual studoi code logo) 2.svg" alt="" height="168" width="200">

### Generate API Documentation

- Build interactive API docs
- Tailor you documentation
- Create and launch quickly
- Update easily within seconds
- Built for everyone
    

# Integrations

Import your collections manually or use our integrations to automatically migrate your work from:

- Swagger
- Postman
- Github

Authentication

Token

Creates a new customer for a business.

You must provide at least one of the following values in your request to this endpoint:

 *   `given_name`
 *   `family_name`
 *   `company_name`
 *   `email_address`
 *   `phone_number`

Token Refresh

All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API.  
Get sales data, itemize payments, push orders to POS, and more.

**⚠️ Note:** The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.

In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://media.geeksforgeeks.org/wp-content/cdn-uploads/20200318193845/Top-7-Payment-Gateway-APIs-That-Every-Developer-Must-Know.png">

As an organization, you need to be careful while choosing a payment gateway option. It should be according to the customer’s experience on your websites through to cash flow to online sales. Make sure that you take care of at least 5 things mentioned below while choosing a payment gateway… 

- **Security** should be the topmost priority. Make sure that it should be integrated with the 3D security and comply with the PCI Data Security Standard (PCI DSS).
- **Payout Time** should be less to credit money in your bank account.
- **Integration need to be easy and simple** or it can develop a custom-coded solution for your platform easily.
- **Multiple currencies** should be handled by the payment gateway for the customers using different currencies across the world.

Endpoint Reference

Creates a new order that can include information about products for purchase and settings to apply to the purchase.

Time Stamp

List Items

Ship Methods

Sources

Tax Codes

Job Codes

Audit Events

Product List

Inventory List

Inventory Events

Address List

Contact List

Location List

Attachments

Create Sale Order

Order List

Create Transfer Order

Transfer Order List

Create Purchase Order

Inward Order List

Create Transaction

Workspace Options

Change Log

Theneo Demo TechCrunch

Datapel API

Production

Sandbox

<p class="slate-p " >Welcome to the API Reference for the Datapel Cloud.WMS Inventory Management System (IMS), a powerful and versatile tool designed to streamline the management of order and inventory data for businesses of all sizes. This documentation serves as your comprehensive guide to understanding and use of our API, providing you with the information and resources needed to integrate our system seamlessly into your applications and processes.</p><h3 class="slate-h3 " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Why an Inventory Management System Matters</strong></span></h3><p class="slate-p " >Efficient order and inventory management is the cornerstone of successful business operations. Whether you are a small wholesaler, a manufacturing powerhouse, or an e-commerce giant, the ability to track, monitor, and control your inventory is essential for reducing costs, improving customer satisfaction, and driving profitability. Our Inventory Management System is designed to simplify this complex task, offering real-time insights, process automation, and scalability.</p><h3 class="slate-h3 " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">What Can You Achieve with Our API</strong></span></h3><p class="slate-p " >The Datapel API opens up many possibilities for developers, businesses, and entrepreneurs seeking to optimise their inventory and order management processes. Here are some potential applications and use cases that can and have been developed using our API:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">E-commerce Integration</strong></span> Seamlessly sync your e-commerce platform with our WMS to ensure accurate product availability and pricing on your online store. This leads to fewer out-of-stock situations and enhances the overall shopping experience for your customers.
</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Warehouse Automation</strong></span> Implement robotic or IoT solutions to automate inventory movement within your warehouses. Our API provides real-time inventory data, enabling robots or devices to make informed decisions about restocking and retrieval.
</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Multi-Location Management</strong></span> Manage inventory across multiple physical locations, whether they are warehouses, retail stores, or distribution centres. Our API allows you to centralise inventory control and maintain consistency across your network.
</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Customer and Supplier Collaboration</strong></span> Facilitate better communication with your customers and suppliers by sharing real-time inventory data. Suppliers can use this information to optimise production schedules and ensure timely deliveries, reducing the risk of stockouts. Customers can check availability and account status reducing overall customer servicing costs.
</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Inventory Forecasting</strong></span> Utilise historical data and predictive analytics to forecast demand and optimise inventory levels. With our API, you can build custom forecasting algorithms and strategies to minimize overstock and understock situations.
</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Order Fulfillment Automation</strong></span> Create systems that automate order fulfillment processes, ensuring orders are picked, packed, and shipped efficiently, with real-time inventory updates for customers.
</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Inventory Reporting and Analytics</strong></span> Develop custom dashboards and reporting tools to gain valuable insights into your inventory performance. Track key metrics such as turnover rate, holding costs, and sales velocity.
</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Inventory Auditing and Compliance</strong></span> Implement auditing solutions that use the IMS API to verify inventory accuracy and compliance with industry regulations. This is especially crucial in sectors with strict quality control requirements.
</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Inventory Optimization Algorithms</strong></span> Design algorithms that automatically optimise inventory reorder points, safety stock levels, and economic order quantities based on real-time market conditions.
</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Retail Shelf Management</strong></span> Optimise the placement of products on store shelves by utilising our API to ensure high-demand items are always readily available, leading to increased sales.</div></li></ol><p class="slate-p " >The Cloud.WMS API empowers you to take control of your inventory and order management processes and drive operational excellence across your business. Whether you are looking to enhance the efficiency of your supply chain, boost customer satisfaction, or make data-driven decisions, our API is your gateway to achieving these objectives with precision and ease. 
</p><p class="slate-p " >In this API Reference, you will find detailed documentation, code examples, and best practices to help you harness the full potential of our Inventory Management System API.</p><p class="slate-p " >

</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Welcome to the API Reference for the Datapel Cloud.WMS Inventory Management System (IMS), a powerful and versatile tool designed to streamline the management of order and inventory data for businesses of all sizes. This documentation serves as your comprehensive guide to understanding and use of our API, providing you with the information and resources needed to integrate our system seamlessly into your applications and processes.

Why an Inventory Management System Matters

Efficient order and inventory management is the cornerstone of successful business operations. Whether you are a small wholesaler, a manufacturing powerhouse, or an e-commerce giant, the ability to track, monitor, and control your inventory is essential for reducing costs, improving customer satisfaction, and driving profitability. Our Inventory Management System is designed to simplify this complex task, offering real-time insights, process automation, and scalability.

The Datapel API opens up many possibilities for developers, businesses, and entrepreneurs seeking to optimise their inventory and order management processes. Here are some potential applications and use cases that can and have been developed using our API:

The Cloud.WMS API empowers you to take control of your inventory and order management processes and drive operational excellence across your business. Whether you are looking to enhance the efficiency of your supply chain, boost customer satisfaction, or make data-driven decisions, our API is your gateway to achieving these objectives with precision and ease. 


In this API Reference, you will find detailed documentation, code examples, and best practices to help you harness the full potential of our Inventory Management System API.

<h2 class="slate-h2">Bearer Token Authentication</h2><p class="slate-p" placeholder="Type / for widgets">Datapel API version 2.0 uses Bearer Token Authentication, a crucial security mechanism that safeguards our API endpoints and ensures secure communication between clients apps and our API servers. This section describes what Bearer Token Authentication is, how it works, and how to manage secure API access.</p><p class="slate-p" placeholder="Type / for widgets">Bearer Token Authentication is a widely adopted method for securing APIs, relied upon by countless applications and services across the internet. It offers a robust, standardized approach to verifying the identity of clients attempting to access an API resource. With Bearer Token Authentication, you can establish trust between the API server and its clients, ensuring that only authorized parties gain access while keeping unauthorized users at out.</p><p class="slate-p" placeholder="Type / for widgets">In this documentation reference, we will cover the following key topics:</p><ol class="slate-ol"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Understanding Bearer Tokens:</strong></span> Get acquainted with the concept of bearer tokens, their structure, and how they function as credentials for authenticating your API requests.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Token Generation and Management:</strong></span> Learn how we generate, issue, and manage bearer tokens securely, with best practice token lifetimes and refresh mechanisms.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Authentication Flow:</strong></span> Understand step-by-step the process of how client apps present bearer tokens in API requests, and how our API server validates these tokens to grant or deny access.</div></li></ol><p class="slate-p" placeholder="Type / for widgets">The following sections describes our implementation of the Bearer Token Authentication process.</p><p class="slate-p" placeholder="Type / for widgets"></p><h1 class="slate-h1">Understanding Bearer Tokens</h1><p class="slate-p" placeholder="Type / for widgets">Bearer Tokens are at the heart of Bearer Token Authentication, serving as the digital keys that grant access to API resources. </p><h3 class="slate-h3">What is a Bearer Token?</h3><p class="slate-p" placeholder="Type / for widgets">A Bearer Token is a type of access token used in authentication protocols, such as OAuth 2.0 and OpenID Connect. It is a string of characters, typically represented as a long, random alphanumeric sequence. Bearer Tokens act as credentials that a client (usually a user or application) presents to an API server when making a request for a protected resource.</p><h3 class="slate-h3">How Do Bearer Tokens Work?</h3><p class="slate-p" placeholder="Type / for widgets">Bearer Tokens operate on a straightforward principle: possession of the token equals access. When a client wishes to access a protected resource via an API, it includes the Bearer Token in the request, typically within the HTTP Authorization header. The server receives the token, validates it, and if the token is valid and not expired, it grants access to the requested resource.</p><h3 class="slate-h3">Stateless Authentication</h3><p class="slate-p" placeholder="Type / for widgets">One of the advantages of Bearer Tokens is their statelessness. Unlike session-based authentication, where server-side state is maintained for each user, Bearer Tokens require no server-side storage of session data. This makes them highly scalable and suitable for stateless API architectures, such as RESTful APIs.</p><h3 class="slate-h3">Security Considerations</h3><p class="slate-p" placeholder="Type / for widgets">While Bearer Tokens offer an efficient way to authenticate API requests, they come with security responsibilities. Since anyone in possession of a Bearer Token can access the protected resources, it is crucial to protect these tokens from theft and misuse. Security measures include token encryption, short token lifetimes, and token revocation mechanisms.</p><h3 class="slate-h3">Token Payload</h3><p class="slate-p" placeholder="Type / for widgets">Bearer Tokens often contain a payload that carries information about the client or user, such as user roles or permissions. This payload can help your API server make access control decisions based on the token&apos;s content.</p><p class="slate-p" placeholder="Type / for widgets">In summary, Bearer Tokens represent the authorization credentials clients use to access an APIs protected resources. Understanding their structure, how they are transmitted, and their security implications is fundamental to implementing secure and efficient API based Application. </p><p class="slate-p" placeholder="Type / for widgets"></p><h1 class="slate-h1">Token Generation and Management</h1><p class="slate-p" placeholder="Type / for widgets">Token generation and management are critical aspects of Bearer Token Authentication. To ensure the security of the Datapel API our tokens are 256 bit encrypted and have a limited life span of 30 minutes. A refresh token is provided to allow trust renewal by following the Refresh Authentication flow.</p><p class="slate-p" placeholder="Type / for widgets">The Bearer Token Authorization flow involves a series of steps that allow a client (such as a user or application) to authenticate itself and gain access to protected resources on our API. This flow is based on the OAuth 2.0 framework and is widely used for securing APIs. Here&apos;s a step-by-step breakdown of the typical Bearer Token Authorization flow:</p><ol class="slate-ol"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Client Registration (Optional):</strong></span> In most cases, our clients need to be registered with API access to our server. During registration, you will receive an API key and secret, which are used to identify and authenticate your application. This step is commonly seen in OAuth 2.0.
</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Authentication Request:</strong></span> Your app initiates the authentication process by sending a request to our API TOKEN endpoint. 
</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Token Issuance:</strong></span> The API server processes the token request, verifies identity, and, if everything checks out, issues an access token. This access token is a bearer token, and its purpose is to prove the client&apos;s authorization to access protected resources. Included in the token is a refresh token which allows renewed trust access tokens without needing the initial API key or User credentials.
</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Token Usage:</strong></span> The client includes the access token in the <span style="color:var(--tw-prose-code);font-size:0.875em" class="slate-color"><code style="color:var(--tw-prose-code);font-size:0.875em" class="slate-code"><strong style="color:var(--tw-prose-code);font-size:0.875em" class="slate-bold">Authorization</strong></code></span> header of its API requests, using the &quot;Bearer&quot; prefix (e.g., &quot;Bearer [access token]&quot;). This token is what grants the client access to the API resources.
</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Token Validation:</strong></span> When the API server receives a request with an access token, it validates the token to ensure it&apos;s genuine, unexpired, and has the necessary permissions to access the requested resource. This step often involves checking the token&apos;s digital signature, expiration time, and scope.
</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Access Control:</strong></span> If the token is valid, the API server grants the client access to the requested resource. Access control decisions may also be based on the user&apos;s identity and the permissions associated with the token.
</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Token Revocation (Optional):</strong></span> To maintain security, tokens can be revoked by either the client or the authorization server when they are no longer needed or if they are compromised.
</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Token Expiration and Refresh (Optional):</strong></span> Access tokens have a limited lifetime. Your application can request a new access token using a refresh token if the original token expires. This helps maintain the session&apos;s longevity while minimizing security risks.
</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Logging and Monitoring:</strong></span> Our API has backend monitoring and logging and if required we can assist with troubleshooting any access issues you may experience by reviewing request history.</div></li></ol><p class="slate-p" placeholder="Type / for widgets">

<span style="background-color:rgb(52, 53, 65);color:rgb(255, 255, 255);font-size:medium" class="slate-color"><span style="background-color:rgb(52, 53, 65);color:rgb(255, 255, 255);font-size:medium" class="slate-backgroundColor">


</span></span></p><p class="slate-p" placeholder="Type / for widgets">




</p><p class="slate-p" placeholder="Type / for widgets"></p>

Datapel API version 2.0 uses Bearer Token Authentication, a crucial security mechanism that safeguards our API endpoints and ensures secure communication between clients apps and our API servers. This section describes what Bearer Token Authentication is, how it works, and how to manage secure API access.

Bearer Token Authentication is a widely adopted method for securing APIs, relied upon by countless applications and services across the internet. It offers a robust, standardized approach to verifying the identity of clients attempting to access an API resource. With Bearer Token Authentication, you can establish trust between the API server and its clients, ensuring that only authorized parties gain access while keeping unauthorized users at out.

In this documentation reference, we will cover the following key topics:

The following sections describes our implementation of the Bearer Token Authentication process.

Bearer Tokens are at the heart of Bearer Token Authentication, serving as the digital keys that grant access to API resources. 

A Bearer Token is a type of access token used in authentication protocols, such as OAuth 2.0 and OpenID Connect. It is a string of characters, typically represented as a long, random alphanumeric sequence. Bearer Tokens act as credentials that a client (usually a user or application) presents to an API server when making a request for a protected resource.

Bearer Tokens operate on a straightforward principle: possession of the token equals access. When a client wishes to access a protected resource via an API, it includes the Bearer Token in the request, typically within the HTTP Authorization header. The server receives the token, validates it, and if the token is valid and not expired, it grants access to the requested resource.

One of the advantages of Bearer Tokens is their statelessness. Unlike session-based authentication, where server-side state is maintained for each user, Bearer Tokens require no server-side storage of session data. This makes them highly scalable and suitable for stateless API architectures, such as RESTful APIs.

While Bearer Tokens offer an efficient way to authenticate API requests, they come with security responsibilities. Since anyone in possession of a Bearer Token can access the protected resources, it is crucial to protect these tokens from theft and misuse. Security measures include token encryption, short token lifetimes, and token revocation mechanisms.

Bearer Tokens often contain a payload that carries information about the client or user, such as user roles or permissions. This payload can help your API server make access control decisions based on the token's content.

In summary, Bearer Tokens represent the authorization credentials clients use to access an APIs protected resources. Understanding their structure, how they are transmitted, and their security implications is fundamental to implementing secure and efficient API based Application. 

Token generation and management are critical aspects of Bearer Token Authentication. To ensure the security of the Datapel API our tokens are 256 bit encrypted and have a limited life span of 30 minutes. A refresh token is provided to allow trust renewal by following the Refresh Authentication flow.

The Bearer Token Authorization flow involves a series of steps that allow a client (such as a user or application) to authenticate itself and gain access to protected resources on our API. This flow is based on the OAuth 2.0 framework and is widely used for securing APIs. Here's a step-by-step breakdown of the typical Bearer Token Authorization flow:

<p class="slate-p " >Welcome to the Endpoint Resources Listing section of our API reference. This comprehensive guide provides a detailed overview of all available endpoints and resources within our API. Whether you&apos;re a developer looking to integrate our services into your application or an experienced user seeking to explore the capabilities of our API, you&apos;ll find everything you need to get started and make the most of our platform.</p><p class="slate-p " >In this section, you will find a structured and organized list of API endpoints, each accompanied by a description of its purpose and usage. We have designed our API with simplicity and flexibility in mind, ensuring that you can efficiently interact with our platform to meet your specific needs.</p><p class="slate-p " >To streamline your development process, we have categorized the endpoints into logical groups and provided clear explanations of the parameters and data formats associated with each resource. Additionally, you&apos;ll find information on authentication methods, response formats, and any specific requirements for using particular endpoints.</p><p class="slate-p " >Whether you&apos;re retrieving data, creating records, or performing complex operations, this Endpoint Resources Listing is your go-to reference for understanding and utilizing our API effectively. Feel free to explore the endpoints that align with your project&apos;s goals and requirements, and use this documentation as your trusted companion on your API integration journey.</p><p class="slate-p " >Please refer to the table of contents or use the search functionality to quickly locate the endpoints and resources that interest you. If you have any questions, encounter issues, or need further assistance, our support team is here to help.</p><p class="slate-p " >When reviewing the Post or Response Body it is recommended to click the <code class="slate-code"><strong class="slate-bold">expand all </strong></code>option as shown below to display all nodes and properties.</p><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1707365173438.png" style="
              width:1089px;
	            height:740px;
	            aspect-ratio:1089 / 740"
         /></div><p class="slate-p " >Let&apos;s dive in and explore the wealth of possibilities our API offers. Happy coding!</p><p class="slate-p " >

</p><p class="slate-p " ></p>

Welcome to the Endpoint Resources Listing section of our API reference. This comprehensive guide provides a detailed overview of all available endpoints and resources within our API. Whether you're a developer looking to integrate our services into your application or an experienced user seeking to explore the capabilities of our API, you'll find everything you need to get started and make the most of our platform.

In this section, you will find a structured and organized list of API endpoints, each accompanied by a description of its purpose and usage. We have designed our API with simplicity and flexibility in mind, ensuring that you can efficiently interact with our platform to meet your specific needs.

To streamline your development process, we have categorized the endpoints into logical groups and provided clear explanations of the parameters and data formats associated with each resource. Additionally, you'll find information on authentication methods, response formats, and any specific requirements for using particular endpoints.

Whether you're retrieving data, creating records, or performing complex operations, this Endpoint Resources Listing is your go-to reference for understanding and utilizing our API effectively. Feel free to explore the endpoints that align with your project's goals and requirements, and use this documentation as your trusted companion on your API integration journey.

Please refer to the table of contents or use the search functionality to quickly locate the endpoints and resources that interest you. If you have any questions, encounter issues, or need further assistance, our support team is here to help.

When reviewing the Post or Response Body it is recommended to click the 

option as shown below to display all nodes and properties.

Let's dive in and explore the wealth of possibilities our API offers. Happy coding!

<p class="slate-p" placeholder="Type / for widgets">Get the current server date time stamp. This endpoint is used to align server last modified time stamps with local application or client side time zones.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get the current server date time stamp. This endpoint is used to align server last modified time stamps with local application or client side time zones.

Authorization

Content-Type

TimeStamp

TimeStampUTC

<p class="slate-p" placeholder="Type / for widgets">Retrieves List Items for Product Categories and Contact Groups</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves List Items for Product Categories and Contact Groups

<p class="slate-p" placeholder="Type / for widgets">Retrieves Shipping Method List Items for Inventory Movement Transactions and Contact Defaults</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves Shipping Method List Items for Inventory Movement Transactions and Contact Defaults

<p class="slate-p" placeholder="Type / for widgets">Retrieves Source List Items for Inventory Transactions and Contact Defaults. Sources can be used as a searchable or sortable transaction tag.</p><p class="slate-p" placeholder="Type / for widgets"> </p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves Source List Items for Inventory Transactions and Contact Defaults. Sources can be used as a searchable or sortable transaction tag.

<p class="slate-p" placeholder="Type / for widgets">Retrieves Tax Codes for Inventory Transactions, Products and Contact Defaults. Tax Codes are mandatory fields for sale order line items with the default being N-T (no tax).</p><p class="slate-p" placeholder="Type / for widgets"> </p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves Tax Codes for Inventory Transactions, Products and Contact Defaults. Tax Codes are mandatory fields for sale order line items with the default being N-T (no tax).

<p class="slate-p" placeholder="Type / for widgets">Retrieves Job Codes used for tagging Inventory Transaction Lines. Job Codes are optional fields for order line items with the default being NULL (no code). </p><p class="slate-p" placeholder="Type / for widgets"> </p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves Job Codes used for tagging Inventory Transaction Lines. Job Codes are optional fields for order line items with the default being NULL (no code). 

<p class="slate-p" placeholder="Type / for widgets">Retrieves system Audit Events used to track workspace activity by system and user actions with timestamp.</p><p class="slate-p" placeholder="Type / for widgets">You may also use the singleton by Uid format <code class="slate-code">/public/auditevent?{AuditEventUid}</code></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves system Audit Events used to track workspace activity by system and user actions with timestamp.

You may also use the singleton by Uid format 

<p class="slate-p" placeholder="Type / for widgets">Retrieves a list of Product master items using a filter criteria. Make sure to limit results using the <code class="slate-code">$top</code> directive set to less than the maximum page size of <code class="slate-code"><strong class="slate-bold">500</strong></code>. </p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves a list of Product master items using a filter criteria. Make sure to limit results using the 

 directive set to less than the maximum page size of 

$orderby

$top

$skip

Limit the columns returned in the response

$select

<p class="slate-p" placeholder="Type / for widgets">Retrieves a single Product by Uid using singleton format <code class="slate-code">/public/product?{ProductUid}</code></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves a single Product by Uid using singleton format 

Product

ProductUid

Code

Name

Description

IsActive

IsBought

BuyingPrice

IsBuyingPriceIncludingTax

BuyingTaxCode

BuyingAccount

IsSold

SellingPrice

IsSellingPriceIncludingTax

SellingTaxCode

SellingAccount

IsInventoried

Category1

Category2

Category3

WebStoreItem

WebStoreMinimum

ImageUrl1

ImageUrl2

ImageUrl3

<p class="slate-p" placeholder="Type / for widgets">Retrieves Product User Defined Fields (UDFs) and Field Labels</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves Product User Defined Fields (UDFs) and Field Labels

Productudfs

$filter

<p class="slate-p" placeholder="Type / for widgets">Retrieves Product Bill of Materials.</p><h3 class="slate-h3">Property Descriptions</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">ProductUid</strong></span>: A unique identifier for the product. This UID is used to reference the product within the system.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">Code</strong></span>: The product code. This is typically a human-readable identifier used to reference the product in catalogs and sales documents.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">IsBought</strong></span>: A boolean indicating if the product is purchased from suppliers. <span style="color:var(--tw-prose-code);font-size:0.875em" class="slate-color"><code style="color:var(--tw-prose-code);font-size:0.875em" class="slate-code"><strong style="color:var(--tw-prose-code);font-size:0.875em" class="slate-bold">false</strong></code></span> indicates it is not a bought item.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">IsSold</strong></span>: A boolean indicating if the product is sold to customers. <span style="color:var(--tw-prose-code);font-size:0.875em" class="slate-color"><code style="color:var(--tw-prose-code);font-size:0.875em" class="slate-code"><strong style="color:var(--tw-prose-code);font-size:0.875em" class="slate-bold">true</strong></code></span> indicates it is a salable item.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">IsInventoried</strong></span>: A boolean indicating if the product is tracked in inventory. <span style="color:var(--tw-prose-code);font-size:0.875em" class="slate-color"><code style="color:var(--tw-prose-code);font-size:0.875em" class="slate-code"><strong style="color:var(--tw-prose-code);font-size:0.875em" class="slate-bold">true</strong></code></span> suggests it has inventory records.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">BuildQuantity</strong></span>: The quantity of the product produced in a single build operation. It reflects how many units of the product are made at a time.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">IsKitProduct</strong></span>: A boolean indicating if the product is a kit. Kits are typically assembled at the time of sale from individual components.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">IsAssembly</strong></span>: A boolean indicating if the product requires assembly. <span style="color:var(--tw-prose-code);font-size:0.875em" class="slate-color"><code style="color:var(--tw-prose-code);font-size:0.875em" class="slate-code"><strong style="color:var(--tw-prose-code);font-size:0.875em" class="slate-bold">true</strong></code></span> means it is an assembled product, consisting of multiple components.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">ProductLineUid</strong></span>: A unique identifier for the product line. This is used to categorize products within broader groups.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">LineNumber</strong></span>: The line number in the Bill of Materials. This represents the order or sequence of components within the BOM.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">LineQuantity</strong></span>: The quantity of this component required per assembly or kit.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">UseDescription</strong></span>: A boolean indicating if a custom description is used for this BOM line. <span style="color:var(--tw-prose-code);font-size:0.875em" class="slate-color"><code style="color:var(--tw-prose-code);font-size:0.875em" class="slate-code"><strong style="color:var(--tw-prose-code);font-size:0.875em" class="slate-bold">true</strong></code></span> means a custom description is specified.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">LineDescription</strong></span>: A description of the component or material on this line of the BOM.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">LineItemCode</strong></span>: The code identifying the component or material on this line of the BOM.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">SellingUnitMeasure</strong></span>: The unit of measure for selling the product (e.g., &quot;Each&quot;).</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">QuantityPerSellUnit</strong></span>: The quantity of the component or material included per selling unit of the product.</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">BuyingUnitMeasure</strong></span>: The unit of measure for buying the component or material (e.g., &quot;Pack&quot;).</div></li><li class="slate-li"><div style="position:relative"><span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">QuantityPerBuyUnit</strong></span>: The quantity of the component or material included per buying unit.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Billofmaterials

Returns a list of Bill Of Materials with Lines

<p class="slate-p" placeholder="Type / for widgets">Retrieves Product image URLs</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Productimages

<p class="slate-p" placeholder="Type / for widgets">Retrieves a list of products with all available price levels as price levels array.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves a list of products with all available price levels as price levels array.

ProductPriceLevels

Returns a list of products with price level arrays

<p class="slate-p" placeholder="Type / for widgets">Retrieves a flat array list of available pricing levels by <code class="slate-code">ProductUid.</code></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves a flat array list of available pricing levels by 

PriceLevels

<p class="slate-p" placeholder="Type / for widgets">The Special Pricing Contracts API provides details on the specific pricing contracts established and currently valid for active products and customers. This data includes various pricing and discount terms applicable to different items and the quantity price breaks for the contract period.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Special Pricing Contract Schedules (SPS)
</strong>
Cloud.WMS allows setting up special, contract or promotional pricing by item, customer, or groups. It requires specific configuration within the WMS to activate and apply these special pricing rules. Prices are evaluated based on the best available price, prioritising specific customer pricing over group pricing if both are available.</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Price Contracts :</strong> Specify fixed prices for items based on the contract. Unit prices (exc. and inc. tax) are set and are applicable regardless of the general pricing strategy.Typically used when the price of an item needs to be consistent over a period.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Discount Contracts :</strong> These specify a percentage discount to be applied to the base price of items. The discount percentage can vary based on the quantity purchased. More flexible than fixed price contracts as they adjust based on purchasing volume and can be set to provide bulk purchasing incentives.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Calculating Contract Prices</strong></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Best Price Rule:</strong> The WMS attempts to return the best price based on the lowest price available from the configured special pricing strategies.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Discount vs. Price: </strong>If both discount and fixed price are set, the discount will override the fixed price, applying the discount to the base price of the item.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Price Levels:</strong> if no special price contracts exist check the Contacts Price Level and select the required item price according to the line quantity.
</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

The Special Pricing Contracts API provides details on the specific pricing contracts established and currently valid for active products and customers. This data includes various pricing and discount terms applicable to different items and the quantity price breaks for the contract period.

Special Pricing Contract Schedules (SPS)



Cloud.WMS allows setting up special, contract or promotional pricing by item, customer, or groups. It requires specific configuration within the WMS to activate and apply these special pricing rules. Prices are evaluated based on the best available price, prioritising specific customer pricing over group pricing if both are available.

SpecialPriceContracts

Returns a list of special pricing schedules with contract price line arrays

<p class="slate-p " >Retrieves a list of records detailing current available Inventory by item, location, quantity, and unique batch serial number properties. Use <code class="slate-code"><strong class="slate-bold">$top</strong></code> and <code class="slate-code"><strong class="slate-bold">$filter</strong></code> directives to limit results to less than the maximum page size of <code class="slate-code"><strong class="slate-bold">500</strong></code>records. </p><h3 class="slate-h3 " >Inventory Synchronisation</h3><p class="slate-p " >A common use case for IMS integration is reflecting available inventory to external systems, like eCommerce WebStores. To keep inventory quantity levels synchronised between an external system and the Inventory List Endpoint, two strategies can be used based on required synchronisation frequency: either as end-of-day batch or periodically throughout the day or “real-time”. Both strategies leverage the <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">TimeStamp</strong></code></span> property, which indicates the last modified date-time of inventory records, using this only relevant changes are collected and updated. <strong class="slate-bold">WebHooks are not supported</strong> for this endpoint as typically inventory movement occurs frequently and in some cases across thousands of articles per minute, or in some cases seconds, causing message overflows. </p><h3 class="slate-h3 " >Batch Synchronisation</h3><p class="slate-p " >For end-of-day or batch synchronisation, the process involves querying the entire inventory list once per day usually after business hours to update the external inventory system with the day&apos;s final inventory states ready for the next business day. This strategy is simpler and may be suitable for systems with lower transaction volumes or where real-time inventory accuracy is not critical.</p><p class="slate-p " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Technique:</strong></span></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Retrieve All Records:</strong></span> Use the <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">$top</strong></code></span> directive to fetch records in batches of up to 500 (the maximum page size). Repeat requests as necessary to retrieve all inventory records.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Filter by Modification Date:</strong></span> If supported by the endpoint, use the <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">$filter</strong></code></span> directive to request records modified since the last synchronisation timestamp. If direct filtering by timestamp is not supported, all records must be fetched and then filtered client-side.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Update External System:</strong></span> For each retrieved record, update the corresponding item in the external inventory system, focusing on quantity levels and any other relevant information.</div></li></ol><h3 class="slate-h3 " >Periodic Synchronisation</h3><p class="slate-p " >For periodic synchronisation, updates are performed at shorter intervals throughout the day, ensuring more up-to-date inventory levels. This approach is more complex but is necessary for systems requiring higher accuracy and timeliness in inventory data.</p><p class="slate-p " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Technique:</strong></span></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Initial Full Sync:</strong></span> Perform a full synchronisation at the start of the period to ensure both systems start from a consistent state.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Periodic Incremental Sync:</strong></span> At set intervals (e.g., every hour), use the <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">$filter</strong></code></span> directive to fetch records modified since the last successful synchronisation. This approach reduces the data transfer volume and focuses updates on only changed records. Usually taking the maximum TimeStamp from the last result set and using a filter where <code class="slate-code"><strong class="slate-bold">$filter=TimeStamp ge LastTimeStamp</strong></code></div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Handling Pagination:</strong></span> Utilise the <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">$top</strong></code></span> directive to manage pagination, ensuring complete retrieval of all relevant updates within the constraint of the maximum page size.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Concurrency Handling:</strong></span> Implement logic to handle concurrency issues, especially in scenarios where an inventory record might be updated during the synchronisation process. Techniques include retry mechanisms or leveraging versioning fields if available.</div></li></ol><h3 class="slate-h3 " >General Considerations</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Error Handling:</strong></span> Implement robust error handling to address network issues, API rate limits, and data inconsistencies.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Data Summaries:</strong> Note that the Inventory List provides article detail, in the case where summary inventory levels are required the first result set may need to be used to indicate the Product items, Location, and Bins to filter in order to recalculate total available inventory levels. </div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Timestamp Management:</strong></span> Store the timestamp of the last successful synchronisation to use as a reference for subsequent <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">$filter</strong></code></span> queries as per the example above.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Optimisation:</strong></span> Consider caching mechanisms or delta updates (if supported by the API) to optimize performance and reduce unnecessary data transfer.</div></li></ul><p class="slate-p " >By carefully implementing these techniques, tailored to the synchronisation frequency requirements, you can ensure that the external inventory system remains closely aligned with the data provided by the Inventory List Endpoint.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieves a list of records detailing current available Inventory by item, location, quantity, and unique batch serial number properties. Use 

 directives to limit results to less than the maximum page size of 

A common use case for IMS integration is reflecting available inventory to external systems, like eCommerce WebStores. To keep inventory quantity levels synchronised between an external system and the Inventory List Endpoint, two strategies can be used based on required synchronisation frequency: either as end-of-day batch or periodically throughout the day or “real-time”. Both strategies leverage the 

 property, which indicates the last modified date-time of inventory records, using this only relevant changes are collected and updated. 

 for this endpoint as typically inventory movement occurs frequently and in some cases across thousands of articles per minute, or in some cases seconds, causing message overflows. 

For end-of-day or batch synchronisation, the process involves querying the entire inventory list once per day usually after business hours to update the external inventory system with the day's final inventory states ready for the next business day. This strategy is simpler and may be suitable for systems with lower transaction volumes or where real-time inventory accuracy is not critical.

For periodic synchronisation, updates are performed at shorter intervals throughout the day, ensuring more up-to-date inventory levels. This approach is more complex but is necessary for systems requiring higher accuracy and timeliness in inventory data.

By carefully implementing these techniques, tailored to the synchronisation frequency requirements, you can ensure that the external inventory system remains closely aligned with the data provided by the Inventory List Endpoint.

Returns a list of Inventory article records

<p class="slate-p " >Retrieves a list of records detailing Inventory movements by item, location, quantity, and unique batch serial number properties. Use <code class="slate-code"><strong class="slate-bold">$top</strong></code> and <code class="slate-code"><strong class="slate-bold">$filter</strong></code> directives to limit results to less than the maximum page size of <code class="slate-code"><strong class="slate-bold">500</strong></code>records. </p><h3 class="slate-h3 " >Summary Overview</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">InventoryEventUid</strong></span>: A unique identifier for the inventory event.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">EventDate</strong></span>: The date the event occurred.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">ProductUid</strong></span>: A unique identifier for the product involved in the event.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">LocationUid</strong></span>, <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">LocationCode</strong></span>: Unique identifiers and code for the location of the inventory event.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">LocationBinUid</strong></span>, <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">BinNumber</strong></span>, <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">BinType</strong></span>: Details about the specific bin within the location where the product is stored.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Source</strong></span>: The origin of the inventory event, e.g., Purchase Order (PO).</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">OrderURN</strong></span>, <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">ReferenceNumber</strong></span>, <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">OrderUid</strong></span>, <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">OrderNumber</strong></span>: Various identifiers related to the order associated with this event.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Code</strong></span>: The product code.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">BatchSerialNumber</strong></span>: Serial number for the product batch, if applicable.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">ContactName</strong></span>: The name associated with the location, such as &quot;Main Warehouse&quot;.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Quantity</strong></span>, <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">UnitQuantity</strong></span>, <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">UnitMeasure</strong></span>: Details about the quantity of the product moved or affected by the event, including the unit of measure.</div></li></ul><h3 class="slate-h3 " >Example Use Cases</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Inventory Tracking</strong></span>: Use the API to track inventory movements within the warehouse. For example, when products are received, moved, or shipped, an event is recorded with all relevant details including product, quantity, and location.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Order Processing</strong></span>: Integrate with an order management system to update inventory levels based on incoming orders (purchase orders) and outgoing orders (sales orders). The <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Source</strong></code></span> field can be used to differentiate between different types of transactions.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Warehouse Management</strong></span>: Utilize the bin location details (<span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">LocationBinUid</strong></code></span>, <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">BinNumber</strong></code></span>, <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">BinType</strong></code></span>) to optimize warehouse space and manage stock locations efficiently. This can support strategies like FIFO (First In, First Out) or LIFO (Last In, First Out) inventory management.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Reporting and Analytics</strong></span>: Generate reports on inventory levels, movements, and order fulfillment efficiency. Use data like <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">EventDate</strong></code></span>, <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Quantity</strong></code></span>, and <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">LocationCode</strong></code></span> to analyze trends over time, identify bottlenecks, or optimize inventory turnover rates.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Integration with Logistics</strong></span>: For products being shipped, the inventory event data can be used to update logistics partners or systems about which items have been dispatched, including details like <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">OrderNumber</strong></code></span> and <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">ContactName</strong></code></span> for tracking and delivery purposes.</div></li></ol><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieves a list of records detailing Inventory movements by item, location, quantity, and unique batch serial number properties. Use 

Returns a list of Inventory movement event records

<p class="slate-p" placeholder="Type / for widgets">Retrieves a list of address location details with associated Contact Name and AccountUid. Returns the primary Billing address and default Shipping address for the contact. Use Shipping address for despatch and receiving destinations, while invoices and bills should target the Billing address.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves a list of address location details with associated Contact Name and AccountUid. Returns the primary Billing address and default Shipping address for the contact. Use Shipping address for despatch and receiving destinations, while invoices and bills should target the Billing address.

OData compliant list response (expand all)

<p class="slate-p " >Retrieves a list of customer, supplier, employee, and other contact records using a filter criteria. Make sure to limit results using the <code class="slate-code">$top</code> directive set to less than the maximum page size of <code class="slate-code"><strong class="slate-bold">500</strong></code>. </p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieves a list of customer, supplier, employee, and other contact records using a filter criteria. Make sure to limit results using the 

<p class="slate-p" placeholder="Type / for widgets">Retrieves a list of locations using a filter criteria. Make sure to limit results using the <code class="slate-code">$top</code> directive set to less than the maximum page size of <code class="slate-code"><strong class="slate-bold">500</strong></code>. </p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves a list of locations using a filter criteria. Make sure to limit results using the 

<p class="slate-p" placeholder="Type / for widgets">Retrieves a list of file attachments using a filter criteria. Make sure to limit results using the <code class="slate-code">$top</code> directive set to less than the maximum page size of <code class="slate-code"><strong class="slate-bold">500</strong></code>. The source transaction is associated with <code class="slate-code">RecordUid</code>, for example when AttachmentType product is defined the <code class="slate-code">RecordUid</code> is an alias for <code class="slate-code">ProductUid.</code></p><p class="slate-p" placeholder="Type / for widgets"><code class="slate-code"></code></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Retrieves a list of file attachments using a filter criteria. Make sure to limit results using the 

. The source transaction is associated with 

, for example when AttachmentType product is defined the 

This endpoint is used to queue a new sale order for creation in the 

 workspace. It handles the comprehensive details of a sale transaction, including transaction headers, customer shipping information, payment details, and individual sale line items.

The minimum required order header is shown below and contains all mandatory fields. It is important to note that either 

 is required and the choice or which field to use will depend on the app developer. It is possible to provide both fields however 

Order types and submission actions can be set using the OrderType and StatusType fields. 

Order Status Type determines the workflow that is applied to an order on submission. When OrderType is O or S, the StatusType can be set as Open (O), (D) Despatch/Ship, or (A) Allocate, in this case the order is placed on pick hold using the default stock allocation pick method.

Where the customer or contact exists within the cloud.WMS workspace and has an assigned Shipping Address there is no requirement to specify address details. On submission the address is initialised with the contacts default shipping details. An example is shown below.

When address details are not preset the format can be freeform or parameterised. If the address is parameterised the ShipAddress tags can be completed as shown below. An internal address decoder will attempt to correct and match freeform fields to parameters however is not 100% accurate.

In the case of freeform address details the address can be assigned using the following rule. By specifying 

 the internal address decoder will be bypassed and each field assigned to corresponding parameters within the order.   

 Tag to indicate this address should not be parsed and pass through directly as order address properties.

In all cases the Address Lines are limited to 50 characters per line. Should the incoming tags exceed this length they will be truncated. It is recommended that the sender ensures that any line that exceeds 50 characters is carried over to the next line breaking on the nearest space from right to left.

In total the address field supports a maximum of 150 characters. A possible work around where FOUR ADDRESS LINES are required is to replace the 

There are special directive fields that change the behaviour of the POST action. Setting  

with the following can determines how certain sale order properties will be configured. Using 

will force the sale order to use the alternate FORM for Order rendering. With 

 any unrecognised shipping method will be created and assigned to the current sale order, this directive should only be used with Standalone WMS. 

Order priority can be set using the following options, note that errors or warnings on order submission may override priority placing it 

The sale lines node needs to repeat mandatory fields for each line item. It is recommended to use either 

 takes into account the unit of measure and is recommended for eCommerce integration use cases. To maximise rounding and tax amount calculation accuracy it is recommended to use Tax Inclusive Unit pricing.  

Directives for setting financial defaults

To simplify the sending of line financial information the 

 will indicate to the api server to use the default value for the product and contact for the specified directive. 

 field and use the Contact default price for the specified Product Code. Using 

 will insert the default TaxCode associated with the Product code or Customer. This can be useful in the case of international or local orders where different taxes may apply.

Each order transaction can subscribe to a web hook service that will be notified as the inventory system performs business events and order status changes. The web hook 

 payload will vary depending on the specific business event that triggers notification, however the transaction will always publish the 

 field must define the URL to send the business event data when a trigger occurs. 

 are optional and will be added to the POST header as a key value pair. 

Sections