GET v1/Orders/{siteId}/{orderId}/DeliveryStatus

Retrieves a delivery status of the order

URI template

v1/Orders/{siteId}/{orderId}/DeliveryStatus

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId	The site where the customer placed the order	integer	Required
orderId	The order id of the order on the AO side.	integer	Required

Body Parameters

None.

Response Information

Resource Description

GetOrderDeliveryStatusResponse. Known internal errors are BadRequest, Error

OrderDeliveryStatusResult

Name	Description	Type	Additional information
DeliveryData	Status enum	DeliveryViewData	None.

Response Formats

application/json, text/json

Sample:

{
  "DeliveryData": {
    "$id": "2",
    "Status": "CREATED",
    "ExternalOrderId": "sample string 1",
    "CreatedAt": "2025-04-25T09:40:05.0661373",
    "DeliveryPromise": {
      "$id": "3",
      "Fee": 3.0,
      "CurrencyCode": "sample string 4",
      "PickupTime": "2025-04-25T09:40:05.0661373",
      "DropoffTime": "2025-04-25T09:40:05.0661373",
      "DeliveryWindowStart": "2025-04-25T09:40:05.0661373",
      "DeliveryWindowEnd": "2025-04-25T09:40:05.0661373"
    },
    "Courier": {
      "$id": "4",
      "PartnerCourierId": "sample string 9",
      "FirstName": "sample string 10",
      "LastName": "sample string 11",
      "Phone": "sample string 12",
      "Rating": 13.1,
      "ImageLink": "sample string 14",
      "Location": {
        "$id": "5",
        "Lat": 15.0,
        "Lng": 16.0
      }
    },
    "PickupContact": {
      "$id": "6",
      "FirstName": "sample string 17",
      "LastName": "sample string 18",
      "BusinessName": "sample string 19",
      "PhoneNumber": "sample string 20",
      "Instructions": "sample string 21"
    },
    "DropoffContact": {
      "$id": "7",
      "FirstName": "sample string 22",
      "LastName": "sample string 23",
      "BusinessName": "sample string 24",
      "PhoneNumber": "sample string 25",
      "Instructions": "sample string 26"
    },
    "DeliveryId": "sample string 27",
    "ApplicationId": {
      "$id": "8",
      "Name": "sample string 28",
      "Version": "sample string 29"
    },
    "Quote": {
      "$id": "9",
      "RequestedAt": "2025-04-25T09:40:05.0661373",
      "ExpiresAt": "2025-04-25T09:40:05.0661373",
      "QuotePromise": {
        "$id": "10",
        "Fee": 32.0,
        "CurrencyCode": "sample string 33",
        "PickupTime": "2025-04-25T09:40:05.0661373",
        "DropoffTime": "2025-04-25T09:40:05.0661373",
        "DeliveryWindowStart": "2025-04-25T09:40:05.0661373",
        "DeliveryWindowEnd": "2025-04-25T09:40:05.0661373"
      },
      "QuoteId": "sample string 38"
    },
    "DeliveredAt": "2025-04-25T09:40:05.0661373",
    "PartnerDeliveryId": "sample string 40"
  }
}

application/xml, text/xml

Sample:

<OrderDeliveryStatusResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response">
  <DeliveryData xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response.Delivery">
    <d2p1:ApplicationId>
      <d2p1:Name>sample string 28</d2p1:Name>
      <d2p1:Version>sample string 29</d2p1:Version>
    </d2p1:ApplicationId>
    <d2p1:Courier>
      <d2p1:FirstName>sample string 10</d2p1:FirstName>
      <d2p1:ImageLink>sample string 14</d2p1:ImageLink>
      <d2p1:LastName>sample string 11</d2p1:LastName>
      <d2p1:Location>
        <d2p1:Lat>15</d2p1:Lat>
        <d2p1:Lng>16</d2p1:Lng>
      </d2p1:Location>
      <d2p1:PartnerCourierId>sample string 9</d2p1:PartnerCourierId>
      <d2p1:Phone>sample string 12</d2p1:Phone>
      <d2p1:Rating>13.1</d2p1:Rating>
    </d2p1:Courier>
    <d2p1:CreatedAt>2025-04-25T09:40:05.0661373</d2p1:CreatedAt>
    <d2p1:DeliveredAt>2025-04-25T09:40:05.0661373</d2p1:DeliveredAt>
    <d2p1:DeliveryId>sample string 27</d2p1:DeliveryId>
    <d2p1:DeliveryPromise>
      <d2p1:CurrencyCode>sample string 4</d2p1:CurrencyCode>
      <d2p1:DeliveryWindowEnd>2025-04-25T09:40:05.0661373</d2p1:DeliveryWindowEnd>
      <d2p1:DeliveryWindowStart>2025-04-25T09:40:05.0661373</d2p1:DeliveryWindowStart>
      <d2p1:DropoffTime>2025-04-25T09:40:05.0661373</d2p1:DropoffTime>
      <d2p1:Fee>3</d2p1:Fee>
      <d2p1:PickupTime>2025-04-25T09:40:05.0661373</d2p1:PickupTime>
    </d2p1:DeliveryPromise>
    <d2p1:DropoffContact>
      <d2p1:BusinessName>sample string 24</d2p1:BusinessName>
      <d2p1:FirstName>sample string 22</d2p1:FirstName>
      <d2p1:Instructions>sample string 26</d2p1:Instructions>
      <d2p1:LastName>sample string 23</d2p1:LastName>
      <d2p1:PhoneNumber>sample string 25</d2p1:PhoneNumber>
    </d2p1:DropoffContact>
    <d2p1:ExternalOrderId>sample string 1</d2p1:ExternalOrderId>
    <d2p1:PartnerDeliveryId>sample string 40</d2p1:PartnerDeliveryId>
    <d2p1:PickupContact>
      <d2p1:BusinessName>sample string 19</d2p1:BusinessName>
      <d2p1:FirstName>sample string 17</d2p1:FirstName>
      <d2p1:Instructions>sample string 21</d2p1:Instructions>
      <d2p1:LastName>sample string 18</d2p1:LastName>
      <d2p1:PhoneNumber>sample string 20</d2p1:PhoneNumber>
    </d2p1:PickupContact>
    <d2p1:Quote>
      <d2p1:ExpiresAt>2025-04-25T09:40:05.0661373</d2p1:ExpiresAt>
      <d2p1:QuoteId>sample string 38</d2p1:QuoteId>
      <d2p1:QuotePromise>
        <d2p1:CurrencyCode>sample string 33</d2p1:CurrencyCode>
        <d2p1:DeliveryWindowEnd>2025-04-25T09:40:05.0661373</d2p1:DeliveryWindowEnd>
        <d2p1:DeliveryWindowStart>2025-04-25T09:40:05.0661373</d2p1:DeliveryWindowStart>
        <d2p1:DropoffTime>2025-04-25T09:40:05.0661373</d2p1:DropoffTime>
        <d2p1:Fee>32</d2p1:Fee>
        <d2p1:PickupTime>2025-04-25T09:40:05.0661373</d2p1:PickupTime>
      </d2p1:QuotePromise>
      <d2p1:RequestedAt>2025-04-25T09:40:05.0661373</d2p1:RequestedAt>
    </d2p1:Quote>
    <d2p1:Status>CREATED</d2p1:Status>
  </DeliveryData>
</OrderDeliveryStatusResult>