GET API/V40/Interactive/PropertyOrders/{orderCode}?SessionToken={SessionToken}

Retrieves a property order (verified or non verified) by code

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

orderCode

The code for the order

string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseContainerModel
NameDescriptionTypeAdditional 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": "JO7J6DwU3YgKAAAAAAAAAAAAAAA.gOuz21G36fS7_bMQ1Rjll2WDUPvWrxXZVlv6x_U0NHE",
  "responsesIncluded": "getPropertyOrderResponse",
  "responses": [
    {
      "getPropertyOrderResponse": {
        "content": {
          "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:23:19.2619556+00:00",
            "createdDateTimeUtc": "2024-12-04T08:23:19.2619556+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": "f15a056f-1b91-4ca8-aedb-1b0be0c9c4ee",
                "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": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          },
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          }
                        ],
                        "code": "sample string 1",
                        "name": "sample string 2",
                        "price": 3.0,
                        "orderItemModifierCode": "sample string 4",
                        "supplement": 5.0,
                        "itemModifierOptionApiId": "be3c48b6-a77a-4866-ae77-21dfbea33c06"
                      },
                      {
                        "subModifiers": [
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          },
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          }
                        ],
                        "code": "sample string 1",
                        "name": "sample string 2",
                        "price": 3.0,
                        "orderItemModifierCode": "sample string 4",
                        "supplement": 5.0,
                        "itemModifierOptionApiId": "be3c48b6-a77a-4866-ae77-21dfbea33c06"
                      }
                    ],
                    "code": "sample string 1",
                    "name": "sample string 2",
                    "orderItemCode": "sample string 3",
                    "itemModifierFamilyId": "f59b54a9-3317-4433-b4cb-efbc95c60107"
                  },
                  {
                    "options": [
                      {
                        "subModifiers": [
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          },
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          }
                        ],
                        "code": "sample string 1",
                        "name": "sample string 2",
                        "price": 3.0,
                        "orderItemModifierCode": "sample string 4",
                        "supplement": 5.0,
                        "itemModifierOptionApiId": "be3c48b6-a77a-4866-ae77-21dfbea33c06"
                      },
                      {
                        "subModifiers": [
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          },
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          }
                        ],
                        "code": "sample string 1",
                        "name": "sample string 2",
                        "price": 3.0,
                        "orderItemModifierCode": "sample string 4",
                        "supplement": 5.0,
                        "itemModifierOptionApiId": "be3c48b6-a77a-4866-ae77-21dfbea33c06"
                      }
                    ],
                    "code": "sample string 1",
                    "name": "sample string 2",
                    "orderItemCode": "sample string 3",
                    "itemModifierFamilyId": "f59b54a9-3317-4433-b4cb-efbc95c60107"
                  }
                ],
                "itemPriceName": "sample string 8"
              },
              {
                "code": "sample string 1",
                "price": 2.0,
                "quantity": 3,
                "name": "sample string 4",
                "categoryItemApiId": "f15a056f-1b91-4ca8-aedb-1b0be0c9c4ee",
                "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": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          },
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          }
                        ],
                        "code": "sample string 1",
                        "name": "sample string 2",
                        "price": 3.0,
                        "orderItemModifierCode": "sample string 4",
                        "supplement": 5.0,
                        "itemModifierOptionApiId": "be3c48b6-a77a-4866-ae77-21dfbea33c06"
                      },
                      {
                        "subModifiers": [
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          },
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          }
                        ],
                        "code": "sample string 1",
                        "name": "sample string 2",
                        "price": 3.0,
                        "orderItemModifierCode": "sample string 4",
                        "supplement": 5.0,
                        "itemModifierOptionApiId": "be3c48b6-a77a-4866-ae77-21dfbea33c06"
                      }
                    ],
                    "code": "sample string 1",
                    "name": "sample string 2",
                    "orderItemCode": "sample string 3",
                    "itemModifierFamilyId": "f59b54a9-3317-4433-b4cb-efbc95c60107"
                  },
                  {
                    "options": [
                      {
                        "subModifiers": [
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          },
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          }
                        ],
                        "code": "sample string 1",
                        "name": "sample string 2",
                        "price": 3.0,
                        "orderItemModifierCode": "sample string 4",
                        "supplement": 5.0,
                        "itemModifierOptionApiId": "be3c48b6-a77a-4866-ae77-21dfbea33c06"
                      },
                      {
                        "subModifiers": [
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          },
                          {
                            "options": [
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              },
                              {
                                "code": "sample string 1",
                                "name": "sample string 2",
                                "price": 3.0,
                                "orderItemModifierCode": "sample string 4",
                                "supplement": 5.0,
                                "itemModifierOptionApiId": "1b7b8653-abbd-4dbe-9bc6-66c091016615"
                              }
                            ],
                            "code": "sample string 1",
                            "name": "sample string 2",
                            "orderItemCode": "sample string 3",
                            "itemModifierFamilyId": "bc9add2e-8b21-4829-ac4f-7c9a820590b8"
                          }
                        ],
                        "code": "sample string 1",
                        "name": "sample string 2",
                        "price": 3.0,
                        "orderItemModifierCode": "sample string 4",
                        "supplement": 5.0,
                        "itemModifierOptionApiId": "be3c48b6-a77a-4866-ae77-21dfbea33c06"
                      }
                    ],
                    "code": "sample string 1",
                    "name": "sample string 2",
                    "orderItemCode": "sample string 3",
                    "itemModifierFamilyId": "f59b54a9-3317-4433-b4cb-efbc95c60107"
                  }
                ],
                "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"
          }
        },
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}