Gets the site item profile and it's related data for a specified site

Licenses Required

Vista.Ocapi

Request

path Parameters

siteId

required

string

The unique identifier of the site

header Parameters

Connect-Region-Code

string

Region Code

Responses

200

Success

404

Site does not exist.

get/ocapi/v1/sites/{siteId}/item-profile

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"itemProfile": {"pages": [{"number": 0,
"title": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"buttons": [{"itemId": "string",
"prices": [{"price": null,
"isDefault": null,
"restrictions": [ ],
"rewardId": null,
"discount": null,
"discountId": null
}
],
"title": {"text": "string",
"translations": [null
]
},
"displayPriority": 0
}
],
"displayPriority": 0
}
],
"siteId": "string",
"orderTipOptions": [{"percentage": 0,
"isDefault": true
}
],
"itemShowtimeDeliveryWindows": [{"minutes": 0,
"type": "MinutesFromStart",
"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
]
},
"relatedData": {"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"
}
],
"items": [{"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": null,
"isDefault": null,
"restrictions": [ ],
"rewardId": null,
"discount": null,
"discountId": null
}
]
}
]
}
],
"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
}
]
}
],
"site": {"location": {"latitude": 0.1,
"longitude": 0.1
},
"contactDetails": {"phoneNumbers": [{"type": "Home",
"number": "string"
}
],
"email": "string",
"address": {"line1": "60 Khyber Pass Road",
"line2": "Grafton",
"city": "Auckland 1023"
}
},
"ianaTimeZoneName": "America/New_York",
"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"hasSellableItems": true,
"allowedItemDeliveryMethods": ["CounterPickup"
]
},
"availableHours": [{"id": "string",
"siteId": "string",
"days": [{"day": "Sunday",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z"
}
]
}
]
}
}