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

Retrieves a payment status of the order

URI template

v1/Orders/{siteId}/{orderId}/Status?pollPaymentStatus={pollPaymentStatus}&maxPollingWaitTimeSec={maxPollingWaitTimeSec}

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
pollPaymentStatus

boolean

Default value is False
maxPollingWaitTimeSec

integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

OrderPaymentStatusResultCodes. Known internal errors are BadRequest, Error

OrderPaymentStatusResultCodes

Response Formats

application/json, text/json

Sample: 
0

application/xml, text/xml

Sample: 
<OrderPaymentStatusResultCodes xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">Success</OrderPaymentStatusResultCodes>