We are constantly developing new integrations to help you create a business tool ecosystem and automate routine processes to the fullest. With this goal in mind, we’ve introduced several improvements to the Public API, enabling you to integrate Orderry with third-party services on your own. Today, we’re excited to present both brand-new API methods and updates to existing ones.
Leads
The method for retrieving a list of leads now supports the following query parameters:
modified_at – filter by the date the leads were updated.
closed_at – filter by the date the leads were closed.
Additionally, the response now includes full details for each lead:
created_at – the date the lead was created.
modified_at – the date the lead was updated.
closed_at – the date the lead was closed.
rel_obj – the object associated with the lead (order, sale).
Orders (Work Orders / Tickets / Jobs)
Create Order
The method for creating orders now supports the optional parameter asset_id.
Get Orders
The method for retrieving a list of orders now returns a uom (unit of measurement) object for products and services, which includes:
id – the ID of the unit of measurement.
title – the short name.
description – the full name.
New Method: Get Order by ID
With this method, you can retrieve data for a specific order using its ID.
The method for retrieving a list of sales now supports the query parameter created_at, allowing you to filter by the date of sale creation. It also returns a uom object for products and services with details such as id, title, and description.
New Method: Create Payment
This method allows you to automate payment creation in Orderry when payments are made in other services.
New Method: Get Cashflow Items
If you use cashflow items, you can now retrieve their list using this method.
Get Cash Transactions
The method for retrieving cash transactions now includes the cashflow_item parameter (the name and type of cashflow item: income or expense). Additionally, it returns client_id (the client ID if specified in the payment) and related_document (the document linked to the payment, such as an order, sale, or reimbursement).
The method for retrieving a list of company invoices now includes the parameters code (product code) and article (product SKU).
If you work with assets (such as devices, vehicles, etc.) in other systems, we’ve prepared a set of new Public API methods for this purpose.
Get Assets
Use this method to get a list of assets in your account along with all their details, including ID, serial number/VIN/IMEI, group data, brand, model, owner, and more.
Get Asset by ID
Use this method to retrieve data for a specific asset using its ID.
Get Asset Custom Fields
This method allows you to retrieve a list of custom fields for assets from the "Settings > Form Editor > Assets" page.
Create Asset
Use this method to create new assets in your account. Ensure that all required fields (as marked on the "Settings > Form Editor > Assets" page) are completed.
Update Asset
This method allows you to update asset details, such as serial number, owner, group, brand, model, and other fields.
Move Asset
Use this method to transfer assets to other warehouses.
Get Asset Directory Values
This method retrieves all elements from the hierarchical directory Group-Brand-Model-Modification for assets, along with their IDs.
We’ve added new methods and improved existing ones for working with clients, including fixing custom field functionality.
New Method: Get Client by ID
This method allows you to retrieve all available data for a specific client using their ID.
New Method: Merge Clients
Use this method to merge duplicate clients by specifying all duplicate IDs and the ID of the client to consolidate them into.
Create Client and Update Client
These methods now support the query parameters first_name and last_name, allowing you to create and update clients more accurately.
Get Clients
This method now supports the ids[] parameter, enabling you to retrieve data for specific clients by their IDs.
We’ve prepared four entirely new methods for working with your company’s product catalog.
Get Products
Use this method to retrieve a list of your company’s products from the "My Company > Products" page.
Get Product by ID
Use this method to retrieve details of a specific product by its ID.
Create Product
This method allows you to add new products to your catalog. Note that it does not set product stock levels—it only creates the product profile on the "My Company > Products" page.
Update Product
Use this method to update product details such as category, name, description, prices, and more.
For services, we’re introducing four new methods as well.
Get Service Categories
This method allows you to get a list of your company’s service categories with their names and IDs, which can then be used for creating or updating services.
Get Services
Use this method to retrieve a list of services, including their categories, units of measurement, warranty details, prices, and more.
Create Service
This method enables you to create new services in your account.
Update Service
Use this method to update details of your company’s services, such as names, prices, categories, units of measurement, and more.
Upcoming Improvements to Orderry’s Public API
We are already working on new API methods that will allow you to manage estimates, add services and products to orders with or without stock deduction, and set up integrations with online stores and marketplaces.
Soon, you’ll also be able to use the API to create, edit, close, and retrieve tasks.
If you have any questions, suggestions, or comments about Orderry’s Public API, please contact our Support Team via chat.