POST
/api/profiles/refresh🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-versioncontent-length
Cookies Sent
_cfuvid
Request Bodyapplication/json
{}Responses
200application/json
{
"token": "string",
"expiresAt": "integer",
"refreshToken": "string",
"refreshTokenExpiresAt": "integer"
}Response Headers
content-typex-nnapi-request-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
Cookies Set
| Name | Attributes |
|---|---|
| __cf_bm | HttpOnlySecurePath=/ |
| _cfuvid | HttpOnlySecureSameSite=NonePath=/ |
GET
/api/profiles🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idui-update-cachex-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json
{
"profile": {
"city": "null",
"email": "string",
"phone": "string",
"state": "null",
"qrCode": "string",
"userId": "string",
"address": "null",
"barCode": "string",
"zipCode": "string",
"birthday": "string",
"lastName": "string",
"smsOptIn": "boolean",
"userCode": "string",
"createdAt": "string",
"firstName": "string",
"loyaltyId": "integer",
"pushOptIn": "boolean",
"emailOptIn": "boolean",
"anniversary": "null",
"appleSignup": "null",
"marketingSms": "boolean",
"referralCode": "string",
"referralPath": "string",
"emailReceipts": "boolean",
"userRelations": [],
"facebookSignup": "null",
"termsAcceptDate": "string",
"commerceProviderId": "string",
"termsAndConditions": "boolean",
"profileFieldAnswers": {},
"favouriteLocationExtrefs": "string"
}
}Response Headers
content-typex-nnapi-request-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
GET
/api/punchh/api2/mobile/users/balance🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idui-cache-clearx-nnapi-trace-idui-cache-keycontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json; charset=utf-8
{
"coupons": [],
"rewards": [
{
"name": "string",
"read_at": "null",
"meta_data": "string",
"reward_id": "integer",
"created_at": "string",
"description": "string",
"expiring_at": "string",
"campaign_type": "null",
"franchisee_id": "null",
"store_numbers": [],
"expiring_at_tz": "string",
"discount_amount": "null",
"discount_channel": "string",
"reward_image_url": "string",
"reward_properties": "null",
"redemption_details": "null",
"becomes_available_at": "string",
"redeemable_created_at": "string"
}
],
"messages": [],
"punch_cards": [],
"notifications": [],
"account_balance": {
"pending_points": "null",
"redeemed_cards": "null",
"banked_currency": "null",
"lifetime_points": "integer",
"unbanked_points": "null",
"unredeemed_cards": "null",
"redeemable_points": "integer",
"total_loyalty_visits": "null",
"checkins_on_current_card": "integer",
"expiring_banked_currency": "null",
"banked_currency_expiring_on": "null",
"current_membership_level_id": "null",
"current_membership_level_name": "null",
"current_membership_level_expiring_on": "null"
},
"challenge_badges": [],
"active_redemptions": [],
"preferred_charities": [],
"converted_category_balances": []
}Response Headers
content-typex-nnapi-request-idapigw-requestidcf-cache-statuscontent-security-policy-report-onlyreport-tocontent-encodingcf-ray
GET
/api/olo/baskets/{id}🔒▶Path Parameters
{id}
Request Headers
accept-charsetauthorizationclientidnomnom-platformui-transformerx-nnapi-session-idui-update-cachex-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json
{
"id": "string",
"tip": "integer",
"fees": [],
"mode": "string",
"taxes": [
{
"tax": "number",
"label": "string"
}
],
"total": "number",
"coupon": "null",
"nomnom": {
"products": [
{
"id": "string",
"cost": "integer",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"source": "null",
"choices": [
{
"id": "string",
"cost": "number",
"name": "string",
"indent": "integer",
"metric": "integer",
"optionid": "string",
"quantity": "integer",
"customfields": "null",
"chainchoiceid": "string"
}
],
"endhour": "integer",
"basecost": "integer",
"category": {
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
},
"metadata": [
{
"key": "string",
"value": "string"
}
],
"quantity": "integer",
"displayid": "null",
"productId": "string",
"recipient": "string",
"starthour": "integer",
"totalcost": "number",
"categories": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
}
],
"customdata": "string",
"description": "string",
"maxcalories": "string",
"availability": {
"now": "boolean",
"times": [
{
"to": {
"day": "string",
"time": "string"
},
"from": {
"day": "string",
"time": "string"
}
}
],
"always": "boolean",
"enddate": "null",
"startdate": "string",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"categories_all": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
}
],
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "string",
"costoverridelabel": "null",
"quantityincrement": "string",
"categories_choices": [],
"specialinstructions": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"cross_sell": [
{
"id": "string",
"cost": "integer",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"endhour": "integer",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"displayid": "null",
"starthour": "integer",
"description": "string",
"maxcalories": "string",
"availability": {
"now": "boolean",
"times": [
{
"to": {
"day": "string",
"time": "string"
},
"from": {
"day": "string",
"time": "string"
}
}
],
"always": "boolean",
"enddate": "null",
"startdate": "string",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "string",
"costoverridelabel": "null",
"quantityincrement": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"rules-matched": ["string"],
"cross_sell_source": "string",
"cross_sell_source_used": "string"
},
"coupons": [],
"discount": "integer",
"products": [
{
"id": "string",
"name": "string",
"source": "null",
"choices": [
{
"id": "string",
"cost": "number",
"name": "string",
"indent": "integer",
"metric": "integer",
"optionid": "string",
"quantity": "integer",
"customfields": "null",
"chainchoiceid": "string"
}
],
"basecost": "integer",
"quantity": "integer",
"productId": "string",
"recipient": "string",
"totalcost": "number",
"customdata": "string",
"chainproductid": "string",
"specialinstructions": "string"
}
],
"salestax": "number",
"subtotal": "number",
"timemode": "string",
"vendorid": "string",
"allowstip": "boolean",
"discounts": [],
"donations": [],
"totalfees": "integer",
"wasupsold": "boolean",
"timewanted": "null",
"customfields": [
{
"id": "string",
"label": "string",
"scope": "string",
"value": "string",
"isrequired": "boolean",
"validationregex": "string"
}
],
"deliverymode": "string",
"taxexemption": "null",
"vendoronline": "boolean",
"contactnumber": "string",
"suggestedtips": "null",
"appliedrewards": [],
"coupondiscount": "integer",
"totaldonations": "integer",
"deliveryaddress": "null",
"dispatchoptions": "null",
"isupsellenabled": "boolean",
"onpremisedetails": "null",
"cateringaccountid": "null",
"contextualpricing": "null",
"earliestreadytime": "string",
"suggestedtipamount": "integer",
"validationmessages": [],
"allowsmsorderupdates": "boolean",
"customerhandoffcharge": "integer",
"suggestedtippercentage": "integer",
"leadtimeestimateminutes": "integer"
}Response Headers
content-typex-frame-optionsx-olo-api-versionx-olo-client-idx-olo-trace-idx-nnapi-request-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
GET
/api/stores/by-id-ref-or-slug/{id}🔒▶Path Parameters
{id}
Request Headers
accept-charsetauthorizationclientidnomnom-platformui-transformerx-nnapi-session-idx-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Query Parameters
| Name | Type |
|---|---|
| nomnom | string |
| nomnom_calendars_from | string |
| nomnom_calendars_to | string |
Responses
200application/json
{
"id": "string",
"url": "string",
"zip": "string",
"city": "string",
"name": "string",
"slug": "string",
"brand": "string",
"state": "string",
"extref": "string",
"labels": [
{
"key": "string",
"value": "string"
}
],
"nomnom": {
"about": "null",
"extref": "string",
"is_olo": "boolean",
"is_wifi": "boolean",
"nn_hash": "string",
"dma_code": "null",
"redirect": "null",
"createdAt": "integer",
"updatedAt": "integer",
"page_title": "null",
"is_open_late": "boolean",
"showcalories": "boolean",
"is_television": "boolean",
"meta_keywords": "null",
"calendars_source": "null",
"google_places_id": "null",
"meta_description": "null",
"dispatch_distance": "null",
"freedompay_store_id": "string",
"custom_header_insert": "null",
"primary_pci_provider": "string",
"external_sync_group_id": "string",
"freedompay_terminal_id": "string"
},
"country": "string",
"nn_hash": "string",
"distance": "integer",
"latitude": "number",
"metadata": "null",
"calendars": {
"calendar": [
{
"type": "string",
"label": "null",
"ranges": [
{
"end": "string",
"start": "string",
"weekday": "string"
}
]
}
]
},
"canpickup": "boolean",
"longitude": "number",
"mobileurl": "string",
"storename": "string",
"telephone": "string",
"utcoffset": "integer",
"attributes": [],
"candeliver": "boolean",
"created_at": "integer",
"hasolopass": "boolean",
"updated_at": "integer",
"advanceonly": "boolean",
"crossstreet": "string",
"deliveryfee": "integer",
"isavailable": "boolean",
"supportstip": "boolean",
"customfields": [
{
"id": "string",
"label": "string",
"required": "boolean",
"validationregex": "string",
"qualificationcriteria": "string"
}
],
"deliveryarea": "string",
"showcalories": "boolean",
"streetaddress": "string",
"streetaddress2": "string",
"supportsdinein": "boolean",
"supportsforyou": "boolean",
"iscurrentlyopen": "boolean",
"supportscoupons": "boolean",
"supportsloyalty": "boolean",
"advanceorderdays": "integer",
"deliveryfeetiers": [],
"supportscurbside": "boolean",
"supportsdispatch": "boolean",
"supportsfeedback": "boolean",
"contextualpricing": "null",
"supportsdrivethru": "boolean",
"allowstaxexemption": "boolean",
"minimumpickuporder": "integer",
"supportedcardtypes": "string",
"supportedcountries": ["string"],
"supportedtimemodes": ["string"],
"supportsmanualfire": "boolean",
"availabilitymessage": "null",
"requiresphonenumber": "boolean",
"supportsgrouporders": "boolean",
"minimumdeliveryorder": "integer",
"supportsnationalmenu": "boolean",
"customerfacingmessage": "string",
"supportsguestordering": "boolean",
"supportssplitpayments": "boolean",
"maximumpayinstoreorder": "integer",
"suggestedtippercentage": "integer",
"supportslocalfavorites": "boolean",
"supportsonlineordering": "boolean",
"supportssmartcrosssell": "boolean",
"supportsbaskettransfers": "boolean",
"acceptsordersuntilclosing": "boolean",
"deliverydelayalertenabled": "boolean",
"deliverydelayalertmessage": "null",
"productrecipientnamelabel": "string",
"acceptsordersbeforeopening": "boolean",
"supportsspecialinstructions": "boolean",
"supportssplitpaygrouporders": "boolean",
"specialinstructionsmaxlength": "integer",
"supportsproductrecipientnames": "boolean",
"allowhandoffchoiceatmanualfire": "boolean",
"supportedarrivalmessagehandoffmodes": []
}Response Headers
content-typex-nnapi-request-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
GET
/api/olo/restaurants/{id}/menu🔒▶Path Parameters
{id}
Request Headers
accept-charsetauthorizationclientidnomnom-platformui-transformerx-nnapi-session-idx-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Query Parameters
| Name | Type |
|---|---|
| nomnom | string |
Responses
200application/json
{
"imagepath": "string",
"categories": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": "null",
"metadata": "null",
"products": [
{
"id": "string",
"cost": "number",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"endhour": "integer",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"displayid": "null",
"starthour": "integer",
"description": "string",
"maxcalories": "null",
"availability": {
"now": "boolean",
"times": [
{
"to": {
"day": "string",
"time": "string"
},
"from": {
"day": "string",
"time": "string"
}
}
],
"always": "boolean",
"enddate": "null",
"startdate": "string",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "null",
"costoverridelabel": "null",
"quantityincrement": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"description": "null",
"containsalcohol": "boolean"
}
],
"singleusecategories": [],
"supportsdynamicpricing": "boolean"
}Response Headers
content-typex-olo-api-versionx-olo-client-idx-olo-trace-idx-nnapi-request-idx-frame-optionsapigw-requestidcf-cache-statuscontent-encodingcf-ray
GET
/api/punchh/rewards🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idui-cache-ttlcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json; charset=utf-8
{
"0": {
"name": "string",
"meta_data": "string",
"description": "string",
"redeemable_id": "integer",
"redeemable_image_url": "string",
"redeemable_properties": "null",
"points_required_to_redeem": "integer"
}
}Response Headers
content-typex-nnapi-request-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
HEAD
/order/recent▶Request Headers
accept-charsetclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Response Headers
content-typecontent-encodingcf-ray
GET
/api/olo/users/savedproducts🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json
{
"imagepath": "string",
"savedproducts": [
{
"id": "string",
"name": "string",
"product": {
"name": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"source": "string",
"choices": [
{
"name": "string",
"choices": [
{
"name": "string",
"choices": [
{
"name": "string",
"quantity": "integer",
"availability": {
"available": "boolean",
"isdeleted": "boolean"
},
"chainchoiceid": "string"
}
],
"quantity": "integer",
"availability": {
"available": "boolean",
"isdeleted": "boolean"
},
"chainchoiceid": "string"
}
],
"quantity": "integer",
"availability": {
"available": "boolean",
"isdeleted": "boolean"
},
"chainchoiceid": "string"
}
],
"quantity": "integer",
"recipient": "null",
"availability": {
"available": "boolean",
"isdeleted": "boolean"
},
"chainproductid": "string",
"specialinstructions": "null"
},
"datecreated": "string"
}
]
}Response Headers
content-typex-olo-trace-idx-nnapi-request-idx-frame-optionsx-olo-api-versionx-olo-client-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
GET
/api/olo/users/faves🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformui-transformerx-nnapi-session-idx-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json
{
"faves": []
}Response Headers
content-typex-olo-trace-idx-nnapi-request-idx-frame-optionsx-olo-api-versionx-olo-client-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
GET
/api/olo/users/recentorders🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformui-transformerx-nnapi-session-idx-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json
{
"orders": []
}Response Headers
content-typex-olo-api-versionx-olo-client-idx-olo-trace-idx-nnapi-request-idx-frame-optionsapigw-requestidcf-cache-statuscontent-encodingcf-ray
GET
/api/content/type/CarlsJrOption/list🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json
{
"content": [
{
"id": "string",
"name": "string",
"value": "string",
"nn_hash": "string",
"isActive": "boolean",
"createdAt": "integer",
"updatedAt": "integer",
"description": "string"
}
]
}Response Headers
content-typex-nnapi-request-idcdn-cache-controlapigw-requestidcf-cache-statuscontent-encodingcf-ray
HEAD
/rewards/check-in-store▶Request Headers
accept-charsetclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Response Headers
content-typecontent-encodingcf-ray
GET
/api/punchh/api2/mobile/offers🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idui-update-cachex-nnapi-trace-idui-cache-ttlcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json; charset=utf-8
{
"coupons": [],
"rewards": [
{
"name": "string",
"read_at": "null",
"meta_data": "string",
"reward_id": "integer",
"created_at": "string",
"description": "string",
"expiring_at": "string",
"campaign_type": "null",
"franchisee_id": "null",
"store_numbers": [],
"expiring_at_tz": "string",
"discount_amount": "null",
"discount_channel": "string",
"reward_image_url": "string",
"reward_properties": "null",
"redemption_details": "null",
"becomes_available_at": "string",
"redeemable_created_at": "string"
}
],
"notifications": [],
"pinned_message": "string"
}Response Headers
content-typex-nnapi-request-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
HEAD
/location/-ca-alhambra-2521-w-commonwealth-ave/menu▶Request Headers
accept-charsetclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Response Headers
content-typecontent-encodingcf-ray
GET
/api/stores/byslug/-ca-alhambra-2521-w-commonwealth-ave🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformui-transformerx-nnapi-session-idx-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Query Parameters
| Name | Type |
|---|---|
| nomnom | string |
| nomnom_calendars_from | string |
| nomnom_calendars_to | string |
Responses
200application/json
{
"id": "string",
"url": "string",
"zip": "string",
"city": "string",
"name": "string",
"slug": "string",
"brand": "string",
"state": "string",
"extref": "string",
"labels": [
{
"key": "string",
"value": "string"
}
],
"nomnom": {
"about": "null",
"extref": "string",
"is_olo": "boolean",
"is_wifi": "boolean",
"nn_hash": "string",
"dma_code": "null",
"redirect": "null",
"createdAt": "integer",
"updatedAt": "integer",
"page_title": "null",
"is_open_late": "boolean",
"showcalories": "boolean",
"is_television": "boolean",
"meta_keywords": "null",
"calendars_source": "null",
"google_places_id": "null",
"meta_description": "null",
"dispatch_distance": "null",
"freedompay_store_id": "string",
"custom_header_insert": "null",
"primary_pci_provider": "string",
"external_sync_group_id": "string",
"freedompay_terminal_id": "string"
},
"country": "string",
"nn_hash": "string",
"distance": "integer",
"latitude": "number",
"metadata": "null",
"calendars": {
"calendar": [
{
"type": "string",
"label": "null",
"ranges": [
{
"end": "string",
"start": "string",
"weekday": "string"
}
]
}
]
},
"canpickup": "boolean",
"longitude": "number",
"mobileurl": "string",
"storename": "string",
"telephone": "string",
"utcoffset": "integer",
"attributes": [],
"candeliver": "boolean",
"created_at": "integer",
"hasolopass": "boolean",
"updated_at": "integer",
"advanceonly": "boolean",
"crossstreet": "string",
"deliveryfee": "integer",
"isavailable": "boolean",
"supportstip": "boolean",
"customfields": [
{
"id": "string",
"label": "string",
"required": "boolean",
"validationregex": "string",
"qualificationcriteria": "string"
}
],
"deliveryarea": "string",
"showcalories": "boolean",
"streetaddress": "string",
"streetaddress2": "string",
"supportsdinein": "boolean",
"supportsforyou": "boolean",
"iscurrentlyopen": "boolean",
"supportscoupons": "boolean",
"supportsloyalty": "boolean",
"advanceorderdays": "integer",
"deliveryfeetiers": [],
"supportscurbside": "boolean",
"supportsdispatch": "boolean",
"supportsfeedback": "boolean",
"contextualpricing": "null",
"supportsdrivethru": "boolean",
"allowstaxexemption": "boolean",
"minimumpickuporder": "integer",
"supportedcardtypes": "string",
"supportedcountries": ["string"],
"supportedtimemodes": ["string"],
"supportsmanualfire": "boolean",
"availabilitymessage": "null",
"requiresphonenumber": "boolean",
"supportsgrouporders": "boolean",
"minimumdeliveryorder": "integer",
"supportsnationalmenu": "boolean",
"customerfacingmessage": "string",
"supportsguestordering": "boolean",
"supportssplitpayments": "boolean",
"maximumpayinstoreorder": "integer",
"suggestedtippercentage": "integer",
"supportslocalfavorites": "boolean",
"supportsonlineordering": "boolean",
"supportssmartcrosssell": "boolean",
"supportsbaskettransfers": "boolean",
"acceptsordersuntilclosing": "boolean",
"deliverydelayalertenabled": "boolean",
"deliverydelayalertmessage": "null",
"productrecipientnamelabel": "string",
"acceptsordersbeforeopening": "boolean",
"supportsspecialinstructions": "boolean",
"supportssplitpaygrouporders": "boolean",
"specialinstructionsmaxlength": "integer",
"supportsproductrecipientnames": "boolean",
"allowhandoffchoiceatmanualfire": "boolean",
"supportedarrivalmessagehandoffmodes": []
}Response Headers
content-typex-nnapi-request-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
GET
/api/olo/restaurants/{id}/disclaimers🔒▶Path Parameters
{id}
Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idui-cache-ttlcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json
{
"imagepath": "null",
"disclaimers": [
{
"code": "null",
"name": "string",
"images": "null",
"disclaimer": "string"
}
]
}Response Headers
content-typex-olo-client-idx-olo-trace-idx-nnapi-request-idx-frame-optionsx-olo-api-versionapigw-requestidcf-cache-statuscontent-encodingcf-ray
HEAD
/location/-ca-alhambra-2521-w-commonwealth-ave/menu/charbroiled-double-deals▶Request Headers
accept-charsetclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Response Headers
content-typecontent-encodingcf-ray
GET
/api/olo/products/{id}/modifiers🔒▶Path Parameters
{id}
Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idui-cache-ttlcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json
{
"imagepath": "string",
"optiongroups": [
{
"id": "string",
"options": [
{
"id": "string",
"cost": "number",
"name": "string",
"tags": [],
"fields": "null",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"children": "boolean",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"displayid": "null",
"isdefault": "boolean",
"modifiers": [
{
"id": "string",
"options": [
{
"id": "string",
"cost": "integer",
"name": "string",
"tags": [],
"fields": "null",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"children": "boolean",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"displayid": "null",
"isdefault": "boolean",
"modifiers": [
{
"id": "string",
"options": [
{
"id": "string",
"cost": "integer",
"name": "string",
"tags": [],
"fields": "null",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"children": "boolean",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"displayid": "null",
"isdefault": "boolean",
"modifiers": "null",
"maxcalories": "null",
"availability": {
"now": "boolean",
"times": [],
"always": "boolean",
"enddate": "null",
"startdate": "null",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "null",
"chainoptionid": "string",
"menuitemlabels": [],
"optiongroup_id": "string",
"caloriesseparator": "null",
"costoverridelabel": "null",
"adjustsparentprice": "boolean",
"adjustsparentcalories": "boolean"
}
],
"metadata": [
{
"key": "string",
"value": "string"
}
],
"mandatory": "boolean",
"maxselects": "null",
"minselects": "null",
"description": "string",
"availability": {
"now": "boolean",
"times": [],
"always": "boolean",
"enddate": "null",
"startdate": "null",
"description": "null"
},
"hidechoicecost": "boolean",
"parentchoiceid": "null",
"chainmodifierid": "string",
"explanationtext": "string",
"maxchoicequantity": "string",
"minchoicequantity": "string",
"maxaggregatequantity": "null",
"minaggregatequantity": "null",
"choicequantityincrement": "string",
"supportschoicequantities": "boolean"
}
],
"maxcalories": "null",
"availability": {
"now": "boolean",
"times": [],
"always": "boolean",
"enddate": "null",
"startdate": "null",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "null",
"chainoptionid": "string",
"menuitemlabels": [],
"optiongroup_id": "string",
"caloriesseparator": "null",
"costoverridelabel": "null",
"adjustsparentprice": "boolean",
"adjustsparentcalories": "boolean"
}
],
"metadata": [
{
"key": "string",
"value": "string"
}
],
"mandatory": "boolean",
"maxselects": "null",
"minselects": "null",
"description": "string",
"availability": {
"now": "boolean",
"times": [],
"always": "boolean",
"enddate": "null",
"startdate": "null",
"description": "null"
},
"hidechoicecost": "boolean",
"parentchoiceid": "null",
"chainmodifierid": "string",
"explanationtext": "string",
"maxchoicequantity": "string",
"minchoicequantity": "string",
"maxaggregatequantity": "null",
"minaggregatequantity": "null",
"choicequantityincrement": "string",
"supportschoicequantities": "boolean"
}
],
"maxcalories": "null",
"availability": {
"now": "boolean",
"times": [],
"always": "boolean",
"enddate": "null",
"startdate": "null",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "null",
"chainoptionid": "string",
"menuitemlabels": [],
"optiongroup_id": "string",
"caloriesseparator": "null",
"costoverridelabel": "null",
"adjustsparentprice": "boolean",
"adjustsparentcalories": "boolean"
}
],
"metadata": [
{
"key": "string",
"value": "string"
}
],
"mandatory": "boolean",
"maxselects": "null",
"minselects": "null",
"description": "string",
"availability": {
"now": "boolean",
"times": [],
"always": "boolean",
"enddate": "null",
"startdate": "null",
"description": "null"
},
"hidechoicecost": "boolean",
"parentchoiceid": "null",
"chainmodifierid": "string",
"explanationtext": "string",
"maxchoicequantity": "string",
"minchoicequantity": "string",
"maxaggregatequantity": "null",
"minaggregatequantity": "null",
"choicequantityincrement": "string",
"supportschoicequantities": "boolean"
}
],
"supportsdynamicpricing": "boolean"
}Response Headers
content-typex-frame-optionsx-olo-api-versionx-olo-client-idx-olo-trace-idx-nnapi-request-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
HEAD
/location/-ca-alhambra-2521-w-commonwealth-ave/menu/charbroiled-double-deals/california-classic-double-cheeseburger-combo▶Request Headers
accept-charsetclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Response Headers
content-typecontent-encodingcf-ray
GET
/api/passive-cross-sell🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Query Parameters
| Name | Type |
|---|---|
| clientid | string |
| productSlug | string |
| basketId | string |
Responses
200application/json
{
"suggestedProducts": [
{
"id": "string",
"cost": "number",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"endhour": "integer",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"displayid": "null",
"starthour": "integer",
"description": "string",
"maxcalories": "null",
"availability": {
"now": "boolean",
"times": [],
"always": "boolean",
"enddate": "null",
"startdate": "null",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "null",
"costoverridelabel": "null",
"quantityincrement": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
]
}Response Headers
content-typex-nnapi-request-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
POST
/api/olo/baskets/{id}/products/batch🔒▶Path Parameters
{id}
Request Headers
accept-charsetclientidnomnom-platformui-transformerx-nnapi-trace-idui-cache-keyauthorizationui-response-transformerx-nnapi-session-idui-update-cacheui-cache-ttlcontent-typex-app-versioncontent-length
Cookies Sent
_cfuvid__cf_bm
Request Bodyapplication/json
{
"products": [
{
"id": "string",
"name": "null",
"status": "null",
"choices": [
{
"choiceid": "string",
"quantity": "integer"
}
],
"options": "null",
"disabled": "boolean",
"quantity": "integer",
"productId": "null",
"productid": "string",
"recipient": "null",
"totalcost": "null",
"displayChoices": [],
"original_quantity": "integer",
"choicecustomfields": [],
"specialinstructions": "null"
}
]
}Responses
200application/json
{
"basket": {
"id": "string",
"tip": "integer",
"fees": [],
"mode": "string",
"taxes": [
{
"tax": "integer",
"label": "string"
}
],
"total": "number",
"coupon": "null",
"nomnom": {
"products": [
{
"id": "string",
"cost": "integer",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"source": "null",
"choices": [
{
"id": "string",
"cost": "number",
"name": "string",
"indent": "integer",
"metric": "integer",
"optionid": "string",
"quantity": "integer",
"customfields": "null",
"chainchoiceid": "string"
}
],
"endhour": "integer",
"basecost": "integer",
"category": {
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
},
"metadata": [
{
"key": "string",
"value": "string"
}
],
"quantity": "integer",
"displayid": "null",
"productId": "string",
"recipient": "string",
"starthour": "integer",
"totalcost": "number",
"categories": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
}
],
"customdata": "string",
"description": "string",
"maxcalories": "string",
"availability": {
"now": "boolean",
"times": [
{
"to": {
"day": "string",
"time": "string"
},
"from": {
"day": "string",
"time": "string"
}
}
],
"always": "boolean",
"enddate": "null",
"startdate": "string",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"categories_all": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
}
],
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "string",
"costoverridelabel": "null",
"quantityincrement": "string",
"categories_choices": [],
"specialinstructions": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"cross_sell": [
{
"id": "string",
"cost": "integer",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"endhour": "integer",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"displayid": "null",
"starthour": "integer",
"description": "string",
"maxcalories": "string",
"availability": {
"now": "boolean",
"times": [],
"always": "boolean",
"enddate": "null",
"startdate": "null",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "string",
"costoverridelabel": "null",
"quantityincrement": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"rules-matched": ["string"],
"cross_sell_source": "string",
"cross_sell_source_used": "string"
},
"coupons": [],
"discount": "integer",
"products": [
{
"id": "string",
"name": "string",
"source": "null",
"choices": [
{
"id": "string",
"cost": "number",
"name": "string",
"indent": "integer",
"metric": "integer",
"optionid": "string",
"quantity": "integer",
"customfields": "null",
"chainchoiceid": "string"
}
],
"basecost": "integer",
"quantity": "integer",
"productId": "string",
"recipient": "string",
"totalcost": "number",
"customdata": "string",
"chainproductid": "string",
"specialinstructions": "string"
}
],
"salestax": "integer",
"subtotal": "number",
"timemode": "string",
"vendorid": "string",
"allowstip": "boolean",
"discounts": [],
"donations": [],
"totalfees": "integer",
"wasupsold": "boolean",
"timewanted": "null",
"customfields": [
{
"id": "string",
"label": "string",
"scope": "string",
"value": "string",
"isrequired": "boolean",
"validationregex": "string"
}
],
"deliverymode": "string",
"taxexemption": "null",
"vendoronline": "boolean",
"contactnumber": "string",
"suggestedtips": "null",
"appliedrewards": [],
"coupondiscount": "integer",
"totaldonations": "integer",
"deliveryaddress": "null",
"dispatchoptions": "null",
"isupsellenabled": "boolean",
"onpremisedetails": "null",
"cateringaccountid": "null",
"contextualpricing": "null",
"earliestreadytime": "string",
"suggestedtipamount": "integer",
"validationmessages": [],
"allowsmsorderupdates": "boolean",
"customerhandoffcharge": "integer",
"suggestedtippercentage": "integer",
"leadtimeestimateminutes": "integer"
},
"errors": []
}Response Headers
content-typex-nnapi-request-idx-frame-optionsx-olo-api-versionx-olo-client-idx-olo-trace-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
POST
/api/olo/users/savedproducts🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idui-cache-clearx-nnapi-trace-idcontent-typex-app-versioncontent-length
Cookies Sent
_cfuvid__cf_bm
Request Bodyapplication/json
{
"name": "string",
"product": {
"choices": [
{
"choices": [
{
"choices": [
{
"choices": [],
"quantity": "integer",
"chainchoiceid": "string"
}
],
"quantity": "integer",
"chainchoiceid": "string"
}
],
"quantity": "integer",
"chainchoiceid": "string"
}
],
"quantity": "integer",
"chainproductid": "string"
}
}Responses
200application/json
{
"id": "string",
"name": "string",
"product": {
"name": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"source": "string",
"choices": [
{
"name": "string",
"choices": [
{
"name": "string",
"choices": [
{
"name": "string",
"quantity": "integer",
"availability": {
"available": "boolean",
"isdeleted": "boolean"
},
"chainchoiceid": "string"
}
],
"quantity": "integer",
"availability": {
"available": "boolean",
"isdeleted": "boolean"
},
"chainchoiceid": "string"
}
],
"quantity": "integer",
"availability": {
"available": "boolean",
"isdeleted": "boolean"
},
"chainchoiceid": "string"
}
],
"quantity": "integer",
"recipient": "null",
"availability": {
"available": "boolean",
"isdeleted": "boolean"
},
"chainproductid": "string",
"specialinstructions": "null"
},
"imagepath": "string",
"datecreated": "string"
}Response Headers
content-typex-nnapi-request-idx-frame-optionsx-olo-api-versionx-olo-client-idx-olo-trace-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
HEAD
/rewards▶Request Headers
accept-charsetclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Response Headers
content-typecontent-encodingcf-ray
HEAD
/rewards/submit-code▶Request Headers
accept-charsetclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Response Headers
content-typecontent-encodingcf-ray
HEAD
/order/my-bag▶Request Headers
accept-charsetclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Response Headers
content-typecontent-encodingcf-ray
GET
/api/olo/users/qualifyingrewards🔒▶Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Query Parameters
| Name | Type |
|---|---|
| vendorid | string |
Responses
200application/json
{
"rewards": [
{
"type": "string",
"items": "null",
"label": "string",
"value": "integer",
"applied": "boolean",
"imageurl": "string",
"rewardid": "null",
"fineprint": "string",
"reference": "string",
"categories": "null",
"vendorrefs": [],
"description": "string",
"membershipid": "string",
"validminutes": "integer",
"expirationdate": "string",
"availableonline": "boolean",
"quantityapplied": "integer",
"availableoffline": "boolean",
"externalreference": "string",
"quantityavailable": "integer"
}
]
}Response Headers
content-typex-olo-client-idx-olo-trace-idx-nnapi-request-idx-frame-optionsx-olo-api-versionapigw-requestidcf-cache-statuscontent-encodingcf-ray
DELETE
/api/olo/baskets/{id}/timewanted🔒▶Path Parameters
{id}
Request Headers
accept-charsetauthorizationclientidnomnom-platformui-transformerx-nnapi-session-idui-update-cachex-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-versioncontent-length
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json
{
"id": "string",
"tip": "integer",
"fees": [],
"mode": "string",
"taxes": [
{
"tax": "integer",
"label": "string"
}
],
"total": "number",
"coupon": "null",
"nomnom": {
"products": [
{
"id": "string",
"cost": "integer",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"source": "null",
"choices": [
{
"id": "string",
"cost": "number",
"name": "string",
"indent": "integer",
"metric": "integer",
"optionid": "string",
"quantity": "integer",
"customfields": "null",
"chainchoiceid": "string"
}
],
"endhour": "integer",
"basecost": "integer",
"category": {
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
},
"metadata": [
{
"key": "string",
"value": "string"
}
],
"quantity": "integer",
"displayid": "null",
"productId": "string",
"recipient": "string",
"starthour": "integer",
"totalcost": "number",
"categories": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
}
],
"customdata": "string",
"description": "string",
"maxcalories": "string",
"availability": {
"now": "boolean",
"times": [
{
"to": {
"day": "string",
"time": "string"
},
"from": {
"day": "string",
"time": "string"
}
}
],
"always": "boolean",
"enddate": "null",
"startdate": "string",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"categories_all": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
}
],
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "string",
"costoverridelabel": "null",
"quantityincrement": "string",
"categories_choices": [],
"specialinstructions": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"cross_sell": [
{
"id": "string",
"cost": "integer",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"endhour": "integer",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"displayid": "null",
"starthour": "integer",
"description": "string",
"maxcalories": "string",
"availability": {
"now": "boolean",
"times": [
{
"to": {
"day": "string",
"time": "string"
},
"from": {
"day": "string",
"time": "string"
}
}
],
"always": "boolean",
"enddate": "null",
"startdate": "string",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "string",
"costoverridelabel": "null",
"quantityincrement": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"rules-matched": ["string"],
"cross_sell_source": "string",
"cross_sell_source_used": "string"
},
"coupons": [],
"discount": "integer",
"products": [
{
"id": "string",
"name": "string",
"source": "null",
"choices": [
{
"id": "string",
"cost": "number",
"name": "string",
"indent": "integer",
"metric": "integer",
"optionid": "string",
"quantity": "integer",
"customfields": "null",
"chainchoiceid": "string"
}
],
"basecost": "integer",
"quantity": "integer",
"productId": "string",
"recipient": "string",
"totalcost": "number",
"customdata": "string",
"chainproductid": "string",
"specialinstructions": "string"
}
],
"salestax": "integer",
"subtotal": "number",
"timemode": "string",
"vendorid": "string",
"allowstip": "boolean",
"discounts": [],
"donations": [],
"totalfees": "integer",
"wasupsold": "boolean",
"timewanted": "null",
"customfields": [
{
"id": "string",
"label": "string",
"scope": "string",
"value": "string",
"isrequired": "boolean",
"validationregex": "string"
}
],
"deliverymode": "string",
"taxexemption": "null",
"vendoronline": "boolean",
"contactnumber": "string",
"suggestedtips": "null",
"appliedrewards": [],
"coupondiscount": "integer",
"totaldonations": "integer",
"deliveryaddress": "null",
"dispatchoptions": "null",
"isupsellenabled": "boolean",
"onpremisedetails": "null",
"cateringaccountid": "null",
"contextualpricing": "null",
"earliestreadytime": "string",
"suggestedtipamount": "integer",
"validationmessages": [],
"allowsmsorderupdates": "boolean",
"customerhandoffcharge": "integer",
"suggestedtippercentage": "integer",
"leadtimeestimateminutes": "integer"
}Response Headers
content-typex-frame-optionsx-olo-api-versionx-olo-client-idx-olo-trace-idx-nnapi-request-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
GET
/api/olo/baskets/{id}/loyaltyschemes🔒▶Path Parameters
{id}
Request Headers
accept-charsetauthorizationclientidnomnom-platformx-nnapi-session-idx-nnapi-trace-idui-cache-ttlcontent-typex-app-version
Cookies Sent
_cfuvid__cf_bm
Responses
200application/json
{
"schemes": [
{
"id": "string",
"name": "string",
"label": "string",
"provider": "string",
"membership": {
"id": "string",
"balance": "null",
"rewards": [],
"description": "string",
"membershipnumber": "string"
},
"cancheckbalance": "boolean",
"multiplerewardsenabled": "boolean"
}
]
}Response Headers
content-typex-nnapi-request-idx-frame-optionsx-olo-api-versionx-olo-client-idx-olo-trace-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
POST
/api/olo/baskets/{id}/validate🔒▶Path Parameters
{id}
Request Headers
accept-charsetauthorizationclientidnomnom-platformui-transformerx-nnapi-session-idui-update-cachex-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-versioncontent-length
Cookies Sent
_cfuvid__cf_bm
Request Bodyapplication/json
{}Responses
200application/json
{
"id": "string",
"tax": "number",
"tip": "integer",
"fees": [],
"mode": "string",
"taxes": [
{
"tax": "number",
"label": "string"
}
],
"total": "number",
"coupon": "null",
"nomnom": {
"products": [
{
"id": "string",
"cost": "integer",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"source": "null",
"choices": [
{
"id": "string",
"cost": "number",
"name": "string",
"indent": "integer",
"metric": "integer",
"optionid": "string",
"quantity": "integer",
"customfields": "null",
"chainchoiceid": "string"
}
],
"endhour": "integer",
"basecost": "integer",
"category": {
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
},
"metadata": [
{
"key": "string",
"value": "string"
}
],
"quantity": "integer",
"displayid": "null",
"productId": "string",
"recipient": "string",
"starthour": "integer",
"totalcost": "number",
"categories": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
}
],
"customdata": "string",
"description": "string",
"maxcalories": "string",
"availability": {
"now": "boolean",
"times": [
{
"to": {
"day": "string",
"time": "string"
},
"from": {
"day": "string",
"time": "string"
}
}
],
"always": "boolean",
"enddate": "null",
"startdate": "string",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"categories_all": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
}
],
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "string",
"costoverridelabel": "null",
"quantityincrement": "string",
"categories_choices": [],
"specialinstructions": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"cross_sell": [
{
"id": "string",
"cost": "integer",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"endhour": "integer",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"displayid": "null",
"starthour": "integer",
"description": "string",
"maxcalories": "string",
"availability": {
"now": "boolean",
"times": [
{
"to": {
"day": "string",
"time": "string"
},
"from": {
"day": "string",
"time": "string"
}
}
],
"always": "boolean",
"enddate": "null",
"startdate": "string",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "string",
"costoverridelabel": "null",
"quantityincrement": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"rules-matched": ["string"],
"cross_sell_source": "string",
"cross_sell_source_used": "string"
},
"coupons": [],
"basketid": "string",
"discount": "integer",
"products": [
{
"id": "string",
"name": "string",
"source": "null",
"choices": [
{
"id": "string",
"cost": "number",
"name": "string",
"indent": "integer",
"metric": "integer",
"optionid": "string",
"quantity": "integer",
"customfields": "null",
"chainchoiceid": "string"
}
],
"basecost": "integer",
"quantity": "integer",
"productId": "string",
"recipient": "string",
"totalcost": "number",
"customdata": "string",
"chainproductid": "string",
"specialinstructions": "string"
}
],
"salestax": "number",
"subtotal": "number",
"timemode": "string",
"vendorid": "string",
"allowstip": "boolean",
"discounts": [],
"donations": [],
"readytime": "string",
"totalfees": "integer",
"validated": "boolean",
"wasupsold": "boolean",
"timewanted": "null",
"customfields": [
{
"id": "string",
"label": "string",
"scope": "string",
"value": "string",
"isrequired": "boolean",
"validationregex": "string"
}
],
"deliverymode": "string",
"taxexemption": "null",
"upsellgroups": "null",
"vendoronline": "boolean",
"contactnumber": "string",
"suggestedtips": "null",
"appliedrewards": [],
"coupondiscount": "integer",
"totaldonations": "integer",
"deliveryaddress": "null",
"dispatchoptions": "null",
"isupsellenabled": "boolean",
"onpremisedetails": "null",
"cateringaccountid": "null",
"contextualpricing": "null",
"earliestreadytime": "string",
"suggestedtipamount": "integer",
"validationmessages": [],
"allowsmsorderupdates": "boolean",
"posreferenceresponse": "null",
"customerhandoffcharge": "integer",
"suggestedtippercentage": "integer",
"leadtimeestimateminutes": "integer",
"taxexemptaccountidentifier": "null"
}Response Headers
content-typex-nnapi-request-idx-frame-optionsx-olo-api-versionx-olo-client-idx-olo-trace-idapigw-requestidcf-cache-statuscontent-encodingcf-ray
PUT
/api/olo/baskets/{id}/timewanted🔒▶Path Parameters
{id}
Request Headers
accept-charsetauthorizationclientidnomnom-platformui-transformerx-nnapi-session-idui-update-cachex-nnapi-trace-idui-cache-ttlui-cache-keycontent-typex-app-versioncontent-length
Cookies Sent
_cfuvid__cf_bm
Request Bodyapplication/json
{
"day": "integer",
"hour": "integer",
"year": "integer",
"month": "integer",
"minute": "integer",
"ismanualfire": "boolean"
}Responses
200application/json
{
"id": "string",
"tip": "integer",
"fees": [],
"mode": "string",
"taxes": [
{
"tax": "number",
"label": "string"
}
],
"total": "number",
"coupon": "null",
"nomnom": {
"products": [
{
"id": "string",
"cost": "integer",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"source": "null",
"choices": [
{
"id": "string",
"cost": "number",
"name": "string",
"indent": "integer",
"metric": "integer",
"optionid": "string",
"quantity": "integer",
"customfields": "null",
"chainchoiceid": "string"
}
],
"endhour": "integer",
"basecost": "integer",
"category": {
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
},
"metadata": [
{
"key": "string",
"value": "string"
}
],
"quantity": "integer",
"displayid": "null",
"productId": "string",
"recipient": "string",
"starthour": "integer",
"totalcost": "number",
"categories": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
}
],
"customdata": "string",
"description": "string",
"maxcalories": "string",
"availability": {
"now": "boolean",
"times": [
{
"to": {
"day": "string",
"time": "string"
},
"from": {
"day": "string",
"time": "string"
}
}
],
"always": "boolean",
"enddate": "null",
"startdate": "string",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"categories_all": [
{
"id": "string",
"name": "string",
"slug": "string",
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"metadata": "null",
"description": "null",
"containsalcohol": "boolean"
}
],
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "string",
"costoverridelabel": "null",
"quantityincrement": "string",
"categories_choices": [],
"specialinstructions": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"cross_sell": [
{
"id": "string",
"cost": "integer",
"name": "string",
"slug": "string",
"tags": [],
"images": [
{
"url": "null",
"filename": "string",
"groupname": "string",
"isdefault": "boolean",
"description": "null"
}
],
"endhour": "integer",
"metadata": [
{
"key": "string",
"value": "string"
}
],
"displayid": "null",
"starthour": "integer",
"description": "string",
"maxcalories": "string",
"availability": {
"now": "boolean",
"times": [
{
"to": {
"day": "string",
"time": "string"
},
"from": {
"day": "string",
"time": "string"
}
}
],
"always": "boolean",
"enddate": "null",
"startdate": "string",
"isdisabled": "boolean",
"description": "null"
},
"basecalories": "string",
"alcoholstatus": "string",
"imagefilename": "string",
"chainproductid": "string",
"menuitemlabels": [],
"maximumquantity": "null",
"minimumquantity": "string",
"shortdescription": "string",
"caloriesseparator": "string",
"costoverridelabel": "null",
"quantityincrement": "string",
"maximumbasketquantity": "string",
"minimumbasketquantity": "string",
"unavailablehandoffmodes": []
}
],
"rules-matched": ["string"],
"cross_sell_source": "string",
"cross_sell_source_used": "string"
},
"coupons": [],
"discount": "integer",
"products": [
{
"id": "string",
"name": "string",
"source": "null",
"choices": [
{
"id": "string",
"cost": "number",
"name": "string",
"indent": "integer",
"metric": "integer",
"optionid": "string",
"quantity": "integer",
"customfields": "null",
"chainchoiceid": "string"
}
],
"basecost": "integer",
"quantity": "integer",
"productId": "string",
"recipient": "string",
"totalcost": "number",
"customdata": "string",
"chainproductid": "string",
"specialinstructions": "string"
}
],
"salestax": "number",
"subtotal": "number",
"timemode": "string",
"vendorid": "string",
"allowstip": "boolean",
"discounts": [],
"donations": [],
"totalfees": "integer",
"wasupsold": "boolean",
"timewanted": "string",
"customfields": [
{
"id": "string",
"label": "string",
"scope": "string",
"value": "string",
"isrequired": "boolean",
"validationregex": "string"
}
],
"deliverymode": "string",
"taxexemption": "null",
"vendoronline": "boolean",
"contactnumber": "string",
"suggestedtips": "null",
"appliedrewards": [],
"coupondiscount": "integer",
"totaldonations": "integer",
"deliveryaddress": "null",
"dispatchoptions": "null",
"isupsellenabled": "boolean",
"onpremisedetails": "null",
"cateringaccountid": "null",
"contextualpricing": "null",
"earliestreadytime": "string",
"suggestedtipamount": "integer",
"validationmessages": [],
"allowsmsorderupdates": "boolean",
"customerhandoffcharge": "integer",
"suggestedtippercentage": "integer",
"leadtimeestimateminutes": "integer"
}Response Headers
content-typex-olo-client-idx-olo-trace-idx-nnapi-request-idx-frame-optionsx-olo-api-versionapigw-requestidcf-cache-statuscontent-encodingcf-ray
Data Lineage
Click any field to trace its flow
Select a field, parameter, header, or cookie to see:
- Where the value comes from
- Where the value is used
Data Lineage
Click any field to trace its flow
Select a field, parameter, header, or cookie to see:
- Where the value comes from
- Where the value is used