GET GetOrderByTransactionReference?TransactionRef={TransactionRef}&UserId={UserId}

Request Information

URI Parameters

Name	Description	Type	Additional information
TransactionRef		string	Required
UserId		string	Required

Body Parameters

None.

Response Information

Resource Description

GetOrderByReference_Result

Name	Type	Additional information
id	integer	None.
DateCreated	date	None.
LastModified	date	None.
OrderNumber	string	None.
TransactionReference	string	None.
DeliveryType	integer	None.
VendorType	integer	None.
VendorId	integer	None.
UserId	string	None.
ScheduledTimeSlot	date	None.
CollectionTimeSlot	string	None.
UserCellNo	string	None.
AmountPayable	decimal number	None.
TransactionFee	decimal number	None.
VatPayable	decimal number	None.
GrandTotal	decimal number	None.
CartId	string	None.
PaymentSuccessful	boolean	None.
TipAmount	decimal number	None.
AmountPaid	decimal number	None.
DatePaid	date	None.
Collected	boolean	None.
DateCollected	date	None.
OrderReady	boolean	None.
DateOrderReady	date	None.
Packing	boolean	None.
DatePacking	date	None.
Cancelled	boolean	None.
DateCancelled	date	None.
PartialRefund	boolean	None.
DatePartialRefund	date	None.
Status	integer	None.
Completed	boolean	None.
DateCompleted	date	None.
Delievered	boolean	None.
DateDevivered	date	None.
PaymentType	integer	None.
VendorName	string	None.
Logo	string	None.
RegistrationNo	string	None.
PhoneNumber	string	None.
TelephoneNo	string	None.
Email	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
Suburb	string	None.
City	string	None.
Province	string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "DateCreated": "2025-12-11T10:55:20.9774605+02:00",
  "LastModified": "2025-12-11T10:55:20.9774605+02:00",
  "OrderNumber": "sample string 4",
  "TransactionReference": "sample string 5",
  "DeliveryType": 1,
  "VendorType": 1,
  "VendorId": 1,
  "UserId": "sample string 6",
  "ScheduledTimeSlot": "2025-12-11T10:55:20.9774605+02:00",
  "CollectionTimeSlot": "sample string 7",
  "UserCellNo": "sample string 8",
  "AmountPayable": 9.1,
  "TransactionFee": 10.1,
  "VatPayable": 11.1,
  "GrandTotal": 12.1,
  "CartId": "sample string 13",
  "PaymentSuccessful": true,
  "TipAmount": 15.1,
  "AmountPaid": 16.1,
  "DatePaid": "2025-12-11T10:55:20.9774605+02:00",
  "Collected": true,
  "DateCollected": "2025-12-11T10:55:20.9774605+02:00",
  "OrderReady": true,
  "DateOrderReady": "2025-12-11T10:55:20.9774605+02:00",
  "Packing": true,
  "DatePacking": "2025-12-11T10:55:20.9774605+02:00",
  "Cancelled": true,
  "DateCancelled": "2025-12-11T10:55:20.9774605+02:00",
  "PartialRefund": true,
  "DatePartialRefund": "2025-12-11T10:55:20.9774605+02:00",
  "Status": 22,
  "Completed": true,
  "DateCompleted": "2025-12-11T10:55:20.9774605+02:00",
  "Delievered": true,
  "DateDevivered": "2025-12-11T10:55:20.9774605+02:00",
  "PaymentType": 25,
  "VendorName": "sample string 26",
  "Logo": "sample string 27",
  "RegistrationNo": "sample string 28",
  "PhoneNumber": "sample string 29",
  "TelephoneNo": "sample string 30",
  "Email": "sample string 31",
  "AddressLine1": "sample string 32",
  "AddressLine2": "sample string 33",
  "Suburb": "sample string 34",
  "City": "sample string 35",
  "Province": "sample string 36"
}

application/xml, text/xml

Sample:

<GetOrderByReference_Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BonaMarketAPI.Database">
  <AddressLine1>sample string 32</AddressLine1>
  <AddressLine2>sample string 33</AddressLine2>
  <AmountPaid>16.1</AmountPaid>
  <AmountPayable>9.1</AmountPayable>
  <Cancelled>true</Cancelled>
  <CartId>sample string 13</CartId>
  <City>sample string 35</City>
  <Collected>true</Collected>
  <CollectionTimeSlot>sample string 7</CollectionTimeSlot>
  <Completed>true</Completed>
  <DateCancelled>2025-12-11T10:55:20.9774605+02:00</DateCancelled>
  <DateCollected>2025-12-11T10:55:20.9774605+02:00</DateCollected>
  <DateCompleted>2025-12-11T10:55:20.9774605+02:00</DateCompleted>
  <DateCreated>2025-12-11T10:55:20.9774605+02:00</DateCreated>
  <DateDevivered>2025-12-11T10:55:20.9774605+02:00</DateDevivered>
  <DateOrderReady>2025-12-11T10:55:20.9774605+02:00</DateOrderReady>
  <DatePacking>2025-12-11T10:55:20.9774605+02:00</DatePacking>
  <DatePaid>2025-12-11T10:55:20.9774605+02:00</DatePaid>
  <DatePartialRefund>2025-12-11T10:55:20.9774605+02:00</DatePartialRefund>
  <Delievered>true</Delievered>
  <DeliveryType>1</DeliveryType>
  <Email>sample string 31</Email>
  <GrandTotal>12.1</GrandTotal>
  <LastModified>2025-12-11T10:55:20.9774605+02:00</LastModified>
  <Logo>sample string 27</Logo>
  <OrderNumber>sample string 4</OrderNumber>
  <OrderReady>true</OrderReady>
  <Packing>true</Packing>
  <PartialRefund>true</PartialRefund>
  <PaymentSuccessful>true</PaymentSuccessful>
  <PaymentType>25</PaymentType>
  <PhoneNumber>sample string 29</PhoneNumber>
  <Province>sample string 36</Province>
  <RegistrationNo>sample string 28</RegistrationNo>
  <ScheduledTimeSlot>2025-12-11T10:55:20.9774605+02:00</ScheduledTimeSlot>
  <Status>22</Status>
  <Suburb>sample string 34</Suburb>
  <TelephoneNo>sample string 30</TelephoneNo>
  <TipAmount>15.1</TipAmount>
  <TransactionFee>10.1</TransactionFee>
  <TransactionReference>sample string 5</TransactionReference>
  <UserCellNo>sample string 8</UserCellNo>
  <UserId>sample string 6</UserId>
  <VatPayable>11.1</VatPayable>
  <VendorId>1</VendorId>
  <VendorName>sample string 26</VendorName>
  <VendorType>1</VendorType>
  <id>1</id>
</GetOrderByReference_Result>