HostProduct
This is primarily intended as a read only resource, due to the complexity of linking a hostProdct to an original product as well as strict host requiremets. The resource returns the Host instance of the product data that has been copied for enrichment purposes.
danger
If a developer did want to attempt to post data in to the host product they would need to implement host look up lists and properties and ensure that they keep them up to date within their system. Depending on the host this can be a significantly time consuming and daunting task.
Host Product Properties
| Property | Example | Description |
|---|---|---|
| id | "AFB765..." | Unique id for the hostProduct record |
| fk_store | "5AEE4D..." | Foreign key to the id of the store to which the enriched record is linked |
| fk_product | "1A3835..." | Foreign key to the id of the product that was originally uploaded. |
| name | "Cropped frill shirt" | the name of the product as it will be uplaoded to the host system |
| status | "Uploaded" | The current status New, Validated, Uploaded, Discontinued |
| createdDate | "2020-07-17T14:37:56" | The date the host product was created in the enrichment queue |
| validatedDate | "2020-08-28T15:26:51" | Date the product was validated through the enrichment screen |
| sentToHostDate | "2020-09-01T09:39:30" | Date the product was uploaded to the host |
| discontinueDate | "" | Date the product was discontinued for the host channel |
| detail | {object} | This field will contain much of the host specific enrichment data |
| hostProduct_store | {relate entity} | Related store details |
| hostProduct_product | {relate entity} | The original product detail |
| hostProduct_hostVariant | [related entities] | A collection of the enriched hostVariant details for the hostProduct |
Host Product Methods
| GET | /api/hostProduct |
|---|
Returns all hostProduct records for the current scope with all published fields.
| POST | /api/hostProduct |
|---|
Allows for the posting of hostProducts these must be linked to products correctly and contain all required host properties. This will require additional lookups and documentation to be provided.
Example
Example of a returned hostProduct entity
{
"response": {
"page": 1,
"pageCount": 54,
"recordsSent": 100,
"recordsFound": 5348,
"hostProduct": [
{
"id": "AFB765C68637F04384B64895935325C0",
"fk_store": "5AEE4DB4C520B740ABA582528E1E8ABB",
"fk_product": "1A383540D5E0E143847BD0C6B47DE456",
"name": "Cropped frill shirt",
"status": "Uploaded",
"createdDate": "2020-07-17T14:37:56",
"validatedDate": "2020-08-28T15:26:51",
"sentToHostDate": "2020-09-01T09:39:30",
"discontinueDate": "",
"hostReference": "",
"detail": {
"webDescription": "Web description?",
"images": [
{
"sourceURL": "http://test.co.uk/test.jpg",
"type": "SECONDARY",
"code": "Cream/Navy Broken Stripe",
"codeType": "COLOUR",
"variants": [
"21990BB05B04424CA577B2DFD09C184E",
"4855E089BA833740851821EAAABEE514",
"89979BF07440AC45B00CD9BB783E4B6C",
"98101F0E910E364E82FEBA7BFDE10A6A"
]
},
{
"sourceURL": "http://test.co.uk/test.jpg",
"type": "PRIMARY",
"code": "7039",
"codeType": "COLOUR",
"variants": [],
"note": ""
},
{
"sourceURL": "https://dev.ilevelconnect.co.uk/brandImages/17076BDDE29E96478A3F1C8E711BF122/BB55DC9437001A44A3F21E0DA56A40A4_blue_dress.jpg",
"type": "SECONDARY",
"code": "7039",
"codeType": "COLOUR",
"variants": [],
"note": "aaa"
},
{
"sourceURL": "http://test.co.uk/test.jpg",
"type": "SWATCH",
"code": "7039",
"codeType": "COLOUR",
"variants": []
}
],
"colourBreakdown": [
{
"colour": "Cream/Navy Broken Stripe",
"webDescription": "Cropped shirt with frill hem",
"approved": true
}
],
"categories": [
{
"id": 26,
"value": "New In"
},
{
"id": 36,
"value": "Tops"
}
],
"searchKeywords": [
{
"id": 1,
"value": "Testing Keyword",
"uid": "1",
"boundindex": 0,
"uniqueid": "1620-22-16-30-182425",
"visibleindex": 0
}
],
"featured": true,
"availability": "Avail",
"warranty": "Warranty",
"width": 10,
"height": 15,
"depth": 20,
"weight": 5
},
"hostProduct_store": {
"id": "5AEE4DB4C520B740ABA582528E1E8ABB",
"fk_host": "1DA1520A236D604187853C1469B22CC9",
"code": "BCMStore",
"name": "Test BigCommerce Web Store",
"address": {
"line1": "",
"line2": "",
"line3": "",
"town": "",
"county": "",
"postcode": "",
"countryCode": ""
},
"detail": {
"status": "active",
"source": "BIGCOMMERCE"
},
"web": true,
"store_host": {
"id": "1DA1520A236D604187853C1469B22CC9",
"name": "Test Big Commerce",
"type": "BIGCOMMERCE",
"detail": {
"shipMethods": [
{
"host": "ROW - (10 - 12 working days)",
"wh": "YMINTMAIL"
},
{
"host": "European Delivery (7 - 10 working days)",
"wh": "YMINTEREU"
},
{
"host": "US Delivery* (10 - 12 working days)",
"wh": "YMINTERUS"
},
{
"host": "Canada Delivery* (10 - 12 working days)",
"wh": "YMINTERCAD"
},
{
"host": "UK* Premium Next Working Day Delivery",
"wh": "YMUK24HR"
},
{
"host": "UK* Premium Next Working Day Delivery. Only available on orders placed Mon - Fri before 3pm",
"wh": "YMUK24HR"
},
{
"host": "UK* Free Delivery on all orders over £50",
"wh": "YMUK48HR"
},
{
"host": "UK* Standard Delivery (2 - 3 working days)",
"wh": "YMUK48HR"
},
{
"host": "UK* Standard Delivery (3 - 5 working days)",
"wh": "YMUK48HR"
},
{
"host": "UK Mail Saturday",
"wh": "YMUKSAT"
},
{
"host": "Free Shipping",
"wh": "YMUK48HR"
},
{
"host": "None",
"wh": "GLOBALIZE"
}
]
},
"code": "BCTEST"
}
},
"hostProduct_product": {
"id": "1A383540D5E0E143847BD0C6B47DE456",
"fk_brand": "17076BDDE29E96478A3F1C8E711BF122",
"code": "7039",
"title": "Cropped frill shirt",
"category": "Tops",
"description": "Cropped shirt with frill hem",
"productBrand": "Tester",
"season": "AW20",
"origin": "China",
"composition": "100% Cotton",
"careInstructions": "Wash at 40\r",
"createdDate": "",
"status": "",
"detail": {
"importFile": "7F2EE4A8A4A7704F8F823F37343E08E4"
},
"commodityCode": "",
"product_brand": {
"__KEY": "17076BDDE29E96478A3F1C8E711BF122"
}
},
"hostProduct_hostVariant": [
{
"id": "21990BB05B04424CA577B2DFD09C184E",
"fk_hostProduct": "AFB765C68637F04384B64895935325C0",
"fk_variant": "26F4ACA9CF60B84A8F9ABE5D9DA1E5A2",
"hostSize": "L",
"hostColour": "Cream/Navy Broken Stripe",
"status": 2,
"detail": {},
"hostReference": "51892",
"currentPrice": 0,
"hostVariant_variant": {
"__KEY": "26F4ACA9CF60B84A8F9ABE5D9DA1E5A2"
},
"hostVariant_hostProduct": {
"__KEY": "AFB765C68637F04384B64895935325C0"
}
},
{
"id": "4855E089BA833740851821EAAABEE514",
"fk_hostProduct": "AFB765C68637F04384B64895935325C0",
"fk_variant": "96E6BA7D8053A547B6F6C9EF07AF6C8F",
"hostSize": "M",
"hostColour": "Cream/Navy Broken Stripe",
"status": 2,
"detail": {},
"hostReference": "51891",
"currentPrice": 0,
"hostVariant_variant": {
"__KEY": "96E6BA7D8053A547B6F6C9EF07AF6C8F"
},
"hostVariant_hostProduct": {
"__KEY": "AFB765C68637F04384B64895935325C0"
}
},
{
"id": "89979BF07440AC45B00CD9BB783E4B6C",
"fk_hostProduct": "AFB765C68637F04384B64895935325C0",
"fk_variant": "893EE1BDA395DB42AC7DC925D45C8AC4",
"hostSize": "S",
"hostColour": "Cream/Navy Broken Stripe",
"status": 2,
"detail": {},
"hostReference": "51890",
"currentPrice": 0,
"hostVariant_variant": {
"__KEY": "893EE1BDA395DB42AC7DC925D45C8AC4"
},
"hostVariant_hostProduct": {
"__KEY": "AFB765C68637F04384B64895935325C0"
}
},
{
"id": "98101F0E910E364E82FEBA7BFDE10A6A",
"fk_hostProduct": "AFB765C68637F04384B64895935325C0",
"fk_variant": "F504C95EAA889D45A24430D0AF313D33",
"hostSize": "XS",
"hostColour": "Cream/Navy Broken Stripe",
"status": 2,
"detail": {},
"hostReference": "51889",
"currentPrice": 0,
"hostVariant_variant": {
"__KEY": "F504C95EAA889D45A24430D0AF313D33"
},
"hostVariant_hostProduct": {
"__KEY": "AFB765C68637F04384B64895935325C0"
}
}
]
}
]
}
}