Caliq API Documentation

Returns the number of seconds since midnight.
Lightweight option to determine web service availability

Retrieve the list of channels.
A channel is an attribute of an order and tells Caliq where the order came from
Typical values would be 'Web', 'Trade Show', 'Sales Rep'
The channel is a mandatory field when creating an order

Retrieve the list of countries.
Each customer address will have a associated country code

Retrieve the list of currencies
Each customer in Caliq trades in a specific currency. Only orders matching this currency will be accepted

Retrieve the list of customer categories

Retrieve the list of despatch methods.
A despatch method is an attribute of an order and tells Caliq how to goods should be sent to the customer
The despatch method is an optional field when creating an order

Retrieve the list of employees.

Retrieve the list of marketing options.
Multiple options can be set against each contact

Retrieve the list of product groups.
Each group has a level, 1-4, a code and description

Retrieve the list of product level combinations

Retrieve the list of despatch service levels.
It may be desirable to tell Caliq than an order needs to be despatched to the customer via a certain service rather than a specifc despatch method
Typcically service levels might be 'Next Day', 'Saturday AM', 'Named Day' and specify the service required rather than an actual carrier
The service level is an optional field when creating an order

Retrieve the list of customer service levels.
It may be desirable to tell Caliq than an customer needs a specific service leevl rather than the default
Leave null/0 to use the default customer service level or specify the ID to use
The service level is an optional field when creating a customer

Retrieve the list of user defined fields.
Caliq supports multiple user defined fields(UDF) against products and customers. Each UDF has a description and can eaither be a simple text field or a selectable list.

Retrieve the list of warehouses.
A warehouse is an attribute of an order and tells Caliq where to despatch the goods from
The warehouse is an optional field when creating an order

Retrieve the list of system messages.
These will be returned when creating orders and customers in Caliq if there any any issues with the supplied data

Retrieve the list of payment types.
The payment ypes will be require when sending payment data for orders

Retrieve the list of product attributes and filters.

Retrieve the list of api calls made.

Lock an event in Caliq before making changes or payment.
If event is already locked will return message as 'INUSE' If event is locked ok will return 'LOCKED'

Retrieve the list of product surcharge bands

Returns a collection of products which have been added or updated in Caliq since a supplied date
This list can then be used to request full product data
NOTE: Changes to prices or stock levels do NOT count as a product change
and should be refreshed fully each time

Returns a collection of product catalogues and asociated items

Retrieve full product data for a collection of products
You can send either product codes or product ids dending on what you have stored

Retrieve various stock related data values for a specific or all products
You can send either product code or product id dending on what you have stored

Retrieve various stock related data values for a specific or all products for specific warehouse
You can send either product code or product id dending on what you have stored

Retrieve an image for a given product and image type
You can send either a product code or a product id dending on what you have stored

Retrieve the list of supported image types. This is required when asking for an actual product image

Retrieve the price data for specific products, customer and quantity combination

Retrieve Normal standard prices for all products, for specific currency or all
Optionally just return prices for a collection of part numbers or ID's Optionally just return prices for a collection of customer account numbers or ID'

Retrieve RRP prices for all products, for specific currency or all
Optionally just return prices for a collection of part numbers or ID's

Retrieve Promotional prices for all products, for specific currency or all
Optionally just return prices for a collection of part numbers or ID's

Retrieve changes made to product standard costs
You can send a 'from' and 'to' date and all items changed between them will be returned
If the 'to' date is today then from cost will be compared to live standard cost on the product record

Returns a collection of products which are set to discontinued running down stock
Optionally the results can be restricted to just items which have physical stock

Returns a collection of order lines which were created between two dates
Optionally the results can be restricted to just lines sold below cost or below a specific margin

Returns a collection of products which may need reordering

Retrieve details of all areas for a given warehouse

Retrieve details of all aisles for a given warehouse

Retrieve details of all handling areas for a given warehouse

Retrieve details of bins map for a given warehouse

Retrieve details of all bins containing stock of a list of supplied products

Retrieve details of all products with stock in a list of supplied bins

Retrieve list of all stock adjustment reason codes

Make a stock adjustment to a bin qty

Make a scrap note adjustment to a bin qty

Make a stores issue adjustment (remove from) to a bin qty

Make a stores return adjustment (add to) to a bin qty

Relocate stock from one bin to 1 or more others

Retrieve details of all shipments awaiting picking

Retrieve full details of selected shipments

Route a shipment

Set loading bay against a shipment

Create a new deliverable

Query details for a deliverable

Print deliverable label

Change handling area for a deliverable

Relocate stock from deliverable

Mark a shipment as started picking

Pick a line from a picking note

Cancel shipment out of warehouse putting stock into GRAL

Confirm picking note as fully picked

Mark a shipment as started loading

Load a line from a picking note

Cancel loading out of warehouse putting stock into GRAL

Confirm picking note as fully loaded

Returns a collection of customers which have been added or updated in Caliq since a supplied date
This list can then be used to request full customer data

Retrieve full customer data for a collection of customers
You can send either account numbers or customer ids dending on what you have stored

Create a new customer account

Add an additional permanent address to an existing customer account
You must send a customer id or account number along with the address details

Update an existing address on an existing customer account
You must send a customer id or account number along with the address details
Any part of the data which is supplied as null will be left as is in Caliq

Update the WebContactID contact on an existing customer account
All existing marketing data will be removed and replaced with the supplied data so you must always supply the full set
You must send a customer id or account number along with the contact details
Any part of the data which is supplied as null will be left as is in Caliq

Update just the marketing options on an existing customer account/contact
This operates on a specific marketing option at a time
You must send a customer id or account number along with the marketing details
If you supply the ContactID then this will be updated. If this is 0 or missing then the main web contact will be updated

Retrieve a list of all items purchased by a specific customer over a date range
Data can be based on orders or invoices and over a variable number of months
Only items in stock or where the item wil be back in stock within n weeks

Retrieve a list of all top selling items by customer category
Data can be based on sales qty, value or margin
Only items in stock will be included

Create a new customer interaction in Caliq. Must be created on an already existing customer

Retrieve customer CPA for a collection of customers
You can send either account numbers or customer ids dending on what you have stored
This is a legacy API feature and should only be used if directed by Caliq

Retrieve a list of 'orders' for a specific customer, or all and time frame
Can return orders, credits and returns
You can send either account number or customer ID dending on what you have stored
Leave customer fields empty to get all orders changes since date

Retrieve the breakdown of a specific order, credit or customer return
You can send either order number or order ID dending on what you have stored

Retrieve the list of outstanding order lines for a specific customer
You can send either account number or customer ID dending on what you have stored

Create a new sales order in Caliq. Must be created on an already existing customer

Retrieve a list of despatches for a specific order or time frame
You can send either order number or order ID dending on what you have stored

Returns a collection of orders which have been added or updated in Caliq since a supplied date
This list can then be used to request full order data

Retrieve a list of sales ledger transactions for a specific customer account
You can send either account number or customer id dending on what you have stored

Return a list of all invoices and credits for a specific customer or all customers,
raised between 2 specified dates.

Retrieve a pdf copy of an Caliq pdf document
You must send a document id which would have been returned as part of an order or ledger query, or from an EventDocuments list
InvoicePDF has since been replaced with DocumentPDF but functionailty remains the same in both

Retrieve a pdf copy of an Caliq pdf document
You must send a document id which would have been returned as part of an order or ledger query, or from an EventDocuments list
InvoicePDF has since been replaced with DocumentPDF but functionailty remains the same in both

Retrieves the sales intake data for a range of dates
Can be optionally filtered for a collection of products
'NEW' new order line added, 'CANC' line cancelled, 'QCH' quantity of line changed, 'PCH' price of line only changed without qty change, 'QPCH' price and qty both changed

Return a list of all payments received between 2 dates

Return a list of all outstanding purchase orders and lines

Retrieve a list of orders for a specific pick trip id

Retrieve a list of customers who have a back order of some sort

Retrieve a list of order movements through the warehouse
Each entry maps to a consignment undergoing a warehouse process

Make a payment against an order, proforma or specific invoices for a customer

Update certain values of an order after it has been placed. Orders already in the warehouse are not changeable
Order must be locked before calling
Any value passed as null will be ignored and NOT updated

Special routine to add data to Caliq holding order - not normally used

Special routine to delete data to Caliq holding order - not normally used

Special routine to despatch data from Caliq holding order - not normally used