Gets a sellable item for an item base with a specified head office entity Hopk for a specified site, and its related data

Licenses Required

Vista.Ocapi

Request

path Parameters

siteId required	string The unique identifier of the site
itemHopk required	string The head office entity Hopk of the item base

header Parameters

Connect-Region-Code

string

Region Code

Responses

200

Success

404

Site or item does not exist.

get/ocapi/v1/sites/{siteId}/sellable-items/by-hopk/{itemHopk}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"sellableItem": {"itemId": "string",
"prices": [{"price": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"isDefault": true,
"restrictions": ["MemberReward"
],
"rewardId": 0,
"discount": {"calculation": {"percentageOff": 0.1,
"type": "SpecialPrice"
},
"amountSaved": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
}
},
"discountId": "string"
}
]
},
"relatedData": {"item": {"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"shortName": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"description": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"restrictions": ["Member"
],
"itemClassId": "string",
"hopk": "string",
"hoCode": "string",
"isSundry": true,
"isPreparationRequired": true,
"allowedDeliveryMethods": ["CounterPickup"
],
"availableHoursId": "string",
"modifierGroups": [{"itemModifierGroupId": "string",
"displayPriority": 0
}
],
"type": "Normal",
"components": [{"itemId": "string",
"isModifiable": true,
"displayPriority": 0,
"prices": [{"price": {"valueIncludingTax": null,
"valueExcludingTax": null,
"tax": null
},
"isDefault": true,
"restrictions": [null
],
"rewardId": 0,
"discount": {"calculation": null,
"amountSaved": null
},
"discountId": "string"
}
]
}
]
},
"discounts": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"restriction": "None",
"restrictions": ["None"
],
"rewardIds": [0
],
"voucherTypeCodes": ["string"
],
"expiresAt": "2019-08-24T14:15:22Z"
}
],
"itemModifierGroups": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"shortName": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"promptText": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"quantityLimit": {"isUnlimited": true,
"maximum": 0,
"minimum": 0
},
"includedQuantity": 0,
"modifiers": [{"itemId": "string",
"prices": [{"price": null,
"isDefault": null,
"restrictions": [ ],
"rewardId": null,
"discount": null,
"discountId": null
}
],
"displayPriority": 0
}
]
}
]
}
}