Products into Imagine
To get products in and out of Imagine you would use the Master Item Resource.
Before creating/updating items you will need to ensure all metadata has been added to Imagine. For example when creating an item it is required to have a vendorId, the vendor cannot be created through the item endpoints and must be created through its own vendor endpoint.
Every Product in Imagine must belong to a Master Item, the Master Item then contains Items which are different variations the item comes in.
An Example of this is a T-Shirt that comes in multiple colours and sizes. The Master Item acts as a header and the Items would be the unique variations such as Small Black, Medium Black...
If the item comes in only a single variation it would still contain a single Item within the Master item.
What you can do with Master Items
The Imagine API lets you do the following with the Master Item resource. More detailed versions of these general actions may be available here https://postman.k3imagine.com
Retrieves a list of Master Items including items
Retrieves a paginated list of Master items
Retrieves a paginated list of Master items including their items
Retrieves a singe Master items
Creates a new Master Item
Creates multiple new Master Items
Updates a Master Item
Deletes a Master Item
Master Item Properties
|
id READ-ONLY |
"id": 38 A unique numeric identifier for the Master item. Each id is unique across the Imagine system |
|
masterItemNo |
"masterItemNo": "000311" A unique numeric identifier for the Master item. Each id is unique across the Imagine system |
|
name |
"name": "iMac" The name of the Master Item |
|
imageUrl |
"imageUrl": "https://k3imagine.com/files/iMac.PNG" A image URL associated to the Master item. Only .bmp, .gif, .jpg and .svg type images are supported |
|
description |
"description": "iMac" A description of the Master item. |
|
active |
"active": true Whether the Master Item is active. |
|
type |
"type": 0 The type of Item this can be . |
|
defaultReorderPoint |
"defaultReorderPoint": 1.00 The default reorder point for the item |
|
defaultRestockLevel |
"defaultRestockLevel": 5.00 The default restock level for the item |
|
created |
"modified": "2019-06-10T09:30:39.7629772+00:00" The date the Master Item was created |
|
modified |
"modified": "2019-06-10T09:30:39.7629772+00:00" The date the Master Item was modified |
|
manufacturerMasterItemNo |
"manufacturerMasterItemNo": "iMac00l" A manufactur number associated to the Master Item |
|
items |
[{ "id": 202, "prices": [], "itemDimensionValues": [ { "id": 372, "itemId": 202, "dimensionName": "HDD in TB", "dimensionSequence": 4, "valueSequence": 1, "axis": "vert", "code": "1", "value": "1", "dataType": 2 }, { "id": 368, "itemId": 202, "dimensionName": "Finish", "dimensionSequence": 1, "valueSequence": 1, "axis": "horz", "code": "Silver", "value": "Silver", "dataType": 2 }, { "id": 376, "itemId": 202, "dimensionName": "Processor", "dimensionSequence": 6, "valueSequence": 1, "axis": "horz", "code": "1.3", "value": "1.3", "dataType": 2 } ], "alternativeBarcodes": [], "itemAttributeValues": [], "itemTaxCodes": [], "masterItemId": 36, "itemNo": "000308", "name": "Macbook", "type": 0, "description": "Macbook", "barcode": "03000000024", "unitCost": 700.00, "salesPrice": 1949.00, "currencyCode": "", "salesUomCode": "", "itemHierarchyNodeId": 10, "vendorId": 5, "imageUrl": "https://cdn.shopify.com/s/files/1/0142/2337/6441/files/macbook.PNG?14401372262326385772", "active": true, "reorderQuantity": 0.0, "restockLevel": 0.0, "reorderNumber": null } ] A list of Items which belong to the Master item, each representing a different version. |
Endpoints
Retreive all Master Items
GET https://publicapi.k3imagine.com/api/v1.0/MasterItem
Response: 200
Retreive paginated list of Master Items
GET https://publicapi.k3imagine.com/api/v1.0/MasterItem/paged/0/10
Response: 200
Retreive paginated list of Master items including their items
GET https://publicapi.k3imagine.com/api/v1.0/MasterItem/paged/withitems/0/10
Response: 200
Retreive a single Master Item
GET https://publicapi.k3imagine.com/api/v1.0/MasterItem/masteritemno/10001
Response: 200
Create a single Master Item
POST https://publicapi.k3imagine.com/api/v1.0/MasterItem
Response: 200
Create Multiple Master Items
POST https://publicapi.k3imagine.com/api/v1.0/MasterItem/list
Response: 200
Update a Master Items
PUT https://publicapi.k3imagine.com/api/v1.0/MasterItem
Response: 200
Delete a Master Item
DEL https://publicapi.k3imagine.com/api/v1.0/MasterItem/1
Response: 200