RHP_API

<back to all web services

SendUserStoreOrderReceipt

Gets the user's paid order.

Requires Authentication
The following routes are available for this service:
All Verbs/User/Store/Order/{id}/SendReceipt
SendUserStoreOrderReceipt Parameters:
NameParameterData TypeRequiredDescription
IDpathintNo
EmailAddressquerystringNo
UserStoreOrder Parameters:
NameParameterData TypeRequiredDescription
DateCreatedformDateTimeNo
OrderIDformintNo
NameFirstformstringNo
NameLastformstringNo
PhoneformstringNo
EmailformstringNo
AddressformstringNo
DateDispatchedformDateTime?No
OrderStatusformStoreOrderStatusNo
TotalformList<UserStoreOrderTotal>No
OrderItemsformList<UserStoreOrderLine>No
PaymentsformList<UserStorePayment>No
OrderTokenformstringNo
ReceiptformPurchaseReceiptNo
NotesformstringNo
UserStoreOrderTotal Parameters:
NameParameterData TypeRequiredDescription
AmountformdecimalNo
CurrencyformCurrencyDetailNo
IncludedTaxformdecimalNo
CurrencyDetail Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
SymbolformstringNo
CodeformstringNo
CurrencyIDformintNo
UserStoreOrderLine Parameters:
NameParameterData TypeRequiredDescription
ProductformStoreProductNo
QuantityformintNo
AvailableformboolNo
StoreProductStockIDformintNo
StockAvailableformboolNo
StoreProduct Parameters:
NameParameterData TypeRequiredDescription
StoreProductIDformintNo
NameformstringNo
DescriptionformstringNo
MainImageformStoreProductImageNo
RequiresShipingformboolNo
PriceformList<StoreProductPrice>No
CategoryformstringNo
GroupformstringNo
SortNumberformintNo
ProductStockformList<StoreProductStock>No
StoreProductImage Parameters:
NameParameterData TypeRequiredDescription
FilenameformstringNo
HeightformintNo
WidthformintNo
StoreProductPrice Parameters:
NameParameterData TypeRequiredDescription
CurrencyformCurrencyDetailNo
PriceformdecimalNo
StoreProductStock Parameters:
NameParameterData TypeRequiredDescription
StoreProductStockIDformintNo
QuantityformintNo
SizeformStoreProductStockAttributeNo
ColourformStoreProductStockAttributeNo
StoreProductStockAttribute Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
AbbreviationformstringNo
NameformstringNo
UserStorePayment Parameters:
NameParameterData TypeRequiredDescription
CurrencyformCurrencyDetailNo
AmountformdecimalNo
PaymentProviderformPaymentProviderNo
PaymentProviderTitleformstringNo
DatePaidformDateTimeNo
TaxformdecimalNo
PurchaseReceipt Parameters:
NameParameterData TypeRequiredDescription
AmountformReceiptAmountNoPayment amount
CompanyformstringNoCompany name, that is displayed on the user's bank statement
ABNformstringNoAustralian Business Number
ReceiptNumberformstringNoReceipt number for the payment
CreditCardNumberformstringNoMasked Credit Card number
ReceiptAmount Parameters:
NameParameterData TypeRequiredDescription
TotalformdecimalNoTotal amount of payment
TaxformdecimalNoTax included in the payment
AmountLessTaxformdecimalNoTotal minus Tax

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /User/Store/Order/{id}/SendReceipt HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ID":0,"EmailAddress":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DateCreated":"\/Date(-62135596800000-0000)\/","OrderID":0,"NameFirst":"String","NameLast":"String","Phone":"String","Email":"String","Address":"String","DateDispatched":"\/Date(-62135596800000-0000)\/","OrderStatus":"Open","Total":[{"Amount":0,"Currency":{"Name":"String","Symbol":"String","Code":"String","CurrencyID":0},"IncludedTax":0}],"OrderItems":[{"Product":{"StoreProductID":0,"Name":"String","Description":"String","MainImage":{"Filename":"String","Height":0,"Width":0},"RequiresShiping":false,"Price":[{"Currency":{"Name":"String","Symbol":"String","Code":"String","CurrencyID":0},"Price":0}],"Category":"String","Group":"String","SortNumber":0,"ProductStock":[{"StoreProductStockID":0,"Quantity":0,"Size":{"ID":0,"Abbreviation":"String","Name":"String"},"Colour":{"ID":0,"Abbreviation":"String","Name":"String"}}]},"Quantity":0,"Available":false,"StoreProductStockID":0,"StockAvailable":false}],"Payments":[{"Currency":{"Name":"String","Symbol":"String","Code":"String","CurrencyID":0},"Amount":0,"PaymentProvider":"Verotel","PaymentProviderTitle":"String","DatePaid":"\/Date(-62135596800000-0000)\/","Tax":0}],"OrderToken":"String","Receipt":{"Amount":{"Total":0,"Tax":0,"AmountLessTax":0},"Company":"String","ABN":"String","ReceiptNumber":"String","CreditCardNumber":"String"},"Notes":"String"}