POST API/V40/Interactive/Outlet/{outletCode}/deliveryLocation/{deliveryLocationCode}/GetOpenCheck
Get open check for delivery location
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| outletCode |
The outlet code for the outlet we placed the order against. |
string |
Required |
| deliveryLocationCode |
The delivery location code for the order we placed. |
string |
Required |
Body Parameters
The request model containing the session token.
GetOpenCheckRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| 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 |
Request Formats
application/json, text/json
Sample:
{
"sessionToken": "sample string 1"
}
application/x-www-form-urlencoded
Sample:
Sample not available.
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": "r2t8Mz4U3YgKAAAAAAAAAAAAAAA.ejploddFr0p7NrlFR1ArIOa6e84QrLj8kifAGeWIpTQ",
"responsesIncluded": "getOpenCheckResponse",
"responses": [
{
"getOpenCheckResponse": {
"content": {
"hasOpenCheck": true,
"order": {
"id": 1,
"code": "sample string 2",
"outletCode": "sample string 3",
"outletName": "sample string 4",
"total": 5.0,
"discountAmount": 6.0,
"tipAmount": 7.0,
"taxAmount": 8.0,
"subTotal": 9.0,
"deliveryDateTimeUtc": "2024-12-04T08:32:34.0798383+00:00",
"createdDateTimeUtc": "2024-12-04T08:32:34.0798383+00:00",
"guestComment": "sample string 10",
"status": "sample string 11",
"items": [
{
"code": "sample string 1",
"price": 2.0,
"quantity": 3,
"name": "sample string 4",
"categoryItemApiId": "519220e4-eba1-41c6-b1dd-10253be1a204",
"roundSequence": 5,
"type": "sample string 6",
"comments": "sample string 7",
"modifiers": [
{
"options": [
{
"subModifiers": [
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
},
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
}
],
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "79023e0c-3f43-4074-b53e-df2c2139a382"
},
{
"subModifiers": [
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
},
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
}
],
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "79023e0c-3f43-4074-b53e-df2c2139a382"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "7aba4cf3-6a3f-4840-98da-b0e7b5abc41a"
},
{
"options": [
{
"subModifiers": [
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
},
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
}
],
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "79023e0c-3f43-4074-b53e-df2c2139a382"
},
{
"subModifiers": [
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
},
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
}
],
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "79023e0c-3f43-4074-b53e-df2c2139a382"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "7aba4cf3-6a3f-4840-98da-b0e7b5abc41a"
}
],
"itemPriceName": "sample string 8"
},
{
"code": "sample string 1",
"price": 2.0,
"quantity": 3,
"name": "sample string 4",
"categoryItemApiId": "519220e4-eba1-41c6-b1dd-10253be1a204",
"roundSequence": 5,
"type": "sample string 6",
"comments": "sample string 7",
"modifiers": [
{
"options": [
{
"subModifiers": [
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
},
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
}
],
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "79023e0c-3f43-4074-b53e-df2c2139a382"
},
{
"subModifiers": [
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
},
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
}
],
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "79023e0c-3f43-4074-b53e-df2c2139a382"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "7aba4cf3-6a3f-4840-98da-b0e7b5abc41a"
},
{
"options": [
{
"subModifiers": [
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
},
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
}
],
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "79023e0c-3f43-4074-b53e-df2c2139a382"
},
{
"subModifiers": [
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
},
{
"options": [
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
},
{
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "102a02ce-6ace-42c0-9990-3aa67d5806f5"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "51323144-f220-4ae6-9e44-a1d5e7503889"
}
],
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"orderItemModifierCode": "sample string 4",
"supplement": 5.0,
"itemModifierOptionApiId": "79023e0c-3f43-4074-b53e-df2c2139a382"
}
],
"code": "sample string 1",
"name": "sample string 2",
"orderItemCode": "sample string 3",
"itemModifierFamilyId": "7aba4cf3-6a3f-4840-98da-b0e7b5abc41a"
}
],
"itemPriceName": "sample string 8"
}
],
"extraCharges": [
{
"percentage": 1.0,
"flat": 2.0,
"price": 3.0,
"description": "sample string 4"
},
{
"percentage": 1.0,
"flat": 2.0,
"price": 3.0,
"description": "sample string 4"
}
],
"payments": [
{
"cardType": "sample string 1",
"last4DigitsOfCard": "sample string 2",
"amountPaid": 3.0,
"tipAmount": 4.0,
"paymentStatus": "Succeeded",
"paymentError": "sample string 5"
},
{
"cardType": "sample string 1",
"last4DigitsOfCard": "sample string 2",
"amountPaid": 3.0,
"tipAmount": 4.0,
"paymentStatus": "Succeeded",
"paymentError": "sample string 5"
}
],
"outstandingBalance": 0.0,
"deliveryLocation": "sample string 12",
"deliveryLocationCode": "sample string 13",
"posOrderReference": "sample string 14"
},
"orderTotal": 2.0,
"orderTotalDue": 3.0,
"discount": 4.0,
"posOrderReference": "sample string 5",
"gxpChequeNumber": "sample string 6"
},
"succeeded": true
}
}
],
"status": "Success"
}