i.LEVEL API Introduction
Welcome to the i.Level API! You can use our API to access i.Level API endpoints, which can get information on various resources in our database. The introduction looks at some key concepts that apply to the various API calls.
The following sections detail the key resources exposed with the API. Examples are provided in JSON format. Please review the Change Log for important updates.
Authentication
In order to use the API it is necessary to obtain a username and key. Support will create and issue this key from the instance of i.Level you wish to connect to. Please specify which resources and methods you will be using as these will be set up based on our agreement with our customer.
Response Details
Example of header details
{
"response": {
"Page": 1,
"PageCount": 2301,
"RecordsSent": 1,
"RecordsFound": 2301,
"Stock": [
{
"SKUSize": "A0000001010A"
}
]
}
}
Each response from a GET call returns the same base structure. Header details provide information about pagination and record details.
| Property | Example | Description |
|---|---|---|
| Page | 1 | The current page returned for the GET request |
| PageCount | 13 | The total number of pages that would need to be parsed based on the request and PageSize specified |
| RecordsSent | 100 | The number of records returned by the request |
| RecordsFound | 1296 | The number of records found based on the request parameters |
Request Pagination
Due to the number of records that can be returned from any given request it is necessary to control the size of the response. This is done through pagination control. The table below shows the pagination request parameters which can be used.
| Property | Example | Description |
|---|---|---|
| Page | URL/api/stock?page=2 | The page that you wish to retrieve. By default the first page will be returned. |
| PageSize | URL/api/stock?page=2&pagesize=250 | The maximum number of records you wish to return. The default is 100 and the maximum is set at 1000 |
Count
Example count response
{
"count": 581
}
Sometimes you may simply want to check how many records might be returned by a GET request. This can be done with the count parameter.
| Property | Example | Description |
|---|---|---|
| Count | URL/api/stock/count?sku=a@ | Returns a count of the number of records where SKU starts with 'A'. |
Filtering
http://URL/api/stock?barcode=5060395910013
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"Stock": [
{
"SKU": "A0000001010",
"SKUSize": "A0000001010A",
"Colour": "OFF WHITE",
"Size": "S",
"Size_Sort": 1,
"Barcode": "5060395910013",
"Style": "A0000001",
"Article": "FLORAL 1",
"Size_Range": "S - 3XL",
"In_Stock": 58,
"Demand": 0,
"Supply": 2,
"Available": 60,
"Web_Description": "",
"Product_Group": "Long Sleeve Shirts",
"Brand_Name": "iLEVELman",
"Season": "AW16",
"Brand_Style": "",
"Cost_Centre": "",
"Foreign_Stock_Code": "",
"Origin": "China",
"Fabric_Content": "100% Cotton",
"Stock_Change_TS": "20170320153348",
"Discontinued": false,
"Retail_Price_Own_Currency": 32,
"Retail_Price_Currency1": 0,
"Retail_Price_Currency2": 0,
"Sell_Price1": 12,
"Sell_Price2": 0,
"Sell_Price3": 0,
"Sell_Price4": 11.5,
"Sell_Price5": 12,
"Sell_Price6": 12,
"Sell_Price7": 0,
"Sell_Price8": 0,
"Sell_Price9": 0
}
]
}
}
It is possible to use simple filtering on resources by passing key pair values for field names and values. Simply pass the field you wish to filter on and the value you wish to find. Please see the individual resources for details of fields which filters can be used with. For more complex queries please see Query for details. Example below is from the stock resource.
| Property | Example | Description |
|---|---|---|
| Count | URL/api/stock?barcode=5060395910013 | Returns all stock with a Barcode equal to 5060395910013. |
Ordering
http://URL/api/stock?order_by=season;>
Will return all stock ordered by season.http://URL/api/stock?order_by=season;colour;<
Will return all stock ordered by season and then by colour in reverse order.
It is possible to use perform server side ordering on the returned data. Simply use the order_by keyword followed by the field you wish to order by. By default the order will be performed in alphabetic, numerical or date order dependent on the field type. If the sort order indicator is used > or < you can control the order.
Multiple order fields can be combined to carry out multi level sorting of the returned data.
Fields
http://URL/api/stock?fields=barcode,colour,size
Will return all stock with just the specified fields.
{
"response": {
"Page": 1,
"PageCount": 2301,
"RecordsSent": 1,
"RecordsFound": 2301,
"Stock": [
{
"SKUSize": "A0000001010A",
"Colour": "OFF WHITE",
"Size": "S",
"Barcode": "5060395910013"
}
]
}
}
Using the "fields" key word you can specify which fields you wish to return from the resource. Some resources will also return mandatory fields.
Exclude
http://URL/api/stock?exclude=@price@,@size@,@brand@,@code&pagesize=1
Will return all stock with the specified fields ommitted.
{
"response": {
"Page": 1,
"PageCount": 2301,
"RecordsSent": 1,
"RecordsFound": 2301,
"Stock": [
{
"SKU": "A0000001010",
"SKUSize": "A0000001010A",
"Colour": "OFF WHITE",
"Style": "A0000001",
"Article": "FLORAL 1",
"In_Stock": 58,
"Demand": 0,
"Supply": 2,
"Available": 60,
"Web_Description": "",
"Product_Group": "Long Sleeve Shirts",
"Season": "AW16",
"Cost_Centre": "",
"Origin": "China",
"Fabric_Content": "100% Cotton",
"Stock_Change_TS": "20170320153348",
"Discontinued": false
}
]
}
}
Using the "exclude" key word you can exclude fields and linked resources from the returned data. Some resources may ignore a call to exclude mandatory fields. Exclude will also support the @ wildcard to exclude a group of fields with a similar name pattern.
Examples:
http://URL/api/stock?exclude=@price@,@size@,@brand@,@code&pagesize=1
This will remove all properties that contain 'price', 'size' or end in 'code'. Notice the Key field SKUSize has not been removed as this is a mandatory field.
Query
http://URL/api/stock with request containing a query object array
{
"query": [
{
"field": "sell_price1",
"operator": "<=",
"value": "12"
},
{
"conjunction": "&",
"field": "size",
"operator": "=",
"value": "s"
}
]
}
Sometimes simple filtering is not sufficient to return complex selection requirements. In these cases you can use the request query object to carry out more complex queries on the resource. The example code finds all stock items where the value of sell_price1 is less than or equal to 12 and the size is equal to "S".
The query object can be used in conjunction with filtering but be aware that the query object will be applied first and then any filtering will be carried out on the subsequent selection.
| Property | Example | Description |
|---|---|---|
| field | size | Should be any valid field in the resource model. |
| operator | = | Valid values are =, #, <=, >=, >, < |
| value | "S" | Values should be consistent with the data type of the field you are searching in. Text values are case insensitive. Dates should be in the format 2017-06-27. Booleans should be expressed as True or False. |
| conjunction | & | Valid values are '&' = AND, '|' = OR and '#' = EXCEPT. |
Query Selection
http://URL/api/stock with request containing a query object array and a queryselection array
{
"query": [
{
"conjunction": "&",
"field": "size",
"operator": "=",
"value": "s"
},
{
"conjunction": "|",
"field": "size",
"operator": "=",
"value": "m"
}
],
"queryselection": [
{
"field": "sell_price1",
"operator": "<=",
"value": "12"
}
]
}
While our developers were working on a project using the REST services they realised that sometimes more complex queries are more easily broken up by doing a query and then a further query on th resulting selection. This can be achieved by passing queryselection in the same way as query but as a seperate array of arguments.
The queryselection object will be performed after any query and before any filters.
| Property | Example | Description |
|---|---|---|
| field | size | Should be any valid field in the resource model. |
| operator | = | Valid values are =, #, <=, >=, >, < |
| value | "S" | Values should be consistent with the data type of the field you are searching in. Text values are case insensitive. Dates should be in the format 2017-06-27. Booleans should be expressed as True or False. |
| conjunction | & | Valid values are '&' = AND, '|' = OR and '#' = EXCEPT. |
Query With Array
http://URL/api/concessionstock with request containing a querywitharray
{
"querywitharray": {
"field": "store_code",
"values": [
"TSMeado",
"TSOxfor"
]
}
}
The query with array object allows for the passing of a field and an array of values. This will return a selection that matches the elements of the arrays.
The querywitharray should not be used in conjunction with the query object but can be used before either the queryselection or queryselectionwitharray objects.
| Property | Example | Description |
|---|---|---|
| field | store_code | Should be any valid field in the resource model. |
| operator | = | Valid values are =, #, <=, >=, >, < |
| values | [] | Array of values should be consistent with the data type of the field you are searching in. Text values are case insensitive. Dates should be in the format 2017-06-27. Booleans should be expressed as True or False. |
Query Selection With Array
http://URL/api/concessionstock with request containing a queryselectionwitharray
{
"queryselectionwitharray": {
"field": "store_code",
"values": [
"TSMeado",
"TSOxfor"
]
}
}
The query selection with array object allows for the passing of a field and an array of values. This will return a selection that matches the elements of the arrays.
The queryselectionwitharray should be used sfter the query or querywitharray objects and can be used in conjunction with the queryselection object but can be used before either the queryselection or queryselectionwitharray objects. The queryselectionwitharray object will be performed after any query and before any filters.
| Property | Example | Description |
|---|---|---|
| field | store_code | Should be any valid field in the resource model. |
| operator | = | Valid values are =, #, <=, >=, >, < |
| values | [] | Array of values should be consistent with the data type of the field you are searching in. Text values are case insensitive. Dates should be in the format 2017-06-27. Booleans should be expressed as True or False. |
Query using POST
http://URL/api/stock/query pass queryObject as the request body. If using POST specify the additional query parameter.
When testing the REST API with jQuery and ajax it became apparent that some environments restrict the sending of a body with a GET request. Following this we went through various steps to understand how to allow the query functionality whilst keeping our rules simple. Looking at other environments they seem to have got round the restriction by using a POST. Whilst this is not elegant it does work.
OPTION 1 - USE GET with BODY (if allowed from your environment) http://URL/api/stock pass queryObject as the body defined as one of the above object formats.
OPTION 2 - USE POST method http://URL/api/stock/query where query is passed as an additional parameter similar to how count works.
In this usage the client can send a body payload because POST is used but the server will treat it like a GET and process the request as normal using the request body.
Q. Why can I not use get and just pass a query key pair parameter with the URL? A. We did consider this as an option but quickly hit the limitations of the text which can be sent as part of the URL.
Change Log
Below are the changes to the current version of the API and documentation. Please check the version of i.LEVEL you are using against the change log to ensure you are using available resources in the correct manner.
v5617 - v1.0 2018-09-12
• Added Contact resource to allow access to contact information. • Added Utility and Lookups section to documentation with new utility functions. * Added Version to documentation under utility • Added Size Range resource to provide details of the size ranges and size details. * Updated the Trade Order resource to ensure trade orders can be put correctly. * Added POST capability for the Customer and Outlet resources to support the Mobile application. * Specific changes have been made to support the Mobile application migration from SOAP to the REST API.
v5616 - v1.0 2018-07-03
• Updated i.LEVEL to support SKUSizes passed with underscores when posting to tradeorder. • Updated i.LEVEL to support filtering stock by SKUSize with underscores instead of spaces being present. * Updated i.LEVEL to support Query functions using SKUSize with underscores instead of spaces being present • Updated documentation to reflext above changes. * Added Device resource to return a list of all scanning devices Device. * Added Return resource to get a list of all trade returns Return. * Added Return Item resource to get a list of trade return items Return Item.
v5614 - v1.0 2018-06-18
• Updated documentation to reflect Query using POST • Updated documentation from Beta to Production release.
v5613c - 2018-01-17
Added Product resource to retrieve styles with related variants. • Added Query Selection Extension of query object to allow queries in selections made with query. • Added Query With Array New query object to allow queries based on passed arrays. • Added Query Selection With Array New query object to allow queries based on passed arrays in selections made with query or query with array.
v5613 - 2018-01-09
• Added Agent resource to retrieve agent details. • Added ConcessionStoreDetail resource to retrieve store details. • Added ConcessionStoreNote resource to retrieve, create, update and delete store notes. • Added ConcessionStock resource to retrieve concession stock.
v5612 - 2017-12-07
• Added ConcessionHost resource to retrieve concession & ecomm hosts. • Added ConcessionStore resource to retrieve concession & ecomm stores. • Updated Customer resource to include Association, Company_Reg_No, TAX_Number & TAX_Type attributes.
v5612 - 2017-12-05
• Updated documentation from Alpha to Beta release. • Added MultipleWarehouse resource to get all multiple warehouse instances. • Added MWStock resource to obtain multiple warehouse stock data. • Updated RetailOrder resource to include new Warehouse_id attribute. • Updated RetailOrderItem resource to include new Return_Qty attribute.
Utility and Lookups
This section is dedicated to uitility calls and lookup lists which can be obtained via the API. Due to the nature of the calls and the size of the lookups many of the standard paging, query and sorting functions associated with general resources are not present.
Version
This returns the current version of i.LEVEL or an ilevel related application. This is the only call that dooes not require authentication to call.
Example of a returned version information.
{
"version": "4DU15_V15.05617"
}
| GET | /api/version |
|---|
Returns the i.LEVEL version as per example.
| GET | /api/version?app=Mobile |
|---|
Returns the version of Mobile installed for the i.LEVEL installation. Other options are app=StoreController and app=api
Version called to get the version of Mobile currently active. /api/version?app=Mobile
{
"version": "1.0.26"
}
If the app parameter is not recognised or the module is not installed the version resource will return "Unknown".
Example of unidentified version.
{
"version": "Unknown"
}
Company Info
This returns key company information. Currently this call is used by the i.LEVEL Mobile application.
Example of a returned company information.
{
"response": {
"Name": "ABC Limited",
"Address1": "Unit 10 Fashion Lane",
"Address2": "Anyplace",
"Address3": "AnyTown",
"Address4": "MK40 2TE",
"Telephone": "01234 761758",
"Fax": "",
"Email": "help@ilevelsupport.co.uk",
"Web_URL": "www.ilevelsooftware.co.uk",
"VAT_Number": "XXX XXXX XXX",
"Reg_Number": "XXXXXXXX",
"GLN_ILN_Code": "false",
"Delivery_Window": 0,
"Order_Ack_Clause": "",
"Prices_Action": "Hide",
"Season_Lock": 0,
"Trade_Names": [
{
"Name": "Religion",
"Logo": "BAS64ENCODEDIMAGETEXT"
}
],
"Seasons": [
"ST16",
"AW16",
"WT16",
"SS16",
"CORE",
"FLOW",
"MISC",
"SS17",
"SPEC",
"CCOR",
"CFLO",
"SMS1",
"SMS2",
"SMS3",
"SMS4",
"AW17",
"ST17",
"WT17",
"NOOS",
"RPTS",
"SS18",
"ST18",
"AW18",
"CLEA",
"WT18",
"SS19"
]
}
}```
Property | Example | Description
--------- | ------- | -----------
Name | "ABC Limited" | Name of the company
Address1 | "Unit 10 Fashion Lane" | Address line 1
Address2 | "Anyplace" | Address line 2
Address3 | "AnyTown" | Address line 3
Address4 | "MK40 2TE" | Address line 4
Telephone | "01234 761758" | Telephone number.
Fax | "" | Fax number
Email | "help@ilevelsupport.co.uk" | Email address
Web_URL | "www.ilevelsoftware.co.uk" | Website URL
VAT_Number | "XXX XXXX XXX" | VAT number
Reg_Number | "XXXXXXXX" | Company registration number
GLN_ILN_Code | "help@ilevelsupport.co.uk" | Email address
Delivery_Window | "help@ilevelsupport.co.uk" | Email address
Order_Ack_Clause | "help@ilevelsupport.co.uk" | Email address
Prices_Action | "help@ilevelsupport.co.uk" | Email address
Season_Lock | "help@ilevelsupport.co.uk" | Email address
Trade_Names | [] | An object array containing tradenames and images
Seasons | [] | A text array containing a list of season lock excptions
GET | */api/companyinfo*
----|-------------------
Returns the company info as per example.
## Currency
This call returns all the active currencies within i.LEVEL.
> Example of a returned currency information.
```json
{
"response": {
"Own_Currency": 1,
"Currency": [
{
"id": 1,
"code": "GBP"
},
{
"id": 2,
"code": "EUR"
},
{
"id": 3,
"code": "USD"
},
{
"id": 4,
"code": "IEU"
},
{
"id": 5,
"code": "IUS"
},
{
"id": 6,
"code": "SEK"
},
{
"id": 7,
"code": "EUD"
}
]
}
}
| Property | Example | Description |
|---|---|---|
| Own_Currency | 1 | The id of the currency which is used by the company as their own currency. |
| Currency | [] | An object array containing all currency id's and codes |
| GET | /api/currency |
|---|
Returns the currency info as per example.
Size Range
Size Range provides access to the sizerange resource. This is where all size ranges are defined.
What you can do with sizerange:
URL/api/sizerangeReturns all sizerange items in the system with all available published fields.
Size Range Properties
Example of a returned stock object with all fields
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"SizeRange": [
{
"id": 835,
"Title": "Womens",
"Obsolete": false,
"Replen_Pack_Percent": 0,
"ReplenPack_Zero": 0,
"Replenishment_Method": "Non",
"Packs": [
{
"id": 1,
"Pack_Name": "Test",
"Quantities": [
{
"sizesort": 1,
"qty": 2
},
{
"sizesort": 2,
"qty": 2
},
{
"sizesort": 3,
"qty": 2
},
{
"sizesort": 4,
"qty": 2
},
{
"sizesort": 5,
"qty": 2
},
{
"sizesort": 6,
"qty": 6
}
]
}
],
"Sizes": [
{
"sizesort": 1,
"size": "6",
"EU": "",
"US": "",
"assort": 1,
"minatstore": 0,
"replenqty": 0
},
{
"sizesort": 2,
"size": "8",
"EU": "",
"US": "",
"assort": 2,
"minatstore": 0,
"replenqty": 0
},
{
"sizesort": 3,
"size": "10",
"EU": "",
"US": "",
"assort": 2,
"minatstore": 0,
"replenqty": 0
},
{
"sizesort": 4,
"size": "12",
"EU": "",
"US": "",
"assort": 2,
"minatstore": 0,
"replenqty": 0
},
{
"sizesort": 5,
"size": "14",
"EU": "",
"US": "",
"assort": 2,
"minatstore": 0,
"replenqty": 0
},
{
"sizesort": 6,
"size": "16",
"EU": "",
"US": "",
"assort": 1,
"minatstore": 0,
"replenqty": 0
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 835 | The unique id of the size range |
| Title | "Womens" | The name of the size range |
| Obsolete | false | Inddicates that the size rangee is obsolete |
| Replen_Pack_Percent | 0 | Percentage stock level wwhen replenishment should kick in |
| Replen_Pack_Zero | 0 | If set then replenishment will kick in when the number of sizes matched the value |
| Replenishment_Method | "Non" | Indicates the replenishment method options are: Non, 1 for 1, Min at Store, By Pack |
| Packs | [] | An array of optional packs and size quantities. Will only appear if they exist. See example for details. |
| Sizes | [] | An array of the sizes and size related data for the size range. See example for details. |
Size_Data property
Size_Data is a sub property of the Sizes array. By default this property is included but can be excluded using the exclude option or when sspecifying specific fields it should be specified or left out as required. When included EU and US size names will appear in thee Sizes array data.
Stock
Stock provides access to the stock resource. This is where all product variant level details are held.
What you can do with Stock:
URL/api/stockReturns all stock items in the system with all published fields.URL/api/stock?stock_type=retailReturns all stock items, allocated to retail web, with retail prices.URL/api/stock?stock_type=tradeReturns all stock items, allocated to trade web, with trade prices.URL/api/stock?stock_type=trade&fields=skusize,barcode,in_stock,demandReturns trade stock with a subset of fields.
Stock Properties
Example of a returned stock object with all fields
{
"response": {
"Page": 1,
"PageCount": 24,
"RecordsSent": 100,
"RecordsFound": 2301,
"Stock": [
{
"SKU": "A0000001010",
"SKUSize": "A0000001010A",
"Colour": "OFF WHITE",
"Size": "S",
"Size_Sort": 1,
"Barcode": "5060395910013",
"Style": "A0000001",
"Article": "FLORAL 1",
"Size_Range": "S - 3XL",
"In_Stock": 58,
"Demand": 0,
"Supply": 2,
"Available": 60,
"Web_Description": "",
"Product_Group": "Long Sleeve Shirts",
"Brand_Name": "iLEVELman",
"Season": "AW16",
"Brand_Style": "",
"Cost_Centre": "",
"Foreign_Stock_Code": "",
"Origin": "China",
"Fabric_Content": "100% Cotton",
"Stock_Change_TS": "20170320153348",
"Discontinued": false,
"Retail_Price_Own_Currency": 32,
"Retail_Price_Currency1": 0,
"Retail_Price_Currency2": 0,
"Sell_Price1": 12,
"Sell_Price2": 0,
"Sell_Price3": 0,
"Sell_Price4": 11.5,
"Sell_Price5": 12,
"Sell_Price6": 12,
"Sell_Price7": 0,
"Sell_Price8": 0,
"Sell_Price9": 0
}
]
}
}
| Property | Example | Description |
|---|---|---|
| SKU | "A0000001010" | Style/Colour code for the stock item |
| SKUSize | "A0000001010A" | Unique SKU/Size for the stock item |
| Colour | "OFF WHITE" | The Colour name |
| Size | "S" | The size code |
| Size_Sort | 1 | The sort order for the size within the SKU |
| Barcode | "5060395910013" | Barcode for the item (usually EAN) |
| Style | "A0000001" | Style code (between 3 and 8 characters) |
| Article | "FLORAL 1" | The article name |
| Size_Range | "S - 3XL" | Size range name |
| In_Stock | 58 | Current in stock value |
| Demand | 0 | Total forward demand from customer orders |
| Supply | 2 | Current on supply order quantity |
| Available | 60 | In stock less demand plus supply |
| Web_Description | "" | Extended text description used for web sites |
| Product_Group | "Long Sleeve Shirts" | Product group name |
| Brand_Name | "iLEVELman" | Brand name |
| Season | "AW16" | Season code |
| Brand_Style | "" | Brand style |
| Cost_Centre | "" | Cost centre |
| Foreign_Stock_Code | "" | Alternative stock code. Can be used to link to another system |
| Origin | "China" | Where the product was created |
| Fabric_Content | "90% Cotton, 10% Polyester" | Fabric content of the product |
| Stock_Change_TS | "20170320153348" | Last change to the stock record |
| Discontinued | false | Boolean field indicating the product has been discontinued |
| Retail_Price_Own_Currency | 32 | Retail RRP of the product in own currency |
| Retail_Price_Currency1 | 0 | Retail RRP of the product in another currency (usually EUR) |
| Retail_Price_Currency2 | 0 | Second alternative RRP in alternative currency |
| Sell_Price1 | 12 | Trade selling price (own currency) |
| Sell_Price2 | 0 | Trade selling price currency 2 |
| Sell_Price3 | 0 | Trade selling price currency 3 |
| Sell_Price4 | 11.5 | Trade selling price currency 4 |
| Sell_Price5 | 12 | Trade selling price currency 5 |
| Sell_Price6 | 12 | Trade selling price currency 6 |
| Sell_Price7 | 0 | Trade selling price currency 7 |
| Sell_Price8 | 0 | Trade selling price currency 8 |
| Sell_Price9 | 0 | Trade selling price currency 9 |
Stock Methods
Example of a returned stock object with trade specific fields
{
"response": {
"Page": 1,
"PageCount": 24,
"RecordsSent": 100,
"RecordsFound": 2301,
"Stock": [
{
"SKU": "A0000001010",
"SKUSize": "A0000001010A",
"Colour": "OFF WHITE",
"Size": "S",
"Size_Sort": 1,
"Barcode": "5060395910013",
"Style": "A0000001",
"Article": "FLORAL 1",
"Size_Range": "S - 3XL",
"In_Stock": 58,
"Demand": 0,
"Supply": 2,
"Available": 60,
"Web_Description": "",
"Product_Group": "Long Sleeve Shirts",
"Brand_Name": "iLEVELman",
"Season": "AW16",
"Brand_Style": "",
"Cost_Centre": "",
"Foreign_Stock_Code": "",
"Origin": "China",
"Fabric_Content": "100% Cotton",
"Stock_Change_TS": "20170320153348",
"Discontinued": false,
"Sell_Price1": 12,
"Sell_Price2": 0,
"Sell_Price3": 0,
"Sell_Price4": 11.5,
"Sell_Price5": 12,
"Sell_Price6": 12,
"Sell_Price7": 0,
"Sell_Price8": 0,
"Sell_Price9": 0
}
]
}
}
Example of a returned stock object with retail specific fields
{
"response": {
"Page": 1,
"PageCount": 24,
"RecordsSent": 100,
"RecordsFound": 2301,
"Stock": [
{
"SKU": "A0000001010",
"SKUSize": "A0000001010A",
"Colour": "OFF WHITE",
"Size": "S",
"Size_Sort": 1,
"Barcode": "5060395910013",
"Style": "A0000001",
"Article": "FLORAL 1",
"Size_Range": "S - 3XL",
"In_Stock": 58,
"Demand": 0,
"Supply": 2,
"Available": 60,
"Web_Description": "",
"Product_Group": "Long Sleeve Shirts",
"Brand_Name": "iLEVELman",
"Season": "AW16",
"Brand_Style": "",
"Cost_Centre": "",
"Foreign_Stock_Code": "",
"Origin": "China",
"Fabric_Content": "100% Cotton",
"Stock_Change_TS": "20170320153348",
"Discontinued": false,
"Retail_Price_Own_Currency": 32,
"Retail_Price_Currency1": 0,
"Retail_Price_Currency2": 0
}
]
}
}
| GET | /api/stock |
|---|
Returns all stock in the system with all published fields.
| GET | /api/stock?stock_type=trade |
|---|
Returns all stock allocated for use with trade web with trade specific fields.
| GET | /api/stock?stock_type=retail |
|---|
Returns all stock allocated to retail web with retail specific fields.
Product
Product provides an alternative view of the styles and variants using the product resource. Styles can be retrieved with their associated SKUSize variants.
What you can do with Product:
URL/api/productReturns all styles in the system with all published fields and related Items (SKUizes).
Product Properties
Example of a returned product object with all fields
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"Product": [
{
"Style": "A0000002",
"Article": "FLORAL 2",
"Brand": "iLEVELman",
"Size_Range": "ONE",
"Product_Group": "Long Sleeve Shirts",
"Season": "AW17",
"Commodity_Code": "",
"Cost_Centre": "Misc",
"Care_Instructions": "",
"Fabric_Content": "100% cotton",
"Lining": "",
"Material_Fabric": "100% cotton",
"Outer": "",
"Origin": "",
"Items": [
{
"SKU": "A0000002003",
"SKUSize": "A0000002003A",
"Colour": "RED",
"Size": "ONE",
"Size_Sort": 1,
"Barcode": "5060395910068",
"In_Stock": 95,
"Demand": -2,
"Supply": 2,
"Available": 95
},
{
"SKU": "A0000002022",
"SKUSize": "A0000002022A",
"Colour": "BLUE",
"Size": "ONE",
"Size_Sort": 1,
"Barcode": "5060395910075",
"In_Stock": 95,
"Demand": -6,
"Supply": 3,
"Available": 92
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| Style | "A0000002" | Style/Colour code for the stock item |
| Article | "FLORAL 2" | Article name |
| Brand | "iLEVELman" | Brand code |
| Size_Range | "ONE" | Size range |
| Product_Group | "ONE" | Size range |
| Season | "ONE" | Size range |
| Commodity_Code | "ONE" | Size range |
| Care_Instructions | "ONE" | Size range |
| Fabric_Content | "ONE" | Size range |
| Lining | "ONE" | Size range |
| Material_Fabric | "ONE" | Size range |
| Outer | "" | Outer material |
| Origin | "" | Country of origin |
| Items | [] | Array of objects containing the variants (SKUSizes) |
| SKUSize | "A0000001010A" | Unique SKU/Size for the stock item |
| Colour | "OFF WHITE" | The Colour name |
| Size | "S" | The size code |
| Size_Sort | 1 | The sort order for the size within the SKU |
| Barcode | "5060395910013" | Barcode for the item (usually EAN) |
| Style | "A0000001" | Style code (between 3 and 8 characters) |
| Article | "FLORAL 1" | The article name |
| Size_Range | "S - 3XL" | Size range name |
| In_Stock | 58 | Current in stock value |
| Demand | 0 | Total forward demand from customer orders |
| Supply | 2 | Current on supply order quantity |
| Available | 60 | In stock less demand plus supply |
| Web_Description | "" | Extended text description used for web sites |
| Product_Group | "Long Sleeve Shirts" | Product group name |
| Brand_Name | "iLEVELman" | Brand name |
| Season | "AW16" | Season code |
| Brand_Style | "" | Brand style |
| Cost_Centre | "" | Cost centre |
| Foreign_Stock_Code | "" | Alternative stock code. Can be used to link to another system |
| Origin | "China" | Where the product was created |
| Fabric_Content | "90% Cotton, 10% Polyester" | Fabric content of the product |
| Stock_Change_TS | "20170320153348" | Last change to the stock record |
| Discontinued | false | Boolean field indicating the product has been discontinued |
| Retail_Price_Own_Currency | 32 | Retail RRP of the product in own currency |
| Retail_Price_Currency1 | 0 | Retail RRP of the product in another currency (usually EUR) |
| Retail_Price_Currency2 | 0 | Second alternative RRP in alternative currency |
| Sell_Price1 | 12 | Trade selling price (own currency) |
| Sell_Price2 | 0 | Trade selling price currency 2 |
| Sell_Price3 | 0 | Trade selling price currency 3 |
| Sell_Price4 | 11.5 | Trade selling price currency 4 |
| Sell_Price5 | 12 | Trade selling price currency 5 |
| Sell_Price6 | 12 | Trade selling price currency 6 |
| Sell_Price7 | 0 | Trade selling price currency 7 |
| Sell_Price8 | 0 | Trade selling price currency 8 |
| Sell_Price9 | 0 | Trade selling price currency 9 |
Product Methods
Example of a returned stock object with trade specific fields
| GET | /api/product |
|---|
Returns all products in the system with all published fields.
MultipleWarehouse
MultipleWarehouse provides access to the Multiple Warehouse resource. This lists the multiple warehouses (if enabled) that are managed within i.LEVEL.
What you can do with MultipleWarehouse:
URL/api/multiple_warehouseReturns all multiple warehouse instances.URL/api/mwstock?warehouse_id=1Returns all stock items, for the specified warehouse id.
MultipleWarehouse Properties
Example of a returned multiplewarehouse objects with all fields for a request like: http://URL/api/multiplewarehouse
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 5,
"RecordsFound": 5,
"MultipleWarehouse": [
{
"id": 1,
"Code": "APW1",
"Name": "Apex Warehouse",
"Description": "Multiple warehouse for testing.",
"Currency_Code": "",
"Ring_Fenced": true
},
{
"id": 2,
"Code": "Huh",
"Name": "Mr Test",
"Description": "Test For Clearance Stock",
"Currency_Code": "",
"Ring_Fenced": true
},
{
"id": 3,
"Code": "huh",
"Name": "Test",
"Description": "Test",
"Currency_Code": "",
"Ring_Fenced": true
},
{
"id": 4,
"Code": "",
"Name": "Faulty Stock",
"Description": "",
"Currency_Code": "",
"Ring_Fenced": true
},
{
"id": 5,
"Code": "CONC",
"Name": "Retail Stock",
"Description": "Stop to be used for concession part of the business.",
"Currency_Code": "",
"Ring_Fenced": true
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 1 | Unique id for the Multiple Warehouse |
| Code | 1 | The code assigned to the multiple warehouse |
| Name | "Test For Clearance Stock" | The name of the multiple warehouse |
| Description | Multiple warehouse for testing. | The description for the multiple warehouse |
| Currency_Code | "GBP" | The default currency used for the multiple warehouse (rarely used) |
| Ring_Fenced | true | Indicates that the stock is ring fenced (rarely used) |
MultipleWarehouse Methods
GET multiplewarehouse See example above...
MWStock
MWStock provides access to the Multiple Warehouse stock resource. If a stock item has been transferred to a "Multiple Warehouse" this resource will provide details of the stock quantity at that warehouse.
What you can do with MWStock:
URL/api/mwstockReturns all stock items in the system for all multiple warehouse instances.URL/api/mwstock?warehouse_id=1Returns all stock items, for the specified warehouse id.
MWStock Properties
Example of a returned mw_stock object with all fields for a request like: http://78.129.209.153:19223/api/mwstock?warehouse_id=1&skusize=198601002@
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 8,
"RecordsFound": 8,
"MWStock": [
{
"id": 1,
"Warehouse_id": 1,
"SKUSize": "198601002 A",
"Quantity": 95,
"Updated_Date": "2016-11-09T00:00:00.000Z",
"Stock_Changed": ""
},
{
"id": 2,
"Warehouse_id": 1,
"SKUSize": "198601002 B",
"Quantity": 95,
"Updated_Date": "2016-11-09T00:00:00.000Z",
"Stock_Changed": ""
},
{
"id": 3,
"Warehouse_id": 1,
"SKUSize": "198601002 C",
"Quantity": 95,
"Updated_Date": "2016-11-09T00:00:00.000Z",
"Stock_Changed": ""
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 1 | Unique id for the MWStock item |
| Warehouse_id | 1 | Foreign key to the Multiple warehouse |
| SKUSize | "A0000001010A" | Unique SKU/Size for the mw_stock item |
| Quantity | 95 | The in stock quantity for the item in the warehouse |
| Updated_Date | "2016-11-09T00:00:00.000Z" | The date the mw_stock item was last updated |
| Stock_Changed | "" | Time stamp for the last time the stock quantity changed (not yet implemented) |
MWStock Methods
GET mwstock See example above...
Customer
Customer provides access to the customer resource. This is where all trade customers are held.
Customer Properties
Example of a returned customer object with an included outlet
{
"response": {
"Page": 1,
"PageCount": 3,
"RecordsSent": 100,
"RecordsFound": 267,
"Customer": [
{
"Code": "SEDM",
"Name": "SEDMAN SHOES LTD",
"Address1": "18 Main St",
"Address2": "Hutton",
"Town": "Cranswick",
"County": "YO25 9QR",
"Postcode": "",
"Country_Code": "GB",
"Country": "Great Britain",
"Currency": "GB1",
"Telephone": "",
"Fax": "",
"Email": "",
"Status": 1,
"Discount": 0,
"Tradename": "CRK LONDON LTD",
"Outlets": [
{
"Code": "SEDM",
"Customer_Code": "SEDM",
"Name": "Sedman Shoes ltd",
"Address1": "",
"Address2": "",
"Town": "",
"County": "",
"Postcode": "",
"Country": "UK",
"Address_Text": "18 Main St\rHutton\rCranswick\rYO25 9QR\r",
"Currency": "GBP",
"Type": "Universities"
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| Code | "SEDM" | Customer code |
| Name | "SEDMAN SHOES LTD" | Customer name |
| Address1 | "18 Main St" | Address line 1 |
| Address2 | "Hutton" | Address line 2 |
| Town | "Cranswick" | Town |
| County | "" | County |
| Postcode | "YO25 9QR" | Postcode |
| CountryCode | "GB" | Country code |
| Telephone | "" | Telephone number |
| Fax | "" | Fax number |
| "" | Customer primary email address | |
| Status | 1 | Account status |
| Discount | 0 | General discount percentage |
| Tradename | "CRK LONDON LTD" | Tradename to use for this company |
| Association | "" | Customer association type |
| TAX_Number | "" | Customer VAT number |
| TAX_Type | 1 | VAT type code |
| Company_Reg_No | "" | Company registration number |
| Outlets | [] | List of outlets for the given customer. See Outlet resource for details. |
Other Properties (for review)
| Property | Example | Description |
|---|---|---|
| FactorCo_Accountstr | "" | Factoring account number |
| Contact1 | "" | Contact name |
| LastupdatefromSage | "" | Last update from accounts package |
| PayTerms | "PRO-FORMA" | Payment terms |
| SettleDiscount | 0 | Settlement discount percentage |
| DeliveryInfo | "" | Delivery information |
| GenInfo | "" | General customer information |
| MoreInfo | "" | Additional customer information |
| CreditLimit | 0 | Credit limit |
| SettleDays | 0 | Settlement discount number of days |
| OnHoldReason | "" | Reason for account being on hold |
| Balance | -9125.86 | Current outstanding customer order balance |
| Turnover | 260027.45 | Customer order turnover value |
| Country | "Great Britain" | Country name |
| Payment_Method | "" | Default payment ,method |
| CustomerID | "" | Customer id |
| ContactsID | 1512 | Primary contact id |
| Currency | "GB1" | Customer currency |
| ExportRefNum | 1 | ??? |
| Rating | "Gold" | Customer rating |
| ExportAccountCode | "3694" | ??? |
| BrandDiscount | "" | ??? |
| DateCreated | "2014-06-09T23:00:00.000Z" | Customer creation date |
| Turnover_ytd | 0 | Turnover year to date |
| Turnover_mtd | 0 | turnover month to date |
| Balance_imported | 0 | Imported balance value |
| WIP | 0 | Work in Progress |
| AllowCompletionofDelvrdCO | false | ??? |
| StatusonSage | 0 | Accounts system status |
| Barcode_CustRef | "" | Reference to print on barcode label |
| BarcodeLabel | 0 | ??? |
| Date_Updated | "2017-01-13T00:00:00.000Z" | Date of last update |
| Accounts_NL_Code | "" | Accounts Nominal Ledger code |
| Exclude_Dashboard_TT | false | Flag to indicate this account should be excluded from the dashboard |
| Accounting_Ref | "98483eeb-6151-4c24-a2dc-efa5fa5484a3" | Refernce to accounts system record. |
| Address | "18 Main St\rHutton\rCranswick\rYO25 9QR\r" | Text version of address |
Customer Methods
| GET | /api/customer |
|---|
Returns all customers in the system .
| POST | /api/customer |
|---|
Parses the POST body and create or updates a customer record. Only the main customer attributes can be passed to the post call. Outlets if passed will (currently) be ignored. POST added 11/09/2018.
Outlet
Outlet provides access to the outlet resource. Outlets are trade customer addresses.
Outlet Properties
Example of a returned outlet object
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"Outlet": [
{
"Code": "LAPE",
"Customer_Code": "LAPE",
"Name": "Lapel Menswear",
"Address1": "",
"Address2": "",
"Town": "",
"County": "",
"Postcode": "",
"Country": "UK",
"Address_Text": "1 Kings Arcade\rKing street\rlancaster\rLancashire\rLA1 1LE",
"Currency": "GBP",
"Outlet_Type": "General",
"Sales_rep": "Joan Summer",
"Date_Created": "2014-06-10T23:00:00.000Z",
"Date_Updated": "2016-11-01T00:00:00.000Z",
"Last_Transfer": "0000-00-00T00:00:00.000Z"
},
]
}
}
| Property | Example | Description |
|---|---|---|
| Code | "SEDM" | Outlet code |
| Customer_code | "SEDM" | Customer code |
| Name | "Sedman Shoes ltd" | Outlet name |
| Address1 | "18 Main St" | Address line 1 |
| Address2 | "Hutton" | Address line 2 |
| Town | "Cranswick" | Outlet Town |
| County | "" | Outlet county |
| Postcode | "YO25 9QR" | Outlet postcode |
| Address | "18 Main St\rHutton\rCranswick\rYO25 9QR\r" | Address |
| Currency | "GB1" | Customer currency |
| Outlet_Type | "Universities" | Type of outlet |
| Country | "Great Britain" | Country name |
| Sales_Rep | "Joan Summer" | Sales rep allocated to outlet |
| Date_Created | "2014-06-10T23:00:00.000Z" | Date outlet record created |
| Date_Updated | "2016-11-01T00:00:00.000Z" | Date outlet record last updated |
| Last_Transfer | "0000-00-00T00:00:00.000Z" | Date of last transfer to outlet (concession) |
Outlet Methods
| GET | /api/outlet |
|---|
Returns all outlets in the system .
| POST | /api/outlet |
|---|
Parses the POST body and create or updates an outlet record. POST added 11/09/2018.
Contact
Contact provides access to the contact resource. This is where all contacts are held..
Customer Properties
Example of a returned customer object with an included outlet
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"Contact": [
{
"id": 10738,
"Name": "New Contact",
"Position": "",
"Telephone": "",
"Email": "Erik Neirinckx <erik@studiof.be>",
"Mobile": "",
"Table_Number": 7,
"CompanyContactsID": 2268207
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 10738 | Unique contact id |
| Name | "New Contact" | The contacts name |
| Position | "Sales" | The job title or position of the contact |
| Telephone | "Hutton" | Contacts telephone number |
| "" | Contacts email address | |
| Mobile | 1 | Contactsmobile number |
| Table_Number | 7 | The table to which the contact is related to: 12 = Customer, 7 = Outlet, 4 = Supplier & 70 = Agents |
| ContactTableID | 2268207 | A composite key for the related entity record and the table number. |
Contact Methods
| GET | /api/contact |
|---|
Returns all contacts in the system .
TradeOrder
Trade order provides access to the wholesales customer order resource.
TradeOrder Properties
Example of a returned trade order object with items included
{
"response": {
"Page": 1,
"PageCount": 54,
"RecordsSent": 100,
"RecordsFound": 5396,
"TradeOrder": [
{
"id": 166,
"Customer_Code": "TEST",
"Outlet_Code": "TEST",
"Order_Ref": "S00074",
"Customer_Ref": "",
"Comments": "",
"Tradename": "Test tradename",
"Status": 6,
"Created_date": "2014-07-22T23:00:00.000Z",
"Sent_To_WH": "0000-00-00T00:00:00.000Z",
"Currency": "",
"Source": "Showroom",
"Total_Quantity": 42,
"Total_Value": 495,
"Delivery_Address": "Test Comapny\r7 West Street\rCorby\rNN18 0JB\r",
"Delivery_Date": "2014-07-22T23:00:00.000Z",
"Delivery_Window": 0,
"Delivery_Instructions": "",
"Invoiced": "2014-07-22T23:00:00.000Z",
"Invoice_Ref": "00084",
"Invoice_Address": "Test Comapny\r7 West Street\rCorby\rNN18 0JB\r",
"Details": null,
"Country": "",
"Items": [
{
"id": 1181,
"Order_id": 166,
"SKU": "D0000001001",
"Article": "STA PREST (BLACK)",
"Colour_Code": "001",
"Colour_Name": "BLACK",
"Item_Price": 12.5,
"Line_Qty": 2,
"Line_Value": 25,
"Currency": "GBP",
"Brand": "Relco London",
"Product_Group": "Trousers",
"Line_Ref": "",
"Cust_SKU_Ref": "",
"Location": "",
"Sizes": [
{
"SKUSize": "D0000001001B",
"Size": "30",
"Qty": 1,
"SizeSort": 2
},
{
"SKUSize": "D0000001001C",
"Size": "32",
"Qty": 1,
"SizeSort": 3
}
]
}
]
}
]
}
}
{
"response": {
}
}
| Property | Example | Description |
|---|---|---|
| id | 1300 | Unique id of the order |
| Customer_Code | "CXLDN" | Customer code |
| Outlet_Code | "CLXO" | Outlet code |
| Order_Ref | "S00002" | Order reference |
| Customer_Ref | "XXX001" | Customers order reference |
| Comments | "" | Order comments |
| Tradename | "Brand A" | The tradename under which the order was placed |
| Status | 6 | Status code for the order |
| Created_Date | "2017-01-12T00:00:00.000Z" | Creation date of the order |
| Sent_To_WH | "2017-01-12T00:00:00.000Z" | Date the order was sent to the warehouse (used with warehouse integration) |
| Currency | "GBP" | The currency for the order |
| Source | "Showroom" | The source of the order |
| Total_Quantity | 51 | Total items on the order |
| Total_Value | 614 | Total sell price for the order |
| Delivery_Address | "CX LONDON\r132 CATHERINE ST\rCAMBRIDGE\rCAMBRIDGESHIRE\rCB1 3AR\r" | Delivery address text |
| Delivery_Date | "2017-01-17T00:00:00.000Z" | Required delivery date |
| Delivery_Window | 10 | Delivery window in days for the order |
| Delivery_Instructions | "" | Delivery instructions |
| Invoiced | "2017-01-17T00:00:00.000Z" | Invoiced date |
| Invoice_Ref | "00033" | Invoice reference |
| Invoice_Address | "CX LONDON\r132 CATHERINE ST\rCAMBRIDGE\rCAMBRIDGESHIRE\rCB1 3AR\r" | Invoice address text |
| Details | null | Object containing customer values (where implemented) |
| Country | "UK " | Country code for order |
| Items | [] | Array of trade order items see tradeorderitem resource |
TradeOrder Methods
| GET | /api/tradeorder |
|---|
Returns all trade orders in the system with all published fields.
ShowZeros Custom Parameter
The ShowZeros parameter can be used to display sizes for the order item that have a zero quantity in them. By default the behaviour is to return only sizes that have a non zero quantity.
| Example | /api/supplyorderitem?showzeros=true |
|---|
| POST | /api/retailorder |
|---|
Parses the request object and creates a trade order (if validated). The trade customer code and items are all passed as part of the request object. It is important to pass the Outlet_code for the related customer otherwise the order will be orphaned and not processed. Currently customers must exist prior to orders being placed.
All exposed properties of the RetailOrder can be inserted with the exception of id. The eample given shows the recommended fields to be used. Please see the TradeOrderItem documentation for item fields which are allowable in a post.
The response will return the entire tradeorder following creation.
TradeOrderItem
What you can do with TradeOrderItem:
This is currently a read only resource when called on its own.
TradeOrderItem Properties
http://URL/api/tradeorderitem?showzeros=true
Example uses the showzeros parameter (see description below)
{
"response": {
"Page": 1,
"PageCount": 755,
"RecordsSent": 100,
"RecordsFound": 75413,
"TradeOrderItem": [
{
"id": 71,
"Order_id": 64,
"SKU": "B0000027009",
"Article": "CK 2 (MULTI)",
"Colour_Code": "009",
"Colour_Name": "",
"Item_Price": 10.5,
"Line_Qty": 1,
"Line_Value": 10.5,
"Currency": "GBP",
"Brand": "Relco London",
"Product_Group": "Short Sleeve Shirts",
"Line_Ref": "",
"Cust_SKU_Ref": "",
"Location": "",
"Sizes": [
{
"SKUSize": "B0000027009A",
"Size": "S",
"Qty": 0,
"SizeSort": 1
},
{
"SKUSize": "B0000027009B",
"Size": "M",
"Qty": 1,
"SizeSort": 2
},
{
"SKUSize": "B0000027009C",
"Size": "L",
"Qty": 0,
"SizeSort": 3
},
{
"SKUSize": "B0000027009D",
"Size": "XL",
"Qty": 0,
"SizeSort": 4
},
{
"SKUSize": "B0000027009E",
"Size": "XXL",
"Qty": 0,
"SizeSort": 5
},
{
"SKUSize": "B0000027009F",
"Size": "3XL",
"Qty": 0,
"SizeSort": 6
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 71 | Unique id for the retail order item |
| Order_id | 64 | Order id links the item to the order |
| SKU | "B0000027009" | Style/Colour code for the order item |
| Article | "Delivery" | Article name |
| Colour_Code | "009" | Colour code |
| Colour_Name | "Blue" | Colour name |
| Item_Price | 10.5 | Item prices for line item |
| Line_Qty | 1 | Total quantity for the line |
| Line_Value | 10.5 | Total value for line |
| Currency | "GBP" | Currency for the line item |
| Brand | "Test Brand" | Brand name for the item |
| Product_Group | "Dresses" | Product group for the item |
| Cust_SKU_Ref | "ABC123" | The customers reference for the SKU |
| Location | "A001" | Warehouse pick location for item |
| Sizes | Array | Array of size level item quantities |
|---|---|---|
| SKUSize | "B0000027009A" | SKU/Size level code |
| Size | "M" | Size code |
| Qty | 1 | Quantity for the size in the line |
| SizeSort | 2 | The size sort code for the size item |
| Barcode | "3900011122234" | Barcode of the order item |
ShowZeros Custom Parameter
The ShowZeros parameter can be used to display sizes for the order item that have a zero quantity in them. By default the behaviour is to return only sizes that have a non zero quantity.
| Example | /api/supplyorderitem?showzeros=true |
|---|
NOTE: When posting in a trade order the system will try and match the product by SKUSize (if present) or the optional Barcode property (only used for POST). If neither is present the order will fail. As SKUSize can contain multiple spaces between colour code and size letter this may provide you with an issue. To work around this you can replace spaces with underscores in the SKUSize field. If you pass back a SKUSize with underscores these will automatically be replaced with spaces for matching purposes.
Q. Why no POST option. A. All items must be sent as part of the tradeorder message.
Return
Return provides access to the return order resource. A return is raised when a trade order is returned in part ofr whole.
By default the Return resource will return the related Return Item.
Return Properties
Example of a return object with items included
{
"response": {
"Page": 1,
"PageCount": 543,
"RecordsSent": 1,
"RecordsFound": 543,
"ReturnItem": [
{
"id": 1,
"Sequence": 1,
"SKU": "MEPTP28188",
"return_id": 2,
"supplier_id": 0,
"Supplier_Code": "",
"Price": 22,
"Quantity": 1,
"Value": 22,
"Discount": 0,
"Detail": {
"Article": "NOIZE JEAN",
"ColourCode": "188",
"ColourName": "BLACK ROCK",
"Brand": "Mens Core",
"ProductGroup": "DENIM",
"Reason Code": 1,
"Reason": "SIZING - TOO SMALL",
"Action Code": 2,
"Action": "Wastage",
"Supplier": 0,
"Location": "C000",
"Order Num": "",
"Order RSN": 0,
"Order Item RSN": 0,
"Sizes": [
{
"SKUSize": "MEPTP28188 B",
"Size": "28",
"Qty": 1,
"SizeSort": 2
}
]
}
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 1300 | Unique id of the order |
| supplier_id | 1092 | Customer id |
| contact_id | "01298" | Order number created by i.Level (Read Only) |
| invoice_id | "4703122564" | Order reference can be passed in. If passed it will be used with the Order_Source to check uniqueness |
| Customer_Code | "SHOPIFY" | Order source |
| Supplier_Code | "4703122564" | Marketplace reference. |
| Order_Number | "2017-01-12T00:00:00.000Z" | Creation date of the order |
| Trade_Name | "Pending_Scan" | Primary status for the order |
| Action_Code | "paid" | Web/marketplace order status |
| Action | "2017-01-17T00:00:00.000Z" | Required delivery date |
| Reason_Code | "0000-00-00T00:00:00.000Z" | Estimated delivery date |
| Reason | "Ameer Jones" | Delivery customer name |
| Quantity | 1 | Total quantity of items returned |
| Value | 22 | Total value for the return |
| Stock_Location | "Hackney" | Delivery address line 3 |
| Status | "London" | Delivery address line 4 |
| Return_To_Stock | "HA453PQ" | Delivery postcode |
| Return_Date | "GB" | Delivery address country code |
| Return_Currency | "United Kingdom" | Delivery address country name |
| Items | [] | Array of return items see Return Item resource |
Return Methods
| GET | /api/return |
|---|
Returns all returns in the system with all published fields.
ShowZeros Custom Parameter
The ShowZeros parameter can be used to display sizes for the return item that have a zero quantity in them. By default the behaviour is to return only sizes that have a non zero quantity.
Return Item
Return provides access to the return item resource.
For more information please see Return.
Return Item Properties
Example of a return object with items included
{
"response": {
"Page": 1,
"PageCount": 543,
"RecordsSent": 1,
"RecordsFound": 543,
"ReturnItem": [
{
"id": 1,
"Sequence": 1,
"SKU": "MEPTP28188",
"return_id": 2,
"supplier_id": 0,
"Supplier_Code": "",
"Price": 22,
"Quantity": 1,
"Value": 22,
"Discount": 0,
"Detail": {
"Article": "Test jeans",
"ColourCode": "188",
"ColourName": "BLACK",
"Brand": "Mens Core",
"ProductGroup": "DENIM",
"Reason Code": 1,
"Reason": "SIZING - TOO SMALL",
"Action Code": 2,
"Action": "Wastage",
"Supplier": 0,
"Location": "C000",
"Order Num": "",
"Order RSN": 0,
"Order Item RSN": 0,
"Sizes": [
{
"SKUSize": "MEPTP28188 B",
"Size": "28",
"Qty": 1,
"SizeSort": 2
}
]
}
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 1300 | Unique id of the order |
| return_id | "4703122564" | Order reference can be passed in. If passed it will be used with the Order_Source to check uniqueness |
| Sequence | 1092 | Customer id |
| SKU | "01298" | Order number created by i.Level (Read Only) |
| supplier_id | "SHOPIFY" | Order source |
| Supplier_Code | "4703122564" | Marketplace reference. |
| Price | "2017-01-12T00:00:00.000Z" | Creation date of the order |
| Quantity | "Pending_Scan" | Primary status for the order |
| Value | "paid" | Web/marketplace order status |
| Discount | "2017-01-17T00:00:00.000Z" | Required delivery date |
| Detail | {} | Embeded object containing the return item detail and sizes |
Detail
| Property | Example | Description |
|---|---|---|
| Article | "Test Jeans" | The article name |
| ColourCode | "118" | The colour code for the item |
| ColourName | "BLACK" | The colour name for the item |
| Brand | "Mans Core" | The brand the product belongs to |
| ProductGroup | "DENIM" | Product group the product belongs to |
| Reason Code | 1 | Reason code |
| Reason | "SIZING - TOO SMALL" | Reason text |
| Action Code | 2 | Action code |
| Action | "Wastage" | Action in text. Could be expanded version of the lookup value |
| Supplier | 0 | The supplier RSN |
| Location | "C000" | The pick location for the item |
| Order Num | "" | The original order number if the item was imported from a previously created customer order |
| Order RSN | 0 | The original order RSN if the item was imported from a previously created customer order |
| Order Item RSN | 0 | The original order item RSN if the item was imported from a previously created customer order |
| Sizes | [] | An array of size objects with quantities (see below) |
Sizes
| Property | Example | Description |
|---|---|---|
| SKUSize | "MEPTP28188 B" | The SKUSize for the variant |
| Size | 28 | The size code for the size variant |
| Qty | 1 | The qunatity for the size variant |
| SizeSort | 2 | The size sort for the given size variant |
Return Methods
| GET | /api/returnitem |
|---|
Returns all returnitem records in the system with all published fields.
ShowZeros Custom Parameter
The ShowZeros parameter can be used to display sizes for the return item that have a zero quantity in them. By default the behaviour is to return only sizes that have a non zero quantity.
Supplier
Supplier provides access to the supplier resource. This is where all suppliers are held.
Supplier Properties
Example of a returned supplier object
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"Supplier": [
{
"Code": "KBHAV",
"Name": "Kishor + Bhavesh",
"Address1": "",
"Address2": "",
"Town": "",
"County": "",
"Postcode": "",
"Country_Code": "",
"Telephone": "",
"Fax": "",
"Email": "",
"Currency": "",
"Created_Date": "2014-11-26T00:00:00.000Z",
"Updated_Date": "2016-11-23T00:00:00.000Z",
"Discount": 0,
"Accounts_Ref": "",
"NL_Code": "00001",
"Settings": ""
}
]
}
}
| Property | Example | Description |
|---|---|---|
| Code | "SEDM" | Supplier code |
| Name | "SEDMAN SHOES LTD" | Supplier name |
| Address1 | "18 Main St" | Address line 1 |
| Address2 | "Hutton" | Address line 2 |
| Town | "Cranswick" | Town |
| County | "" | County |
| Postcode | "YO25 9QR" | Postcode |
| Country_Code | "GB" | Country code |
| Telephone | "" | Telephone number |
| Fax | "" | Fax number |
| "" | Customer primary email address | |
| Currency | "GBP" | Supplier currency |
| Created_Date | "2014-11-26T00:00:00.000Z" | Date the supplier record was created |
| Updated_Date | "2016-11-23T00:00:00.000Z" | Date the supplier record was last updated |
| Discount | 0 | General discount percentage |
| Accounts_Ref | "" | Accounts reference (if linked to accounts package) |
| NL_Code | "" | Accounts nominal ledger code default |
Supplier Methods
| GET | /api/supplier |
|---|
Returns all customers in the system .
SupplyOrder
Trade order provides access to the wholesales customer order resource. A trade order is an order placed for a
SupplyOrder Properties
Example of a returned supplier order object with items included
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 55,
"RecordsFound": 55,
"SupplyOrder": [
{
"RSN": 1,
"OrderNum": "PO00006",
"SuppCode": "KBHAV",
"Status": 8,
"WarehouseDate": "0000-00-00T00:00:00.000Z",
"SUDelTerms": "",
"Collection": "",
"CreateDate": "2014-11-26T00:00:00.000Z",
"CfmDelivery": "0000-00-00T00:00:00.000Z",
"BuyerText": "",
"ShipAddress": "",
"FwderOrigin": "",
"FwdrDest": "",
"Article": "",
"QtyPerInnerBox": "",
"QtyPerExpCtn": "",
"XDock": false,
"UpdateStock": false,
"PayTerms": "",
"MarkOnExpCtn": "",
"TotalBuyCost": 0,
"ThirdCustCode": "",
"TotalOrderQty": 325,
"Comments": "",
"CustCode": "",
"BuyCurrency": "GBP",
"SellCurrency": "GBP",
"TotalSellPrice": 0,
"BuyExRate": 1,
"SellExRate": 1,
"TotalBuyOwnCurrency": 0,
"TotalSellOwnCurrency": 0,
"TotalLandCost": 0,
"DeliveryFrom": "",
"DCNumber": "",
"EstValueDate": "0000-00-00T00:00:00.000Z",
"CfmdValueDate": "0000-00-00T00:00:00.000Z",
"Comments2": "",
"RoyalTyPerCent": 0,
"RoyaltyDue": 0,
"USDExRate": 1,
"RoyaltyDueUSD": 0,
"EstValueDays": 0,
"MainStyle": "N/A",
"CUDeliveryTerms": "",
"OrderType": 1,
"SUShippedDate": "0000-00-00T00:00:00.000Z",
"InternalComment": "This new order cancelled on 27/11/2014 at 11:17:25 at computer Designer no reason\r26/11/2014 Delivery date changed from 02/12/2014 to 10/12/2014\r",
"ReqsPrinting": false,
"SuppRef": "",
"KimballTags": "",
"PolyBag": "",
"SampleDate1": "",
"SampleSize1": "",
"SampleColour1": "",
"SampleDate2": "",
"SampleSize2": "",
"SampleColour2": "",
"SampleDate3": "",
"SampleSize3": "",
"SampleColour3": "",
"OrdConfNotes": "",
"SUDeliveryDate": "2014-12-10T00:00:00.000Z",
"ETAPrinter": "0000-00-00T00:00:00.000Z",
"ETAPacking": "0000-00-00T00:00:00.000Z",
"CustPayTerms": "",
"Quality": "",
"Composition": "",
"Weight": "",
"LogoLabel": "",
"GarmentLabel": "",
"HangTag": "",
"OrigOrderNum": "",
"SplitCount": 0,
"PrinterCode": "",
"BrandName": "",
"DateToBank": "0000-00-00T00:00:00.000Z",
"SentInTrust": "",
"SUPayDate": "0000-00-00T00:00:00.000Z",
"PeriodYYMM": "",
"ccConverse": false,
"HQ_CustOrder_Ref": "",
"CUCfmdDelTerms": "",
"PrintOrder": 0,
"InvAddress": "",
"PrintOrdNotes": "",
"LandCurrency": "GBP",
"LandExRate": 0,
"InvoiceNum": "",
"InvoicedDate": "0000-00-00T00:00:00.000Z",
"ShowOnTurn": true,
"ShipAddr2": "",
"FwdOrigin2": "",
"FwdDest2": "",
"PayRcvdDays": 0,
"EstRcvdDate": "0000-00-00T00:00:00.000Z",
"ActRcvdDate": "0000-00-00T00:00:00.000Z",
"SUPayDays": 0,
"EstSUPayDate": "2014-12-10T00:00:00.000Z",
"OrigSUDelDate": "2014-12-02T00:00:00.000Z",
"Consignee": "",
"CUDelNotes": "",
"QualSizePerExpC": "",
"InProgress": true,
"OrigCUDelDate": "0000-00-00T00:00:00.000Z",
"ApprovedForShip": false,
"SUInvDate": "0000-00-00T00:00:00.000Z",
"SUInvNum": "",
"Transport": "A ",
"Season": "",
"WarehouseETAdate": "2014-12-15T00:00:00.000Z",
"CostCentre": 0,
"EstDelvryDays": 5,
"Sent_To_WH_Date": "0000-00-00T00:00:00.000Z",
"Accounts_Ref": "false",
"Intrastat_notc": "",
"Tradename": "CRK LONDON LTD",
"DeliveryCharge": 0,
"DeliveryMethod": "",
"Sent_To_Portal": "0000-00-00T00:00:00.000Z",
"Items": [
{
"id": 1,
"Order_id": 1,
"Supplier_Ref": "",
"Style": "C0000001",
"SKU": "C0000001001",
"Article": "POLO 1",
"Colour_Code": "001",
"Colour_Name": "BLACK",
"Buy_Price": 0,
"Line_Qty": 155,
"Line_Buy_Value": 0,
"Buy_Currency": "GBP",
"Land_Cost": 0,
"Line_Land_Value": 0,
"Land_Currency": "GBP",
"Sizes": [
{
"SKUSize": "C0000001001A",
"Size": "S",
"Qty": 15,
"SizeSort": 1
},
{
"SKUSize": "C0000001001B",
"Size": "M",
"Qty": 35,
"SizeSort": 2
},
{
"SKUSize": "C0000001001C",
"Size": "L",
"Qty": 40,
"SizeSort": 3
},
{
"SKUSize": "C0000001001D",
"Size": "XL",
"Qty": 35,
"SizeSort": 4
},
{
"SKUSize": "C0000001001E",
"Size": "XXL",
"Qty": 30,
"SizeSort": 5
}
]
},
{
"id": 2,
"Order_id": 1,
"Supplier_Ref": "",
"Style": "C0000002",
"SKU": "C0000002001",
"Article": "POLO 2",
"Colour_Code": "001",
"Colour_Name": "BLACK/ RED",
"Buy_Price": 0,
"Line_Qty": 170,
"Line_Buy_Value": 0,
"Buy_Currency": "GBP",
"Land_Cost": 0,
"Line_Land_Value": 0,
"Land_Currency": "GBP",
"Sizes": [
{
"SKUSize": "C0000002001A",
"Size": "S",
"Qty": 20,
"SizeSort": 1
},
{
"SKUSize": "C0000002001B",
"Size": "M",
"Qty": 40,
"SizeSort": 2
},
{
"SKUSize": "C0000002001C",
"Size": "L",
"Qty": 35,
"SizeSort": 3
},
{
"SKUSize": "C0000002001D",
"Size": "XL",
"Qty": 40,
"SizeSort": 4
},
{
"SKUSize": "C0000002001E",
"Size": "XXL",
"Qty": 35,
"SizeSort": 5
}
]
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| Order_Type | 1 | Order is for own warehouse or Direct to third customer |
| Original_Order_Num | PO10500 | Order number allocated at creation |
| Split_Count | 3 | How many time the order has been split (Part shipments etc) |
| id | 1 | unique record number |
| Order_Num | PO00006 | Supplier order number and reference |
| SupplierCode | KBHAV | Short code for the supplier |
| Status | 8 | Indicating the current staus of the supplier order (New, Confirmed Shipped etc) |
| Warehouse_Date | 0000-00-00T00:00:00.000Z | The ETA to warehouse |
| Supplier_Delivery_Terms | FOB China | How the supplier is delivering the goods |
| Collection | Jackets | Only in use if 1 type of product per order |
| Creation_Date | 2014-11-26T00:00:00.000Z | Date the order was created |
| Confirmed_Delivery_Date | 0000-00-00T00:00:00.000Z | Delivery Date confirmed by supplier |
| Buyer_Address | "1 High Street, London, SW15 7RT" | Name and Address of buyer |
| Shipping_Address | "1 High Street, London, SW15 7RT" | Shipping Address |
| Forwarder_At_Origin | "Sun Textile, Hung Wan 16, Wanchi, China" | The shipping company in countyry of origin |
| Clearing_Agent | "AirFreight Ltd, Gate 18, 5 Flight Str, Heathrow" | Agent that will custom clear incomming goods |
| Article | Reversible Jacket | Short product description |
| Quantity_Per_Inner_Box | 12 Pcs | Packing Instruction |
| Quantity_Per_Export_Carton | 4 innerboxes | Packing Instruction |
| Payment_Terms | 60Days | Terms agreed with supplier |
| Mark_On_Export_Carton | "Ord No, Style Code, Quantity," | Any information required on the Box end label of the export carton |
| Total_Buy_Cost | 1587.25 | Total cost of order |
| Third_Customer_Code | Asos | End buyer of order |
| Total_Order_Quantity | 325 | Total number of pieces purchased |
| Comments | Neckline must be plain stitching | Information to the supplier |
| Customer_Code | ilev | Code for the buyer (normally the user of the software) |
| Buy_Currency | GBP | Currency of the amount agreed to pay the supplier |
| Buy_Exchange_Rate | 1.2 | Exchange rate set in i.LEVEL for the order at the time of creation |
| Buy_Price_Own_Currency | 1035 | Purchase Value of order in user's selected own currency (often £) |
| Total_Landed_Cost | 1250 | Total cvalue of order in landed cost |
| Delivery_From | China | Country of dispatch of the order |
| USD_Exchange_Rate | 1.42 | USD exchange rate set in i.LEVEL for the order at the time of creation |
| Main_Style_Code | DE12345 | Style selected when only one style per order |
| Supplier_Shipped_Date | 0000-00-00T00:00:00.000Z | The date agreed for supplier to dispatch the order |
| Internal_Comment | This new order cancelled on 27/11/2014 at 11:17:25 at computer Designer no reason\r26/11/2014 Delivery date changed from 02/12/2014 to 10/12/2014\r | Comments that must not go to supplier |
| Supplier_Own_Reference | ABC98765 | Suppliers own reference to the product purchased |
| Supplier_Delivery_Date | 2014-12-10T00:00:00.000Z | Original agreed dispatch date by supplier |
| Brand_Name | Hugo Boss | Name of brand |
| Landed_Currency | GBP | Currency used for landed cost price |
| Landed_Exchange_Rate | 1 | Exchange rate set in i.LEVEL for the landed currency |
| Show_On_Turn | true | N/A |
| Supplier_Pay_Days | 60 Days | Payment terms agreed with supplier |
| Original_Supplier_Delivery_Date | 2014-12-02T00:00:00.000Z | Original date fo delivery agreed with supplier |
| Export_Carton_Detail | 3 Ply 30 X 50 X 40cm | Quality and size of export Carton |
| In_Progress | true | Indicates a supplier order still in negotiations |
| Approved_For_Shipment | false | Order has been approved by buyer for shipment |
| Supplier_Invoice_Date | 0000-00-00T00:00:00.000Z | Date of suppliers invoice |
| Supplier_Invoice_Num | Invoice number of supplier's invoice | |
| Transport | A - Air | Mode of Transport |
| Season | SS18 | Season of garment ordered |
| Warehouse_ETA_Date | 2014-12-15T00:00:00.000Z | Estimated date of arrival to warehouse |
| Cost_Centre | 0 | Cost center used for this order |
| Transit_Days | 5 | Time it takes from supplier delivers until landed in warehouse |
| Trade_Name | CRK LONDON LTD | Tradename used for this order normally a brand name in a group |
| Items | [] | Array of supply order items see supplyorderitem resource |
| - | - | - |
| Sell_Currency | GBP | Currency of the selling price to third cust for this order |
| Total_Sell_Price | 0 | Total value of the order |
| Sell_Exchange_Rate | 1 | Exchange rate set in i.LEVEL for the order at the time of creation |
| Sell_Value_Own_Currency | 2540 | Sales Value of order in user's selected own currency (often £) |
| Customer_Delivery_Terms | FOB China by Vessel | Agreed delivery terms with end customer |
| Confirmation_Notes | Goods will be delivered to Pack Ltd as agreed | Notes for third customer re delivery of the order |
| Customer_Pay_Terms | 30 Days | Payment terms agreed with third party customer |
| Confirmed_Delivery_Terms | Terms of delivery for third party customer (Direct Orders) | |
| Invoice_Address | "1 High Street, London, SW15 7RT" | Address of the third party customer |
| Invoice_Num | 10520 | Number allocated ot the invoice for this order |
| Invoiced_Date | 0000-00-00T00:00:00.000Z | Creation date of invoice |
| Ship_Address_2 | "1 High Street, London, SW15 7RT" | Shipping Address on Order confirmation for third customer |
| Forward_Origin_2 | "Sun Textile, Hung Wan 16, Wanchi, China" | Clearing agent Address on Order confirmation for third customer |
| Forward_Destination_2 | "AirFreight Ltd, Gate 18, 5 Flight Str, Heathrow" | Shipping Address on Order confirmation for third customer |
| Customer_Delivery_Notes | As agreed by Peter Jones | Notes for third customer packing list |
| Original_Customer_Delivery_Date | 0000-00-00T00:00:00.000Z | Original delivery date agreed with third customer |
| Intrastat_Code | 10 | Intrastat code for delivery and type |
| Delivery_Charge | 250 | Cost of delivery to third customer |
| Delivery_Method | By Truck | Mode of delivery |
| - | - | - |
| Sent_To_Portal | 0000-00-00T00:00:00.000Z | Date order was sent to production portal |
SupplyOrder Methods
| GET | /api/supplyorder |
|---|
Returns all supplier orders in the system with all published fields.
ShowZeros Custom Parameter
The ShowZeros parameter can be used to display sizes for the order item that have a zero quantity in them. By default the behaviour is to return only sizes that have a non zero quantity.
| Example | /api/supplyorderitem?showzeros=true |
|---|
SupplyOrderItem
What you can do with SupplyOrderItem:
This is currently a read only resource when called on its own.
SupplyOrderItem Properties
{
"response": {
"Page": 1,
"PageCount": 2,
"RecordsSent": 100,
"RecordsFound": 172,
"SupplyOrderItem": [
{
"id": 14,
"Order_id": 4,
"Supplier_Ref": "",
"Style": "16343",
"SKU": "16343001",
"Article": "Fara Top",
"Colour_Code": "001",
"Colour_Name": "Black",
"Buy_Price": 11.3,
"Line_Qty": 3,
"Line_Buy_Value": 33.9,
"Buy_Currency": "USD",
"Land_Cost": 12.33,
"Line_Land_Value": 36.99,
"Land_Currency": "GBP",
"Sizes": [
{
"SKUSize": "16343001 E",
"Size": "16",
"Qty": 3,
"SizeSort": 5
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 14 | Unique id for the retail order item |
| Order_id | 4 | Order id links the item to the order |
| Style | "16343" | Style code for the item |
| SKU | "16343001" | Style/Colour code for the order item |
| Article | "Delivery" | Article name |
| Colour_Code | "001" | Colour code |
| Colour_Name | "BLACK" | Colour name |
| Buy_Price | 11.3 | Item buy price per item |
| Line_Qty | 3 | Total quantity for the line |
| Line_Buy_Value | 33.9 | Total buy value for line |
| Buy_Currency | "USD" | Buy currency for the line item |
| Land_Cost | 12.33 | Landed cost per item |
| Line_Land_Value | 36.99 | Landed cost for line item |
| Land_Currrency | "GBP" | The landed currency |
| Sizes | Array | Array of size level item quantities |
| --------- | ------- | ----------- |
| SKUSize | "16343001 E" | SKU/Size level code |
| Size | "16" | Size code |
| Qty | 3 | Quantity for the size in the line |
| SizeSort | 5 | The size sort code for the size item |
ShowZeros Custom Parameter
The ShowZeros parameter can be used to display sizes for the order item that have a zero quantity in them. By default the behaviour is to return only sizes that have a non zero quantity.
| Example | /api/supplyorderitem?showzeros=true |
|---|
RetailCustomer
RetailCustomer provides access to the retail customer resource. This is where all retail customers are held. These typically come from a retail website or be manually keyed, following mail or telephone request. They may also come from own retail stores where customer data capture is enabled.
RetailCustomer Properties
Example of a returned retail customer object with an included outlet
{
"response": {
"Page": 1,
"PageCount": 12,
"RecordsSent": 100,
"RecordsFound": 1185,
"RetailCustomer": [
{
"id": 1,
"Customer_Ref": "OWNWEB01-6",
"Title": "Mr",
"Forename": "John",
"Surname": "Smith",
"Family_Name": "Mr John Smith",
"Given_Name": "John Smith",
"Company_Name": "",
"Address1": "12 Test Road",
"Address2": "",
"Town": "Newcastle",
"County": "Tyne & Wear",
"Postcode": "NE11 0LE",
"Country": "United Kingdom",
"Telephone": "12345612345",
"Mobile": "",
"Fax": "",
"Email": "demo@test.co.uk",
"Comments": "",
"URL": "",
"Identifier1": "",
"Identifier2": "",
"Account_Ref": "",
"Rating": ""
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 15 | Unique customer id |
| Customer_Ref | "OWNWEB01-6" | Customer reference. |
| Title | "Mr" | Customer title |
| Forename | "John" | Forename |
| Surname | "Smith" | Surname |
| Family_Name | "Mr John Smith" | Family name created from Title + Forename + Surname |
| Given_Name | "" | Given name. If not passed this will be filled with Forename + Surname |
| Company_Name | "" | Company name if specified |
| Address1 | "18 Main St" | Billing address line 1 |
| Address2 | "Hutton" | Billing address line 2 |
| Town | "Cranswick" | Billing town |
| County | "YO25 9QR" | Billing county |
| Postcode | "" | Billing postcode |
| Country | "United Kingdom" | Billing country |
| Telephone | "" | Customer telephone number |
| Mobile | "" | Customer mobile number |
| Fax | "" | Customer fax number |
| "demo@test.co.uk" | Customer email address | |
| Comments | "" | Order notes |
| URL | "" | Customers web address |
| Identifier1 | "" | Classification field |
| Identifier2 | "" | Classification field |
| Accounts_Ref | "" | Accounting reference for customer |
| Rating | "" | Customer rating code |
RetailCustomer Methods
| GET | /api/retailcustomer |
|---|
Returns all retail customers in the system .
RetailOrder
Retail order provides access to the retail/web order resource. A retail order is an order placed for a retail customer in the i.Level system, These may typically come from a retail website or be manually keyed, following mail or telephone request. A retail order will require despatching to a customer.
By default the RetailOrder resource will return the related Retail Customer and the Retail Order Items
RetailOrder Properties
Example of a returned retail order object with items included
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"RetailOrder": [
{
"id": 1,
"Customer_id": 1,
"Warehouse_id": 0,
"Order_Number": "WO00001",
"Order_Ref": "U18",
"Order_Source": "OWNWEB01",
"Marketplace_Ref": "",
"Order_Date": "2014-09-09T23:00:00.000Z",
"Order_Status": "Done",
"Marketplace_Status": "Shipped",
"Despatch_Date": "2014-09-23T23:00:00.000Z",
"Name": "Mr TEST TEST",
"Address1": "TEST",
"Address2": "TEST",
"Town": "Tyne & Wear",
"County": "United Kingdom",
"Postcode": "NE11 0LE",
"Country_Code": "",
"Country": "",
"Address_Text": "TEST\rTEST\rTyne & Wear\rNE11 0LE\rUnited Kingdom",
"Cost_Centre": 0,
"Carrier": "",
"Tracking_Ref": "000000",
"Extended_Data": null,
"Gross": 57.98,
"VAT": 0,
"VAT_Code": "Z",
"Currency": "GBP",
"RetailCustomer": {
"id": 1,
"Customer_Ref": "OWNWEB01-6",
"Title": "",
"Forename": "",
"Surname": "",
"Family_Name": "Mr TEST TEST",
"Given_Name": "Mr TEST TEST",
"Company_Name": "",
"Address1": "TEST",
"Address2": "TEST",
"Town": "Tyne & Wear",
"County": "United Kingdom",
"Postcode": "NE11 0LE",
"Country": "",
"Telephone": "12345612345",
"Mobile": "",
"Fax": "",
"Email": "demo1@red-fern.co.uk",
"Comments": "",
"URL": "",
"Identifier1": "",
"Identifier2": "",
"Accounts_Ref": "",
"Rating": ""
},
"Items": [
{
"id": 1,
"Order_id": 1,
"Item_Ref": "",
"Host_Item_Ref": "",
"SKUSize": "A0000001010A",
"Barcode": "",
"Article": "FLORAL 1",
"Colour": "OFF WHITE",
"Size": "S",
"Marketplace_Status": "confirmed",
"Quantity": 2,
"Item_Price": 28.99,
"Line_Total": 57.98,
"VAT_Total": 0,
"RRP": 28.99,
"VAT_Status": true,
"VAT_Rate": 0,
"Despatch_Date": "0000-00-00T00:00:00.000Z",
"Details": null
},
{
"id": 2,
"Order_id": 1,
"Item_Ref": "SHIPPING",
"Host_Item_Ref": "",
"SKUSize": "",
"Barcode": "",
"Article": "Delivery",
"Colour": "",
"Size": "",
"Marketplace_Status": "",
"Quantity": 1,
"Item_Price": 0,
"Line_Total": 0,
"VAT_Total": 0,
"RRP": 0,
"VAT_Status": true,
"VAT_Rate": 0,
"Despatch_Date": "0000-00-00T00:00:00.000Z",
"Details": null
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 1300 | Unique id of the order |
| Customer_id | 1092 | Customer id |
| Warehouse_id | 0 | Warehouse id indicates the warehouse from which the stock for the order should be taken. Default 0 for main warehouse. Use multiplewarehouse resource (if active on your system) for details of available warehouses. |
| Order_Number | "01298" | Order number created by i.Level (Read Only) |
| Order_Ref | "4703122564" | Order reference can be passed in. If passed it will be used with the Order_Source to check uniqueness |
| Order_Source | "SHOPIFY" | Order source |
| Marketplace_Ref | "4703122564" | Marketplace reference. |
| Order_Date | "2017-01-12T00:00:00.000Z" | Creation date of the order |
| Order_Status | "Pending_Scan" | Primary status for the order |
| Marketplace_Status | "paid" | Web/marketplace order status |
| Delivery_Date | "2017-01-17T00:00:00.000Z" | Required delivery date |
| Delivery_Date_Est | "0000-00-00T00:00:00.000Z" | Estimated delivery date |
| Name | "Ameer Jones" | Delivery customer name |
| Address1 | "24 Bradford Road" | Delivery address line 1 |
| Address2 | "Hackney " | Delivery address line 2 |
| Town | "Hackney" | Delivery address line 3 |
| County | "London" | Delivery address line 4 |
| Postcode | "HA453PQ" | Delivery postcode |
| Country_Code | "GB" | Delivery address country code |
| Country | "United Kingdom" | Delivery address country name |
| Address_Text | "24 Bradford Road\rHackney \rHackney\rLondon\rHA453PQ\rUnited Kingdom" | Full delivery address. You do not need to pass this if the address fields have been filled in. This is deemed a legacy field. |
| Cost_Centre | 0 | Cost centre/trade name code |
| Carrier | "" | Despatch carrier service |
| Tracking_Ref | "" | Despatch reference |
| Gross | 240 | Total order value including Taxes and delivery |
| VAT | 40 | Total VAT value for the order |
| VAT_Code | "S" | VAT code |
| Currency | "GBP" | Order currency code |
| Extended_Data | null | Object containing additional order details (where applicable) |
| RetailCustomer | {}} | Object containing the retail customer details see retailcustomer resource |
| Items | [] | Array of retail order items see retailorderitem resource |
RetailOrder Methods
Example JSON request content to create a new Retail Order
{
"Warehouse_id": 0,
"Order_Number": "TEST2",
"Order_Ref": "DOUGTESTREF",
"Order_Source": "DOUGTEST",
"Marketplace_Ref": "MKPREF",
"Order_Date": "2017-07-03",
"Name": "Mr J Douglas Cryer",
"Address1": "12 Park Road North",
"Town": "Bedford",
"County": "Bedfordshire",
"Postcode": "MK41 7RH",
"Gross": 240,
"VAT": 40,
"Currency": "GBP",
"RetailCustomer": {
"Customer_Ref": "TESTCUST",
"Company_Name": "Telekinetix Limited",
"Title": "Mr",
"Forename": "J Douglas",
"Surname": "Cryer",
"Address1": "4-6 The Braodway",
"Town": "Bedford",
"County": "Bedfordshire",
"Postcode": "MK40 2TE",
"Country": "United Kingdom",
"Telephone": "08433 676 271",
"Email": "jdcryer@me.com",
"Comments": "Regular customer."
},
"Items": [
{
"Item_Ref": "1234",
"SKUSize": "A0000001010E",
"Barcode": "5060395910051",
"Quantity": 3,
"Item_Price": 30
},
{
"Item_Ref": "456",
"SKUSize": "16427005 B",
"Barcode": "5060409819004",
"Quantity": 2,
"Item_Price": 75
}
]
}
| GET | /api/retailorder |
|---|
Returns all stock in the system with all published fields.
| POST | /api/retailorder |
|---|
Parses the request object and creates a retail order (if validated). The retail customer and items are all passed as part of the request object. The total value of the items will be validated against the Gross value passed in the order header. If the RetailCustomer Customer_Ref is passed and exists the customer will be found and updated with any changes.
All exposed properties of the RetailOrder can be inserted with the exception of id and Order_Number. The eample given shows the recommended fields to be used. Please see the RetailOrderItems documentation for item fields which are allowable in a post.
The response will return the entire retailorder and in addition a response_status property. Possible values for the response_status property are shown below.
It is the responsibility of the developer to ensure that fields are filled to the customers requirement. This may vary based on shipping and processing requirements.
| Response Status | Description |
|---|---|
| Accepted | The order has been created without any issues. |
| Back Order | The order has items on it that are out of stock and has therefore been given a status of Pending_Stock. |
| Held - Invalid Pay Amount | The gross order value does not match the total of the order items. |
RetailOrderItem
Retail order item provides access to the item level of the retail/web order resource. This is currently a read only resource when called on its own.
RetailOrderItem Properties
Example of a returned retail order item response
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 2,
"RecordsFound": 2,
"RetailOrderItem": [
{
"id": 1,
"Order_id": 1,
"Item_Ref": "",
"Host_Item_Ref": "",
"SKUSize": "A0000001010A",
"Barcode": "",
"Article": "FLORAL 1",
"Colour": "OFF WHITE",
"Size": "S",
"Marketplace_Status": "confirmed",
"Quantity": 2,
"Item_Price": 28.99,
"Line_Total": 57.98,
"VAT_Total": 0,
"RRP": 28.99,
"VAT_Status": false,
"VAT_Rate": 0,
"Despatch_Date": "0000-00-00T00:00:00.000Z",
"Details": null
},
{
"id": 2,
"Order_id": 1,
"Item_Ref": "SHIPPING",
"Host_Item_Ref": "",
"SKUSize": "",
"Barcode": "",
"Article": "Delivery",
"Colour": "",
"Size": "",
"Marketplace_Status": "",
"Quantity": 1,
"Item_Price": 0,
"Line_Total": 0,
"VAT_Total": 0,
"RRP": 0,
"VAT_Status": false,
"VAT_Rate": 0,
"Despatch_Date": "0000-00-00T00:00:00.000Z",
"Details": null
}
]
}
}
| Property | Example | Description | Allowed in POST |
|---|---|---|---|
| id | 3421 | Unique id for the retail order item | No |
| Order_id | 1300 | Order id links the item to the order | No |
| Item_Ref | "SHIPPING" | test | Yes |
| Host_Item_Ref | "XXX001" | Marketplace/host reference for the line item | Yes |
| SKUSize | "" | Code for the product the order item is for | Yes (see note) |
| Barcode | "" | Barcode for the stock item | Yes |
| Article | "Delivery" | Article name | Yes |
| Colour | "" | Colour name | Yes |
| Size | "" | Size code | Yes |
| Marketplace_Status | "DEL" | Status for the line item from external system | No |
| Quantity | 1 | Quantity for the order item | Yes Mandatory |
| Item_Price | 30 | Price the item was sold for | Yes Mandatory |
| Line_Total | 30 | Total value for the line item (Quantity * SalesPrice) | No |
| VAT_Total | 4.92 | VAT total for the line | Yes |
| RRP | 0 | Original RRP from stock for the item (read only) | No |
| VAT_Status | true | Indicates the item is vatable | Yes |
| VAT_Rate | 20 | VAT rate | Yes |
| Despatch_Date | "0000-00-00T00:00:00.000Z" | Date item was despatched | No |
| Details | null | Object containing additional details about the order line | No |
| Status_Sent_To_Host | "0000-00-00T00:00:00.000Z" | Date the last status was sent to the marketplace or host | No |
| Return_Action | "" | Return action | No |
| Return_Reason | "" | Reason for cancellation or return | No |
| Return_Credit | false | test | No |
| Net_Own_Currency | 0 | test | No |
| Picked_Qty | 0 | Quantity picked | No |
| Return_Qty | 0 | Quantity returned | No |
| Parcel_Ref | "" | If set this will be the shipping parcel ref | No |
Retail Order Item Methods
| GET | /api/retailorderitem?orderhdrrsn=1 |
|---|
Returns all retail order items.
NOTE: When posting in an order the system will try and match the product passed on both SKUSize and Barcode to optimise matching. As SKUSize can contain multiple spaces between colour code and size letter this may provide you with an issue. To work around this you can replace spaces with underscores in the SKUSize field. If you pass back a SKUSize with underscores these will automatically be replaced with spaces for matching purposes.
Q. Why no POST option. A. All items must be sent as part of the retailorder message.
Invoice
Invoice provides access to the trade invoice resource.
Invoice Properties
{
"response": {
"Page": 1,
"PageCount": 4343,
"RecordsSent": 1,
"RecordsFound": 4343,
"Invoice": [
{
"RSN": 537,
"Number": "22567",
"AcCode": "WOLF",
"To": "WOLFE LTD\r23 Red Lion Street\rAylsham\rNorfolk\rNR11 6ER\r",
"InvDate": "2014-10-08T23:00:00.000Z",
"OurRef": "S00466",
"YourRef": "",
"Comments": "",
"SubtotalAmt": 0,
"Discount": 0,
"Net": 48,
"VAT": 11.1,
"Gross": 66.6,
"PayTerms": "PRO-FORMA",
"VatCode1": "S",
"VatCode2": "",
"VatCode3": "",
"VatCode4": "",
"VatRate1": "20.00%",
"VatRate2": "",
"VatRate3": "",
"VatRate4": "",
"VatAmt1": "9.60",
"VatAmt2": "",
"VatAmt3": "",
"VatAmt4": "",
"SettleDays": 0,
"SettleDiscount": 0,
"SettleDiscAmt": 0,
"DiscVatTot": 11.1,
"TotalQty": 4,
"Currency": "GBP",
"NetAmt1": "48.00",
"NetAmt2": "",
"NetAmt3": "",
"NetAmt4": "",
"ACVatNumber": "GB ",
"InvIssuer": 1,
"DeliveryAddr": "Wolf Ltd\r23 Red Lion Street\rAylsham\rNorfolk\rNR11 6ER\r",
"DespatchDate": "0000-00-00T00:00:00.000Z",
"SupplierNo": "",
"FactorCo_Accountstr": "",
"Period": "1410",
"RoyaltyDue": 0,
"ExchangeRate": 1,
"Paid": true,
"FollowUpComm": "£0.00 paid on 09/10/2014\r",
"PaidDate": "2014-10-08T23:00:00.000Z",
"DueDate": "2014-10-08T23:00:00.000Z",
"InvLines": 2,
"PayToCOIR": false,
"ConvertToGBP": false,
"Invoiced": true,
"Exported": false,
"SalesRgn": "",
"Balance": 0,
"ACVATcode": "1",
"CustCode": "WOLF",
"OKtoFile": true,
"intrastat_notc": "",
"Export_Ref": "7",
"SalesRep": "",
"DelCharge": 7.5,
"DelMethod": "Express pack ",
"Dispatch_Ref": "",
"Tradename": "CRK LONDON LTD",
"Payment_Method": "",
"FactoringClause": "",
"Print_Sizes": false,
"Items": [
{
"OurRef": "S00466",
"TheirRef": "",
"LineItem": "",
"SKU": "A0000008012",
"Description": "PAISLEY (PURPLE)",
"TotalQty": 1,
"UnitPrice": 12,
"DiscPer": 0,
"DiscAmt": 0,
"Total": 12,
"VATCode": "S",
"VATRate": 20,
"VATAmount": 2.4,
"Colour": "",
"Fixed": true,
"fk_invoice": 537,
"Line_Cost": 0,
"fk_supplier": 0,
"Size_Data": null
},
{
"OurRef": "S00466",
"TheirRef": "",
"LineItem": "",
"SKU": "A0000026009",
"Description": "RSF 14-189 Abu khaki (MULTI)",
"TotalQty": 3,
"UnitPrice": 12,
"DiscPer": 0,
"DiscAmt": 0,
"Total": 36,
"VATCode": "S",
"VATRate": 20,
"VATAmount": 7.2,
"Colour": "",
"Fixed": true,
"fk_invoice": 537,
"Line_Cost": 0,
"fk_supplier": 0,
"Size_Data": null
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| RSN | 1300 | Unique id of the order |
| CustomerRSN | 1092 | Customer id |
| OrderDate | "2017-01-12T00:00:00.000Z" | Creation date of the order |
| OrderStatus | "Pending_Scan" | Primary status for the order |
| OrderNumberstr | "01298" | Order number |
| DeliveryDate | "2017-01-17T00:00:00.000Z" | Required delivery date |
| OrderTotVAT | 0 | Total VAT value for the order |
| OrderTotGross | 213 | Total order value including Taxes and delivery |
| delname | "Ameer Jones" | Delievry customer name |
| deladd1 | "24 Bradford Road" | Delivery address line 1 |
| deladd2 | "Hackney " | Delivery address line 2 |
| deladd3 | "Hackney" | Delivery address line 3 |
| deladd4 | "London" | Delivery address line 4 |
| delpostcode | "HA453PQ" | Delivery postcode |
| SpecialDelivryInstructions | "" | Delivery instructions |
| DeliveryDate_Est | "0000-00-00T00:00:00.000Z" | Estimated delivery date |
| PickNoteNum | 1276 | Pick note number |
| History | "Delivery Confirmed 17/01/2017\rPicked 13/01/2017 12:34\r" | Order history |
| VATcodeletter | "S" | VAT code |
| CostCentre | 0 | test |
| DelAddresstxt | "24 Bradford Road\rHackney \rHackney\rLondon\rHA453PQ\rUnited Kingdom" | Full delivery address |
| ExportRefNum | 0 | ??? |
| CurrencyCode | "GBP" | Order currency code |
| DelNotePersonalMessage | "" | Delivery note personal message |
| TotalNet_owncurrency | 208.08 | Total net value of order |
| OrderStatus_old | "" | Previous order status |
| Order_Ref | "4703122564" | Order reference ??? |
| Order_Status_Web | "paid" | Web order status |
| Despatch_Ref | "" | Despatch reference |
| Order_Source | "SHOPIFY" | Order source |
| Marketplace_Ref | "4703122564" | Marketplace reference. Used for orders coming in from external systems. |
| delCountry | "United Kingdom" | Delivery address country name |
| Despatch_Carrier | "" | Despatch carrier service |
| Del_Address_Ref | "" | test |
| delCountryCode | "" | Delivery address country code |
| Sent_To_WH_Date | "0000-00-00T00:00:00.000Z" | Date the order was sent to external warehouse |
| Extended_Data | null | Object containing additional order details |
| Items | [] | Array of retail order items see retailorderitem resource |
Invoice Methods
| GET | /api/invoice |
|---|
Returns all invoices in the system with all published fields.
InvoiceItem
{
"response": {
"Page": 1,
"PageCount": 54605,
"RecordsSent": 1,
"RecordsFound": 54605,
"InvoiceItem": [
{
"OurRef": "S00455",
"TheirRef": "",
"LineItem": "",
"SKU": "A0000044012",
"Description": "3811 (PURPLE)",
"TotalQty": 12,
"UnitPrice": 7,
"DiscPer": 0,
"DiscAmt": 0,
"Total": 84,
"VATCode": "A",
"VATRate": 0,
"VATAmount": 0,
"Colour": "",
"Fixed": true,
"fk_invoice": 538,
"Line_Cost": 0,
"fk_supplier": 0,
"Size_Data": null
}
]
}
}
What you can do with InvoiceItem:
This is currently a read only resource when called on its own.
InvoiceItem Properties
| Property | Example | Description |
|---|---|---|
| RSN | 3421 | Unique id for the retail order item |
| SKUSize | "" | Code for the product the order item is for |
| OrderHdrRSN | 1300 | Order id links the item to the order |
| Item_Parcel_Ref | "" | ?? |
| Status_Sent_To_Host | "0000-00-00T00:00:00.000Z" | Date the last status was sent to the marketplace or host |
| DeliveryDate | "0000-00-00T00:00:00.000Z" | Date item was despatched |
| Quantity | 1 | Quantity for the order item |
| SalesPrice | 30 | Price the item was sold for |
| LineTotal | 30 | Total value for the line item (Quantity * SalesPrice) |
| Size | "" | Size code |
| ColourName | "" | Colour name |
| Article | "Delivery" | Article name |
| ReturnAction | "" | Return action |
| Vatable | true | Indicates the item is vatable |
| LineVATtotal | 4.92 | VAT total for the line |
| VATrate | 20 | VAT rate |
| RRP | 0 | Original RRP from stock for the item |
| ReturnReason | "" | Reason for cancellation or return |
| ReturnCredit | false | test |
| LineNet_owncurrency | 0 | test |
| Order_Item_Ref | "SHIPPING" | test |
| Item_Status_Web | "DEL" | Status for the line item from external system |
| Host_Item_Ref | "XXX001" | Marketplace/host reference for the line item |
| Original_Quantity | 0 | Original order quantity (used only if changed) |
| Barcode | "" | Barcode for the stock item |
| Item_Details | null | Object containing additional details about the order line |
| Picked_Qty | 0 | Quantity picked |
ConcessionHost
Customer provides access to the customer resource. This is where all trade customers are held.
ConcessionHost Properties
Example of a returned host object with an included stores http://URL/api/concessionhost?code=arnotts
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"Host": [
{
"id": 282,
"Code": "ARNOTTS",
"Name": "Arnotts",
"Address1": "",
"Address2": "",
"Town": "",
"County": "",
"Postcode": "",
"Country_Code": "",
"Country": "",
"Currency": "EUR",
"Telephone": "",
"Fax": "",
"Email": "",
"Status": 1,
"Discount": 0,
"Tradename": "Trade Name",
"Association": "Concession",
"Company_Reg_No": "",
"TAX_Number": "",
"TAX_Type": 1,
"Stores": [
{
"id": 295,
"Code": "ARDubli",
"Customer_Code": "ARNOTTS",
"Name": "Dublin Arnotts - Henry Street",
"Address1": "",
"Address2": "",
"Town": "",
"County": "",
"Postcode": "",
"Country": "IE",
"Address_Text": "Store Concession c/o Arnotts\rHenry Street\rDublin\rDublin",
"Currency": "EUR",
"Outlet_Type": "",
"Sales_rep": "",
"Date_Created": "2016-11-11T00:00:00.000Z",
"Date_Updated": "2017-11-07T00:00:00.000Z",
"Last_Transfer": "2017-11-08T00:00:00.000Z"
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 282 | Unique id for the host |
| Code | "SEDM" | Customer code |
| Name | "SEDMAN SHOES LTD" | Customer name |
| Address1 | "18 Main St" | Address line 1 |
| Address2 | "Hutton" | Address line 2 |
| Town | "Cranswick" | Town |
| County | "" | County |
| Postcode | "YO25 9QR" | Postcode |
| Country_Code | "GB" | Country code |
| Telephone | "" | Telephone number |
| Fax | "" | Fax number |
| "" | Customer primary email address | |
| Status | 1 | Account status |
| Discount | 0 | General discount percentage |
| Tradename | "CRK LONDON LTD" | Tradename to use for this company |
| Association | "" | Customer association type. Should be Concession or Ecomm |
| TAX_Number | "" | Customer VAT number |
| TAX_Type | 1 | VAT type code |
| Company_Reg_No | "" | Company registration number |
| Stores | [] | List of stores for the given host. See ConcessionStore resource for details. |
Customer Methods
| GET | /api/concessionhost |
|---|
Returns all hosts in the system .
ConcessionStore
Concession Store provides access to the concessionstore resource. Stores are concession host store addresses.
ConcessionStore Properties
Example of a returned store object http://URL/api/concessionstore?customer_code=arnotts
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"Store": [
{
"id": 295,
"Code": "ARDubli",
"Customer_Code": "ARNOTTS",
"Name": "Dublin Arnotts - Henry Street",
"Address1": "",
"Address2": "",
"Town": "",
"County": "",
"Postcode": "",
"Country": "IE",
"Address_Text": "Store Concession c/o Arnotts\rHenry Street\rDublin\rDublin",
"Currency": "EUR",
"Outlet_Type": "",
"Sales_rep": "",
"Date_Created": "2016-11-11T00:00:00.000Z",
"Date_Updated": "2017-11-07T00:00:00.000Z",
"Last_Transfer": "2017-11-08T00:00:00.000Z"
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 19 | Unique outlet id |
| Code | "SEDM" | Outlet code |
| Customer_Code | "SEDM" | Customer code |
| Name | "Sedman Shoes ltd" | Outlet name |
| Address1 | "18 Main St" | Address line 1 |
| Address2 | "Hutton" | Address line 2 |
| Town | "Cranswick" | Outlet Town |
| County | "" | Outlet county |
| Postcode | "YO25 9QR" | Outlet postcode |
| Address | "18 Main St\rHutton\rCranswick\rYO25 9QR\r" | Address |
| Currency | "GB1" | Customer currency |
| Outlet_Type | "Universities" | Type of outlet |
| Country | "Great Britain" | Country name |
| Sales_Rep | "Joan Summer" | Sales rep allocated to outlet |
| Date_Created | "2014-06-10T23:00:00.000Z" | Date outlet record created |
| Date_Updated | "2016-11-01T00:00:00.000Z" | Date outlet record last updated |
| Last_Transfer | "0000-00-00T00:00:00.000Z" | Date of last transfer to outlet (concession) |
Outlet Methods
| GET | /api/concessionstore |
|---|
Returns all concession stores in the system .
ConcessionStoreDetail
Concession Store Detail provides access to the concessionstoredetail resource. The concession store details hold sumary stats and other information about a concession store. In addition notes and linked images (5 max) can be returned.
ConcessionStoreDetail Properties
Example of a returned store object http://URL/api/concessionstoredetail?id=4
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"StoreDetail": [
{
"id": 4,
"Code": "RSilevel",
"Host_Store_Code": "RS10001",
"Account_Code": "RETAILST",
"Name": "iLevel EPOS Demo",
"Reference": "i.Level",
"Yesterday_Pieces": 0,
"Yesterday_Amount": 0,
"WTD_Pieces": 0,
"WTD_Amount": 0,
"LWK_Pieces": 0,
"LWK_Amount": 0,
"WKB_Pieces": 0,
"WKB_Amount": 0,
"Stock_Units": 55,
"Stock_Value": 5100,
"Rank": 1,
"Last_Scan": "0000-00-00T00:00:00.000Z",
"Images": [],
"Notes": []
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 4 | Unique outlet id |
| Code | "RSilevel" | Store code |
| Host_Store_Code | "RS10001" | The hosts store code (with prefix) |
| Account_Code | "RETAILST" | The host account code |
| Name | "iLevel EPOS Demo" | The store name |
| Yesterday_Pieces | 0 | Pieces sold yesterday |
| Yesterday_Amount | 0 | Value sold yesterday |
| WTD_Pieces | 0 | Pieces sold week to date |
| WTD_Amount | 0 | Value sold week to date |
| LWK_Pieces | 0 | Pieces sold last week |
| LWK_Amount | 0 | Value sold last week |
| WKB_Pieces | 0 | Pieces sold week before last |
| WKB_Amount | 0 | Value sold week before last |
| Stock_Units | 55 | Stock units at store |
| Stock_Value | 5100 | Stock value at store |
| Rank | 1 | Store ranking |
| Last_Scan | "0000-00-00T00:00:00.000Z" | Date of last store scan |
| Images | [] | Object containing images for the store (up to 5) |
| Notes | [] | Object containing store notes pulled from ConcessionStoreNote resource. |
ConcessionStoreDetail Methods
| GET | /api/concessionstoredetail |
|---|
Returns the detail for all concession stores in the system.
ConcessionStoreNote
Concession Store Note provides access to the concessionstorenote resource. The concession store note holds notes created for a the concession stores. The resource is also available as a child of the concessionstoredetail resource.
ConcessionStoreNote Properties
Example of a returned note object http://URL/api/concessionstorenote
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"StoreNote": [
{
"id": 1,
"Store_Detail_ID": 17,
"Note": "This is a test note",
"Created_Date": "2018-01-06T00:00:00.000Z",
"Note_Type": ""
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 4 | Unique note id |
| Store_ID | 17 | ID of the store detail record the note is linked to |
| Note | "The quick brown fox jumps over the lazy dog." | The note test |
| Created_Date | "2018-01-06T00:00:00.000Z" | The date the note was created |
| Note | "RS10001" | The hosts store code (with prefix) |
ConcessionStoreNote Methods
| GET | /api/ConcessionStoreNote |
|---|
Returns the detail for all concession stores in the system.
| POST | /api/ConcessionStoreNote |
|---|
Creates a new note based on the json content posted. To create a note you must pass a valid store detail ID and note text as a minimum.
| PUT | /api/ConcessionStoreNote |
|---|
Updates an existing note (id of note) passed in request object. To update an existing note you must pass an id and note text as a minimum.
| DELETE | /api/ConcessionStoreNote/#noteID |
|---|
Deletes the note with id passed as /#noteID.
ConcessionStock
Concession Store Note provides access to the concessionstorenote resource. The concession store note holds notes created for a the concession stores. The resource is also available as a child of the concessionstoredetail resource.
ConcessionStock Properties
Example of a returned ConcessionStock object http://URL/api/ConcessionStock
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"ConcessionStock": [
{
"id": 11304,
"Account_Code": "RETAILST",
"Store_Code": "RSilevel",
"Style": "HULK1",
"SKU": "HULK1001",
"SKUSize": "HULK1001 A",
"Colour": "BLACK",
"Size": "8",
"Size_Sort": 1,
"Quantity": 10,
"Value": 1000,
"Sell_Price": 100,
"Sell_Price_Alt1": 100,
"Sell_Price_Alt2": 0,
"Sales_Yesterday_Pieces": 0,
"Sales_Yesterday_Amount": 0,
"Sales_WTD_Pieces": 0,
"Sales_WTD_Amount": 0,
"Sales_LWK_Pieces": 0,
"Sales_LWK_Amount": 0,
"Sales_Today_Pieces": 0,
"Sales_Today_Amount": 0,
"Trans_WTD_Pieces": 0,
"Trans_WTD_Amount": 0,
"Trans_LWK_Pieces": 0,
"Trans_LWK_Amount": 0,
"Brand": "i.Level",
"Store_Count": "",
"Last_Stock_Date": "2017-05-21T12:49:51.000Z",
"Last_Transfer_Date": "2017-05-21T23:00:00.000Z",
"Last_Transaction_Date": "2017-05-21T23:00:00.000Z",
"Replenishment": false,
"Replen_Multiplier": 0
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 11304 | Unique concession stock id |
| Account_Code | "RETAILST" | Account code the stock item relates to |
| Store_code | "RSilevel" | Store code of the store the stock belongs to |
| Style | "HULK1" | Style of the concession stock item |
| SKU | "HULK1001" | SKU of the concession stock item |
| SKUSize | "HULK1001 A" | SKUSize of the concession stock item |
| Colour | "HULK1" | The item colour |
| Size | "HULK1" | The item size |
| Size_Sort | "HULK1" | The size sort fr the item |
| Quantity | "HULK1" | The quantity in store stock for the item |
| Value | "HULK1" | The stock value for the item |
| Sell_Price | 100 | The own currency sell price for the item |
| Sell_Price_Alt1 | 120 | The alternative sell price for the item in an alternative currency |
| Sell_Price_Alt2 | 0 | A second alternative sell price for the item in an alternative currency |
| Sales_Yesterday_Pieces | 0 | Sold items yesterday |
| Sales_Yesterday_Amount | 0 | Sold value yesterday |
| Sales_WTD_Pieces | 0 | Sold items week to date |
| Sales_WTD_Amount | 0 | Sold value week to date |
| Sales_LWK_Pieces | 0 | Sold items last week |
| Sales_LWK_Amount | 0 | Sold value last week |
| Sales_Today_Pieces | 0 | Sold items today |
| Sales_Today_Amount | 0 | Sold value today |
| Trans_WTD_Pieces | 0 | Transferred items week to date |
| Trans_WTD_Amount | 0 | Transferred value week to date |
| Trans_LWK_Pieces | 0 | Transferred items last week |
| Trans_LWK_Amount | 0 | Transferred value last week |
| Brand | "i.Level" | Brand name |
| Store_count | 0 | Store count quantity |
| Last_Stock_Date | "2017-05-21T12:49:51.000Z" | Last stock change date |
| Last_Transfer_Date | "2017-05-21T12:49:51.000Z" | last transfer date |
| Last_Transaction_Date | "2017-05-21T12:49:51.000Z" | last transaction date |
| Replenishment | false | Replenishment flag |
| Replen_Multiplier | 0 | Replenishment multiplier |
ConcessionStock Methods
| GET | /api/ConcessionStock |
|---|
Returns the detail for all concession stock in the system.
ConcessionSale
Shows concession sale and delivery entries.
ConcessionSale Properties
Example of a Concession sale record entry in JSON format.
http://URL/api/concessionsale
{
"response": {
"Page": 1,
"PageCount": 210,
"RecordsSent": 100,
"RecordsFound": 20941,
"ConcessionSale": [
{
"id": 1,
"Style": "A0000001",
"SKUSize": "A0000001010A",
"Size": "S",
"Quantity": 2,
"Barcode": "5060395910013",
"Sale_Date": "2014-09-09T23:00:00.000Z",
"Entry_date": "2014-09-18T23:00:00.000Z",
"Store_ID": "OWNWEB01",
"Store_Code": "OWNWEB01",
"Total_Value": 57.98,
"Type": "Sale",
"Host": "ECOMM",
"Brand": "",
"RRP": 28.99,
"Discount": 0,
"Concession_Sale_ID": 1,
"Delivery_Reference": "OWNWEB01",
"Value_Own_Currency": 0,
"Sent_To_Portal": "0000-00-00T00:00:00.000Z",
"Till_Number": "",
"Operator": "",
"Till_Sale_ID": 0,
"Net_Value": 48.32,
"VAT_Value": 9.66,
"VAT_Rate": 0,
"Return_Reason_Code": "",
"Return_Discount_Reason": "",
"Actual_Store": "OWNWEB01",
"Original_Store": "",
"Original_Transaction_Date": "0000-00-00T00:00:00.000Z"
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 5190 | Unique ID of the sale |
| Style | "WB0001" | Style for the stock item |
| SKUSize | WB0001021 A | SKU/Size for the stock item |
| Size | "8" | Size for the stock item |
| Quantity | "-1" | Quantity of stock moved in this sale/delivery |
| Barcode | "5054604012308" | Barcode for the stock item |
| Sale_Date | "2017-01-24T00:00:00.000Z" | Date the sale took place |
| Entry_date | "2017-01-27T00:00:00.000Z" | Date the sale was loaded into i.LEVEL |
| Store_ID | "DB9999" | Host store code (with prefix) |
| Store_Code | "DBDump" | i.LEVEL store code |
| Total_Value | -20 | Total value of the sale/delivery |
| Type | "Sale" | Either Sale/Delivery |
| Host | "DEBENHAM" | Retail host this sale was made under |
| Brand | "i.Level" | Brand for the stock item |
| RRP | 22 | RRP for the stock item |
| Discount | -2 | Discount applied to this sale |
| Concession_Sale_ID | 5190 | Unique ID of the sale |
| Delivery_Reference | "DBsalesimporttest.SLE" | File the sale information was contianed in |
| Value_Own_Currency | -20 | Value of the sale in own currency |
| Sent_To_Portal | "0000-00-00T00:00:00.000Z" | Date sale was sent to central portal |
| Till_Number | "010" | Till number this sale was taken on |
| Operator | "0009003" | Operator ID that took this sale |
| Till_Sale_ID | "2511" | ID for this sale recorded on the till |
| Net_Value | "-16.67" | Net total value of this sale |
| VAT_Value | "OWNWEB01" | VAT total value of this sale |
| VAT_Rate | 20 | VAT rate applied to this sale |
| Return_Reason_Code | "Return" | Code assigned to the return reason |
| Return_Discount_Reason | "Item was originally on sale" | Reason for return discount |
| Actual_Store | "DB0036" | Store where the return was made |
| Original_Store | "DB0036" | Store where the product was originally sold |
| Original_Transaction_Date | "0000-00-00T00:00:00.000Z" | Date the product was originally sold |
ConcessionSale Methods
| GET | /api/concessionsale |
|---|
Returns all sales and deliveries with all fields.
| GET | /api/concessionsale?sale_type=sale |
|---|
Returns all sales with sale specific fields.
| GET | /api/concessionsale?sale_type=delivery |
|---|
Returns all deliveries with delivery specific fields.
ShowZeros Custom Parameter
The ShowZeros parameter can be used to display sizes for the order item that have a zero quantity in them. By default the behaviour is to return only sizes that have a non zero quantity.
| GET | /api/concessionsale?showzeros=true |
|---|
ConcessionTransfer
Shows entries of transfers to and from concession stores.
ConcessionTransfer Properties
Example of a Concession Transfer
http://URL/api/concessiontransfer
{
"response": {
"Page": 1,
"PageCount": 15,
"RecordsSent": 100,
"RecordsFound": 1488,
"ConcessionTransfer": [
{
"id": 414,
"Reference": "00474",
"Account_Code": "NEWLOOK",
"Store_Code": "NLBorde",
"Brand_Ref": "i.Level",
"Transfer_Date": "2017-05-01T23:00:00.000Z",
"Transfer_Status": "Delivery",
"Total_Quantity": 10,
"Total_Value": 750,
"Number_Cartons": 0,
"Depot_Involved": "Main Warehouse",
"id_Source": 0,
"PO_Reference": "",
"Sent_To_Warehouse_Date": "0000-00-00T00:00:00.000Z",
"Dispatch_Date": "0000-00-00T00:00:00.000Z",
"Items": [
{
"id": 1395,
"Concession_Transfer_id": 414,
"SKU": "STARK1001",
"Article": "Test Item (BLACK)",
"Colour_Number": "001",
"Colour_Name": "BLACK",
"Location": "",
"Total_Quantity": 5,
"Assortment_Multiplier": 0,
"Store_Customer_Code": "NL2/4ge",
"Sell_Price": 10,
"Sell_Currency": "GBP",
"RRP": 50,
"RRP_Currency": "GBP",
"Brand": "i.LEVEL",
"Product_Group": "Blazers",
"Total_Sell": 250,
"No_Barcode_Labels": 0,
"Sizes": [
{
"SKUSize": "STARK1001 A",
"Size": "8",
"Qty": 1,
"SizeSort": 1
},
{
"SKUSize": "STARK1001 B",
"Size": "10",
"Qty": 1,
"SizeSort": 2
},
{
"SKUSize": "STARK1001 C",
"Size": "12",
"Qty": 1,
"SizeSort": 3
},
{
"SKUSize": "STARK1001 D",
"Size": "14",
"Qty": 1,
"SizeSort": 4
},
{
"SKUSize": "STARK1001 E",
"Size": "16",
"Qty": 1,
"SizeSort": 5
}
]
},
{
"id": 1394,
"Concession_Transfer_id": 414,
"SKU": "HULK1001",
"Article": "Transfer Test Item (BLACK)",
"Colour_Number": "001",
"Colour_Name": "BLACK",
"Location": "",
"Total_Quantity": 5,
"Assortment_Multiplier": 0,
"Store_Customer_Code": "NL2/4ge",
"Sell_Price": 0,
"Sell_Currency": "GBP",
"RRP": 100,
"RRP_Currency": "GBP",
"Brand": "i.LEVEL",
"Product_Group": "Blazers",
"Total_Sell": 500,
"No_Barcode_Labels": 0,
"Sizes": [
{
"SKUSize": "HULK1001 A",
"Size": "8",
"Qty": 1,
"SizeSort": 1
},
{
"SKUSize": "HULK1001 B",
"Size": "10",
"Qty": 1,
"SizeSort": 2
},
{
"SKUSize": "HULK1001 C",
"Size": "12",
"Qty": 1,
"SizeSort": 3
},
{
"SKUSize": "HULK1001 D",
"Size": "14",
"Qty": 1,
"SizeSort": 4
},
{
"SKUSize": "HULK1001 E",
"Size": "16",
"Qty": 1,
"SizeSort": 5
}
]
}
]
},
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 414 | Unique ID of the transfer |
| Reference | "00474" | Delivery Reference, links data to ConcessionSale |
| Account_Code | "NEWLOOK" | Host transfer was made to |
| Store_Code | "NLBorde" | Store transfer was made to |
| Brand_Ref | "i.Level" | Brand stock belongs to |
| Transfer_Date | "2017-05-01T23:00:00.000Z" | Date transfer was created |
| Transfer_Status | "Delivery" | Status of the Transfer, Delivery, Dispatched etc. |
| Total_Quantity | 10 | Total quantity of stock in the transfer |
| Total_Value | 750 | Total value od stock in the transfer |
| Number_Cartons | 0 | Number of Cartons transfer is packed into |
| Depot_Involved | "Main Warehouse" | Source of the stock |
| id_Source | 0 | Unique ID of the Depot |
| PO_Reference | "" | ??? |
| Sent_To_Warehouse_Date | "0000-00-00T00:00:00.000Z" | Date used by transfers from Store to Depot |
| Dispatch_Date | "0000-00-00T00:00:00.000Z" | Date dispatched from Warehouse |
| Items | [] | Array of Concession Transfer items see concessiontransferitem resource |
ConcessionTransfer Methods
| GET | /api/concessiontransfer |
|---|
ShowZeros Custom Parameter
The ShowZeros parameter can be used to display sizes for the order item that have a zero quantity in them. By default the behaviour is to return only sizes that have a non zero quantity.
| GET | /api/concessiontransfer?showzeros=true |
|---|
ConcessionTransferItem
What you can do with ConcessionTransferItem:
This is currently a read only resource when called on its own.
ConcessionTransferItem Properties
Example of a ConcessionTransferItem response
http://URL/api/concessiontransferitem
{
"response": {
"Page": 1,
"PageCount": 29,
"RecordsSent": 100,
"RecordsFound": 2857,
"ConcessionTransferItem": [
{
"id": 3025,
"Concession_Transfer_id": 1600,
"SKU": "CLTAB001",
"Article": "Tab dress (BLACK)",
"Colour_Number": "001",
"Colour_Name": "BLACK",
"Total_Quantity": 4,
"Assortment_Multiplier": 0,
"Store_Customer_Code": "DPFareh",
"Sell_Price": 15,
"Sell_Currency": "GBP",
"RRP": 30,
"RRP_Currency": "GBP",
"Brand": "i.LEVEL",
"Product_Group": "Dresses",
"Total_Sell": 120,
"No_Barcode_Labels": 0,
"Sizes": [
{
"SKUSize": "CLTAB001 A",
"Size": "S",
"Qty": 1,
"SizeSort": 1
},
{
"SKUSize": "CLTAB001 B",
"Size": "M",
"Qty": 1,
"SizeSort": 2
},
{
"SKUSize": "CLTAB001 C",
"Size": "L",
"Qty": 1,
"SizeSort": 3
},
{
"SKUSize": "CLTAB001 D",
"Size": "XL",
"Qty": 1,
"SizeSort": 4
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 3025 | Unique ID of this Concession Transfer Item |
| Concession_Transfer_id | 1600 | Transfer this item is apart of |
| SKU | "CLTAB001" | SKU of the stock item |
| Article | "Tab dress (BLACK)" | Article of the stock item |
| Colour_Number | "001" | Colour code of the stock item |
| Colour_Name | "BLACK" | Colour name of the stock item |
| Total_Quantity | 4 | Total quantity of this SKU in the transfer |
| Assortment_Multiplier | 0 | ??? |
| Store_Customer_Code | "DPFareh" | Code of the store being transfered to |
| Sell_Price | 15 | Trade Price of the stock item |
| Sell_Currency | "GBP" | Trade currency of the stock item |
| RRP | 30 | Retail Price of the stock item |
| RRP_Currency | "GBP" | Retail currency of the stock item |
| Brand | "i.LEVEL" | Brand of the stock item |
| Product_Group | "Dresses" | Product Group of the stock item |
| Total_Sell | 120 | Total sell value of this item |
| No_Barcode_Labels | 0 | ??? |
| Sizes | Array | Array of size level item quantities |
|---|---|---|
| SKUSize | "CLTAB001 A" | SKU/Size level code |
| Size | “M” | Size code |
| Qty | 1 | Quantity for the size in the line |
| SizeSort | 2 | The size sort code for the size item |
ShowZeros Custom Parameter
The ShowZeros parameter can be used to display sizes for the order item that have a zero quantity in them. By default the behaviour is to return only sizes that have a non zero quantity.
Agent
Agent provides access to the agent resource. This is where agent details are held. Agents can be sales agents, managers, agent groups or store controllers.
Agent Properties
Example of a returned agent object http://78.129.209.153:19223/api/agents?type=store@
In this case a filter has been applied to return only store controllers
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"Agent": [
{
"id": 2,
"Title": "",
"Name": "Ryan Felton",
"Company": "",
"Address1": "",
"Address2": "",
"Town": "",
"County": "",
"Postcode": "",
"Country_Code": "GB",
"Telephone": "",
"Mobile": "",
"Fax": "",
"Email": "",
"Type": "Store Controller",
"Group_Manager": "",
"Brand_Restrictions": "",
"Details": {
"Stores": [
12,
15,
16,
17,
681
]
},
"Comments": ""
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | 2 | Unique id for the agent record |
| Title | "Mr" | Agents title |
| Name | "Ryan Felton" | The agents name |
| Address1 | "18 Main St" | Address line 1 |
| Address2 | "Hutton" | Address line 2 |
| Town | "Cranswick" | Town |
| County | "" | County |
| Postcode | "YO25 9QR" | Postcode |
| CountryCode | "GB" | Country code |
| Telephone | "" | Telephone number |
| Mobile | "" | Mobile number |
| Fax | "" | Fax number |
| "" | Customer primary email address | |
| Type | "Store Controller1" | Agent type |
| Group_Manager | "" | Name of the group or the manager of the agent (depending on type) |
| Brand_Restrictions | "" | List of brands if the agent is brand restricted. The list is tab seperated. |
| Details | [] | An object field containing agent extended data options. Store controller agents will see a list of outlet ids in a Stores array. |
| Comments | "Note about agent" | General note about agent. |
Agent Methods
| GET | /api/agent |
|---|
Returns all agents in the system.
ScanQueue
ScanQueue provides access to the scan queue resource. This can be used to get a list of current and past scan jobs. It can also be used to create new scan jobs from a third party scanning application.
ScanQueue Properties
{
"response": {
"Page": 4,
"PageCount": 20,
"RecordsSent": 1,
"RecordsFound": 20,
"ScanQueues": [
{
"UUID": "EF721415CA71974D9B724DDE84821B31",
"Job_Ref": "merc1 test",
"fk_device": "20E92FB565BBED45984BA530771B0A0D",
"Scan_Type": "COUNT",
"Creation_Date": "2016-12-07T11:32:39.000Z",
"Complete_Date": "2016-12-07T11:32:39.000Z",
"Scan_Note": "",
"Split": false,
"Status": 4,
"Box_Count": 1,
"Device_Code": "MER001",
"ScanItems": [
{
"UUID": "8AA1EB7B05F13D43A198223D36647D3A",
"fk_scan_queue": "EF721415CA71974D9B724DDE84821B31",
"Barcode": "9999999000706",
"Qty_Scanned": 2,
"Qty_Required": 0,
"SKU": "",
"Size": "",
"Item_Data": null
},
{
"UUID": "23303FCD919413458D65BC6365A3AA31",
"fk_scan_queue": "EF721415CA71974D9B724DDE84821B31",
"Barcode": "9999999000690",
"Qty_Scanned": 2,
"Qty_Required": 0,
"SKU": "",
"Size": "",
"Item_Data": null
}
]
}
]
}
}
| Property | Example | Description |
|---|---|---|
| UUID | "EF721415CA71974D9B724DDE84821B31" | Unique id of the scan queue |
| Job_Ref | "Test scan 1" | Customer id |
| fk_device | "20E92FB565BBED45984BA530771B0A0D" | ID of allocated device |
| Scan_Type | "COUNT" | Scan job type code |
| Creation_Date | "2017-01-16T00:00:00.000Z" | Scan job creation date |
| Complete_Date | "2017-01-17T00:00:00.000Z" | Scan job completion date |
| Scan_Note | "Test note" | Note for the scan job |
| Split | false | Split scan job indicator |
| Status | 4 | Status code |
| Box_Count | "1" | Number of boxes |
| Device_Code | "DEV001" | Name of the device the scan has been allocated to |
| ScanItems | [] | Array of scan items see scanitems resource |
ScanQueue Methods
| GET | /api/scanqueue |
|---|
Returns all scan queues in the system with all published fields.
| POST | /api/scanqueue |
|---|
Parses the POST body and create or updates a scan queue with items.
ScanItem
What you can do with ScanItem:
This is currently a read only resource when called on its own. It must always be called as a sub resource of scanqueue.
ScanItem Properties
/api/scanqueue/#scanqueueid/scanitem
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 2,
"RecordsFound": 2,
"ScanItem": [
{
"UUID": "8AA1EB7B05F13D43A198223D36647D3A",
"fk_scan_queue": "EF721415CA71974D9B724DDE84821B31",
"Barcode": "9999999000706",
"Qty_Scanned": 2,
"Qty_Required": 0,
"SKU": "",
"Size": "",
"Item_Data": null
},
{
"UUID": "23303FCD919413458D65BC6365A3AA31",
"fk_scan_queue": "EF721415CA71974D9B724DDE84821B31",
"Barcode": "9999999000690",
"Qty_Scanned": 2,
"Qty_Required": 0,
"SKU": "",
"Size": "",
"Item_Data": null
}
]
}
}
| Property | Example | Description |
|---|---|---|
| UUID | 8AA1EB7B05F13D43A198223D36647D3A" | Unique record id for the scan item |
| fk_scan_queue | "EF721415CA71974D9B724DDE84821B31" | scanqueue id |
| Barcode | "9999999000706" | Barcode for the scan item |
| Qty_Scanned | 2 | Quantity scanned |
| Qty_Required | 0 | Quantity required |
| SKU | "" | |
| Size | "" | |
| Item_Data | null | Scan item data used for box information. |
Device
Device provides access to the list of devices associated with scanning.
Device Properties
Example of a returned device object.
{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 1,
"RecordsFound": 1,
"Device": [
{
"id": "F93AB6294DD7334DA0423C89E3D7C0B2",
"Device_Code": "TEST001",
"Device_Type": "PT983-II",
"Detail": "",
"Status": "Active"
}
]
}
}
| Property | Example | Description |
|---|---|---|
| id | "F93AB6294DD7334DA0423C89E3D7C0B2" | Unique id of the device |
| Device_Code | "TEST001" | Customer id |
| Device_Type | "PT983-II" | The type of device, oftemn model number. |
| Detail | "" | Notes about the device |
| Status | "Active" | Current status of the device. |
Device Methods
| GET | /api/device |
|---|
Returns all devices in the system with all published fields.
Errors
The Kittn API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 410 | Gone |
| 418 | I'm a teapot |
| 429 | Too Many Requests |
| 500 | Internal Server Error |
| 503 | Service Unavailable |