GET API/V40/System/Settings/Outlet?Code={Code}&SessionToken={SessionToken}
Retrieve outlet settings
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Code | string | ||
| SessionToken |
The token associated with this session of API interactions. This token should always be included in API calls, because it contains important session state information. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ResponseContainerModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionToken |
The token associated with this session of API interactions. Generally this is the same token passed with the API request parameters, but under certain circumstances this can be changed before being sent back to the caller. |
string | |
| ResponsesIncluded |
A list of response messages names contained in this composite message, for easy pre-parsing. |
string | |
| Responses |
A list of response messages contained in this composite message. |
Collection of Object | |
| Status |
The success status the composite message. |
CompositeStatus |
Response Formats
application/json, text/json
Sample:
{
"sessionToken": "xmPJVXYN3YgKAAAAAAAAAAAAAAA.jxaKB_CtLbNF_yQapELQEWl5vD-OkSJKTKsrF-9MvEk",
"responsesIncluded": "getOutletSettingsResponse",
"responses": [
{
"getOutletSettingsResponse": {
"content": {
"outletsHash": "sample string 1",
"outletSettings": [
{
"code": "sample string 1",
"name": "sample string 2",
"description": "sample string 3",
"allowDeliverLater": true,
"allowDeliverToRoom": true,
"allowCollection": true,
"collectionText": "sample string 7",
"collectionInstructions": "sample string 8",
"allowOrdering": true,
"allowOpenChecks": true,
"allowPayment": true,
"allowTipping": true,
"allowTippingOnOpenOrders": true,
"allowPreArrivalOrders": true,
"tipAmounts": [
1.0,
2.0
],
"allowCustomTipAmount": true,
"allowNonVerifiedGuests": true,
"allowAppendToCheque": true,
"allowGuestMessages": true,
"allowMultiPrice": true,
"allowOrderComments": true,
"displayAttributesFilter": true,
"leadTimeMinutes": 22,
"maximumAdvanceOrderingLeadTime": 23,
"intervalTimeMinutes": 24,
"nonVerifiedGuestFields": [
{
"name": "sample string 1",
"isMandatory": true,
"storeInGxp": true,
"sendToPos": true
},
{
"name": "sample string 1",
"isMandatory": true,
"storeInGxp": true,
"sendToPos": true
}
],
"openingDays": [
"sample string 1",
"sample string 2"
],
"outletOpeningTimes": [
{
"day": "Sunday",
"startTime": "00:00:00.1234567",
"endTime": "00:00:00.1234567"
},
{
"day": "Sunday",
"startTime": "00:00:00.1234567",
"endTime": "00:00:00.1234567"
}
],
"geofenceRadius": 1,
"telephoneNumber": "sample string 25",
"telephonePrefix": "sample string 26",
"availabilitySummary": {},
"extraCharges": [
{
"name": "sample string 1",
"tax": 2.0,
"price": 3.0,
"code": "sample string 4",
"description": "sample string 5"
},
{
"name": "sample string 1",
"tax": 2.0,
"price": 3.0,
"code": "sample string 4",
"description": "sample string 5"
}
],
"isTaxIncludedInPrice": true,
"getMenuBitByBit": true,
"posProfitCenterId": "sample string 29",
"posEmployeeId": "sample string 30",
"posTenderId": "sample string 31",
"posTenderMediaIdForCashPaidOrders": "sample string 32",
"posTenderMediaIdForCardPaidOrders": "sample string 33",
"posTenderMediaIdForVisaCardPaidOrders": "sample string 34",
"posTenderMediaIdForMastercardCardPaidOrders": "sample string 35",
"posTenderMediaIdForAmexCardPaidOrders": "sample string 36",
"posTenderMediaIdForDiscoverCardPaidOrders": "sample string 37",
"posTenderMediaIdForRoomChargeOrders": "sample string 38",
"posCheckTypeId": "sample string 39",
"posCheckAlternateTypeId": "sample string 40",
"outletDeliveryCharge": 41.0,
"outletDeliveryChargeTaxes": [
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
},
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
}
],
"deliveryLocationAreas": [
{
"code": "sample string 1",
"name": "sample string 2",
"deliveryCharge": 1.0,
"taxes": [
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
},
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
}
],
"deliveryLocations": [
{
"code": "sample string 1",
"name": "sample string 2"
},
{
"code": "sample string 1",
"name": "sample string 2"
}
]
},
{
"code": "sample string 1",
"name": "sample string 2",
"deliveryCharge": 1.0,
"taxes": [
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
},
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
}
],
"deliveryLocations": [
{
"code": "sample string 1",
"name": "sample string 2"
},
{
"code": "sample string 1",
"name": "sample string 2"
}
]
}
],
"imageUrl": "sample string 42",
"type": "sample string 43",
"displayAlcoholInformation": true,
"displayAllergenInformation": true,
"allowReservations": true,
"reservationUrl": "sample string 47",
"enableTimeSlots": true,
"allowVerifiedOrdering": true,
"timeSlotCapacity": 1,
"useDiscounts": true,
"allowSplitBill": true,
"isCallWaiterEnabled": true,
"hideDeliveryDetailsBox": true,
"hidePaymentOptionsBox": true,
"allowStaffOrdering": true,
"hideDeliveryIntervalTimes": true,
"customDropDownOptionAmount": 57,
"preventUnverifiedOrders": true,
"allowConfirmationEmail": true,
"useCardPreAuthForOpenTab": true
},
{
"code": "sample string 1",
"name": "sample string 2",
"description": "sample string 3",
"allowDeliverLater": true,
"allowDeliverToRoom": true,
"allowCollection": true,
"collectionText": "sample string 7",
"collectionInstructions": "sample string 8",
"allowOrdering": true,
"allowOpenChecks": true,
"allowPayment": true,
"allowTipping": true,
"allowTippingOnOpenOrders": true,
"allowPreArrivalOrders": true,
"tipAmounts": [
1.0,
2.0
],
"allowCustomTipAmount": true,
"allowNonVerifiedGuests": true,
"allowAppendToCheque": true,
"allowGuestMessages": true,
"allowMultiPrice": true,
"allowOrderComments": true,
"displayAttributesFilter": true,
"leadTimeMinutes": 22,
"maximumAdvanceOrderingLeadTime": 23,
"intervalTimeMinutes": 24,
"nonVerifiedGuestFields": [
{
"name": "sample string 1",
"isMandatory": true,
"storeInGxp": true,
"sendToPos": true
},
{
"name": "sample string 1",
"isMandatory": true,
"storeInGxp": true,
"sendToPos": true
}
],
"openingDays": [
"sample string 1",
"sample string 2"
],
"outletOpeningTimes": [
{
"day": "Sunday",
"startTime": "00:00:00.1234567",
"endTime": "00:00:00.1234567"
},
{
"day": "Sunday",
"startTime": "00:00:00.1234567",
"endTime": "00:00:00.1234567"
}
],
"geofenceRadius": 1,
"telephoneNumber": "sample string 25",
"telephonePrefix": "sample string 26",
"availabilitySummary": {},
"extraCharges": [
{
"name": "sample string 1",
"tax": 2.0,
"price": 3.0,
"code": "sample string 4",
"description": "sample string 5"
},
{
"name": "sample string 1",
"tax": 2.0,
"price": 3.0,
"code": "sample string 4",
"description": "sample string 5"
}
],
"isTaxIncludedInPrice": true,
"getMenuBitByBit": true,
"posProfitCenterId": "sample string 29",
"posEmployeeId": "sample string 30",
"posTenderId": "sample string 31",
"posTenderMediaIdForCashPaidOrders": "sample string 32",
"posTenderMediaIdForCardPaidOrders": "sample string 33",
"posTenderMediaIdForVisaCardPaidOrders": "sample string 34",
"posTenderMediaIdForMastercardCardPaidOrders": "sample string 35",
"posTenderMediaIdForAmexCardPaidOrders": "sample string 36",
"posTenderMediaIdForDiscoverCardPaidOrders": "sample string 37",
"posTenderMediaIdForRoomChargeOrders": "sample string 38",
"posCheckTypeId": "sample string 39",
"posCheckAlternateTypeId": "sample string 40",
"outletDeliveryCharge": 41.0,
"outletDeliveryChargeTaxes": [
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
},
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
}
],
"deliveryLocationAreas": [
{
"code": "sample string 1",
"name": "sample string 2",
"deliveryCharge": 1.0,
"taxes": [
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
},
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
}
],
"deliveryLocations": [
{
"code": "sample string 1",
"name": "sample string 2"
},
{
"code": "sample string 1",
"name": "sample string 2"
}
]
},
{
"code": "sample string 1",
"name": "sample string 2",
"deliveryCharge": 1.0,
"taxes": [
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
},
{
"name": "sample string 1",
"rate": 2.0,
"isAppliedToCollection": true,
"isAppliedToRoomDelivery": true,
"isAppliedToDeliveryLocation": true,
"description": "sample string 6"
}
],
"deliveryLocations": [
{
"code": "sample string 1",
"name": "sample string 2"
},
{
"code": "sample string 1",
"name": "sample string 2"
}
]
}
],
"imageUrl": "sample string 42",
"type": "sample string 43",
"displayAlcoholInformation": true,
"displayAllergenInformation": true,
"allowReservations": true,
"reservationUrl": "sample string 47",
"enableTimeSlots": true,
"allowVerifiedOrdering": true,
"timeSlotCapacity": 1,
"useDiscounts": true,
"allowSplitBill": true,
"isCallWaiterEnabled": true,
"hideDeliveryDetailsBox": true,
"hidePaymentOptionsBox": true,
"allowStaffOrdering": true,
"hideDeliveryIntervalTimes": true,
"customDropDownOptionAmount": 57,
"preventUnverifiedOrders": true,
"allowConfirmationEmail": true,
"useCardPreAuthForOpenTab": true
}
]
},
"succeeded": true
}
}
],
"status": "Success"
}