Term

Description

Container

Cube-IQ uses the word 'Container' for anything that can contain other objects. So, a Container can be a standard ocean container, but also a truck, a rail car, a pallet, a crate, a box, or even an irregularly shaped airline container or pallet (ULD).  

Load

A Load is a single shipment or order that is to be planned. It consists of one or more products and one or more containers. It must also have a unique id which is typically a PO number or some other identifier.

Product

A Product is defined as any object that can be loaded into one of Cube-IQ's Containers. The object must be rectangular, cylindrical or 'sofa'-shaped (a 3-dimensional L-shape). Examples of rectangular objects are boxes, cartons, or even whole pallets. Cylindrical objects are for example drums, rolls or tubes.  

Optimize, Optimization

The process of placing one or more products into one or more containers, based on various optimization and business rules.

API request

The combination of an HTTP method, a URL to the API service, a URI to the resource, optional query parameters for filtering and pagination, HTTP request headers including the Authorization header with the access token, and, if required, a JSON-formatted request body.

API version

The API version, which you append to the endpoint. For example, the version in this endpoint is v1

http://api.magiclogic.com/db/v1

endpoint

The URL through which you access an API. For example:

http://api.magiclogic.com

namespace

A logical grouping of application, data, and its metadata. For example:

https://api.magiclogic.com/db/v1/loads

query parameter

A type of parameter that you include on the request URI to filter and sort the items that are returned in an API response and limit the size of the data returned in that response.

resource

A named thing in a namespace, such as a product transaction, against which you call REST methods.

For example you can complete a GET operation against this single resource to fetch a load:

https://api.magiclogic.com/db/v1/load/loadid

resource collection

A REST resource against which you call the REST GET method to list resources.

For example, you can complete a GET operation against this resource collection to list products:

https://api.magiclogic.com/db/v1/products

webhook

An HTTP callback that receives notification messages for an event - see webhooks