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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<SendUserStoreOrderReceipt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <EmailAddress>String</EmailAddress>
  <ID>0</ID>
</SendUserStoreOrderReceipt>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserStoreOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Address>String</Address>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <DateDispatched>0001-01-01T00:00:00</DateDispatched>
  <Email>String</Email>
  <NameFirst>String</NameFirst>
  <NameLast>String</NameLast>
  <Notes>String</Notes>
  <OrderID>0</OrderID>
  <OrderItems>
    <UserStoreOrderLine>
      <Available>false</Available>
      <Product xmlns:d4p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
        <d4p1:Category>String</d4p1:Category>
        <d4p1:Description>String</d4p1:Description>
        <d4p1:Group>String</d4p1:Group>
        <d4p1:MainImage>
          <d4p1:Filename>String</d4p1:Filename>
          <d4p1:Height>0</d4p1:Height>
          <d4p1:Width>0</d4p1:Width>
        </d4p1:MainImage>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:Price>
          <d4p1:StoreProductPrice>
            <d4p1:Currency xmlns:d7p1="http://schemas.datacontract.org/2004/07/RHP.Model">
              <d7p1:Code>String</d7p1:Code>
              <d7p1:CurrencyID>0</d7p1:CurrencyID>
              <d7p1:Name>String</d7p1:Name>
              <d7p1:Symbol>String</d7p1:Symbol>
            </d4p1:Currency>
            <d4p1:Price>0</d4p1:Price>
          </d4p1:StoreProductPrice>
        </d4p1:Price>
        <d4p1:ProductStock>
          <d4p1:StoreProductStock>
            <d4p1:Colour>
              <d4p1:Abbreviation>String</d4p1:Abbreviation>
              <d4p1:ID>0</d4p1:ID>
              <d4p1:Name>String</d4p1:Name>
            </d4p1:Colour>
            <d4p1:Quantity>0</d4p1:Quantity>
            <d4p1:Size>
              <d4p1:Abbreviation>String</d4p1:Abbreviation>
              <d4p1:ID>0</d4p1:ID>
              <d4p1:Name>String</d4p1:Name>
            </d4p1:Size>
            <d4p1:StoreProductStockID>0</d4p1:StoreProductStockID>
          </d4p1:StoreProductStock>
        </d4p1:ProductStock>
        <d4p1:RequiresShiping>false</d4p1:RequiresShiping>
        <d4p1:SortNumber>0</d4p1:SortNumber>
        <d4p1:StoreProductID>0</d4p1:StoreProductID>
      </Product>
      <Quantity>0</Quantity>
      <StockAvailable>false</StockAvailable>
      <StoreProductStockID>0</StoreProductStockID>
    </UserStoreOrderLine>
  </OrderItems>
  <OrderStatus>Open</OrderStatus>
  <OrderToken>String</OrderToken>
  <Payments>
    <UserStorePayment>
      <Amount>0</Amount>
      <Currency xmlns:d4p1="http://schemas.datacontract.org/2004/07/RHP.Model">
        <d4p1:Code>String</d4p1:Code>
        <d4p1:CurrencyID>0</d4p1:CurrencyID>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:Symbol>String</d4p1:Symbol>
      </Currency>
      <DatePaid>0001-01-01T00:00:00</DatePaid>
      <PaymentProvider>Verotel</PaymentProvider>
      <PaymentProviderTitle>String</PaymentProviderTitle>
      <Tax>0</Tax>
    </UserStorePayment>
  </Payments>
  <Phone>String</Phone>
  <Receipt>
    <ABN>String</ABN>
    <Amount>
      <AmountLessTax>0</AmountLessTax>
      <Tax>0</Tax>
      <Total>0</Total>
    </Amount>
    <Company>String</Company>
    <CreditCardNumber>String</CreditCardNumber>
    <ReceiptNumber>String</ReceiptNumber>
  </Receipt>
  <Total>
    <UserStoreOrderTotal>
      <Amount>0</Amount>
      <Currency xmlns:d4p1="http://schemas.datacontract.org/2004/07/RHP.Model">
        <d4p1:Code>String</d4p1:Code>
        <d4p1:CurrencyID>0</d4p1:CurrencyID>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:Symbol>String</d4p1:Symbol>
      </Currency>
      <IncludedTax>0</IncludedTax>
    </UserStoreOrderTotal>
  </Total>
</UserStoreOrder>