RHP_API

GetUserStoreOrder

Gets the user's paid order.

The following routes are available for this service:
GET	/User/Store/Order/{id}

**GetUserStoreOrder** Parameters:
Name	Parameter	Data Type	Required	Description
ID	path	int	No

**UserStoreOrder** Parameters:
Name	Parameter	Data Type	Required
DateCreated	form	DateTime	No
OrderID	form	int	No
NameFirst	form	string	No
NameLast	form	string	No
Phone	form	string	No
Email	form	string	No
Address	form	string	No
DateDispatched	form	DateTime?	No
OrderStatus	form	StoreOrderStatus	No
Total	form	List<UserStoreOrderTotal>	No
OrderItems	form	List<UserStoreOrderLine>	No
Payments	form	List<UserStorePayment>	No
OrderToken	form	string	No
Receipt	form	PurchaseReceipt	No
Notes	form	string	No

**UserStoreOrderTotal** Parameters:
Name	Parameter	Data Type	Required
Amount	form	decimal	No
Currency	form	CurrencyDetail	No
IncludedTax	form	decimal	No

**CurrencyDetail** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Symbol	form	string	No
Code	form	string	No
CurrencyID	form	int	No

**UserStoreOrderLine** Parameters:
Name	Parameter	Data Type	Required
Product	form	StoreProduct	No
Quantity	form	int	No
Available	form	bool	No
StoreProductStockID	form	int	No
StockAvailable	form	bool	No

**StoreProduct** Parameters:
Name	Parameter	Data Type	Required
StoreProductID	form	int	No
Name	form	string	No
Description	form	string	No
MainImage	form	StoreProductImage	No
RequiresShiping	form	bool	No
Price	form	List<StoreProductPrice>	No
Category	form	string	No
Group	form	string	No
SortNumber	form	int	No
ProductStock	form	List<StoreProductStock>	No

**StoreProductImage** Parameters:
Name	Parameter	Data Type	Required
Filename	form	string	No
Height	form	int	No
Width	form	int	No

**StoreProductPrice** Parameters:
Name	Parameter	Data Type	Required	Description
Currency	form	CurrencyDetail	No
Price	form	decimal	No

**StoreProductStock** Parameters:
Name	Parameter	Data Type	Required
StoreProductStockID	form	int	No
Quantity	form	int	No
Size	form	StoreProductStockAttribute	No
Colour	form	StoreProductStockAttribute	No

**StoreProductStockAttribute** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
Abbreviation	form	string	No
Name	form	string	No

**UserStorePayment** Parameters:
Name	Parameter	Data Type	Required
Currency	form	CurrencyDetail	No
Amount	form	decimal	No
PaymentProvider	form	PaymentProvider	No
PaymentProviderTitle	form	string	No
DatePaid	form	DateTime	No
Tax	form	decimal	No

**PurchaseReceipt** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	ReceiptAmount	No	Payment amount
Company	form	string	No	Company name, that is displayed on the user's bank statement
ABN	form	string	No	Australian Business Number
ReceiptNumber	form	string	No	Receipt number for the payment
CreditCardNumber	form	string	No	Masked Credit Card number

**ReceiptAmount** Parameters:
Name	Parameter	Data Type	Required	Description
Total	form	decimal	No	Total amount of payment
Tax	form	decimal	No	Tax included in the payment
AmountLessTax	form	decimal	No	Total minus Tax

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

HTTP + JSV

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

GET /User/Store/Order/{id} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DateCreated: 0001-01-01,
	OrderID: 0,
	NameFirst: String,
	NameLast: String,
	Phone: String,
	Email: String,
	Address: String,
	DateDispatched: 0001-01-01,
	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: 0001-01-01,
			Tax: 0
		}
	],
	OrderToken: String,
	Receipt: 
	{
		Amount: 
		{
			Total: 0,
			Tax: 0,
			AmountLessTax: 0
		},
		Company: String,
		ABN: String,
		ReceiptNumber: String,
		CreditCardNumber: String
	},
	Notes: String
}