Rsl.Lotteries

ReturnOrder

The following routes are available for this service:
POST	/orders/{OrderId}/return

**ReturnOrder** Parameters:
Name	Parameter	Data Type	Required	Description
OrderId	path	string	Yes	Order ID
RequestReference	body	RequestReference	Yes	Attribution values associated to the return order

**RequestReference** Parameters:
Name	Parameter	Data Type	Required
CampaignId	form	string	No
RetailChannelId	form	string	Yes
ReferenceId	form	string	No

**Order** Parameters:
Name	Parameter	Data Type	Required	Description
ReceiptNumber	form	string	No
OrderId	form	string	No	The order number
CreatedDate	form	DateTime?	No
LastModified	form	DateTime?	No
CustomerId	form	string	No
Items	form	List<OrderLineItem>	No
Status	form	OrderStatus?	No
Total	form	decimal	No
CampaignId	form	string	No	The campaign identifier associated to the order
GiftRecipient	form	Contact	No	The order gift recipient
GiftMessage	form	string	No
IsGift	form	bool	No
RewardType	form	RewardType?	No

**OrderLineItem** Parameters:
Name	Parameter	Data Type	Required
ArtUnion	form	string	No
ProductId	form	string	No
LineItemId	form	string	No
InventTransId	form	string	No
ProductName	form	string	No
ProductTicketCount	form	int?	No
Quantity	form	int	No
SubTotal	form	decimal	No
TicketNumbers	form	string	No
DrawDate	form	DateTime?	No
GameType	form	string	No
ArtUnionDictionary	form	Dictionary<string, string>	No
ArtUnionStatus	form	ArtUnionStatus?	No
LineItemStatus	form	OrderLineItemStatus?	No
IsRefunded	form	bool?	No
ArtUnionId	form	string	No
IsVIPDraw	form	bool	No

**ArtUnionStatus** Enum:
Name	Value
Draft	1
Approved	2
PreOrder	3
Open	4
Closed	5
Batching	6
Sellout	7

**OrderLineItemStatus** Enum:
Name	Value
Open	1
Closed	2
PreOrder	3

**OrderStatus** Enum:
Name	Value
Unknown	0
Open	1
Invoiced	4
Cancelled	5
Pending	6

**Contact** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	form	string	No
Title	form	PersonTitle?	No	Person title Allowable Values Mr Mrs Miss Ms Dr
FirstName	form	string	No
LastName	form	string	No
DateOfBirth	form	DateTime?	No
HomePhone	form	string	No
MobilePhone	form	string	No
Email	form	string	No
Address	form	Address	No

**PersonTitle** Enum:
Mr
Mrs
Miss
Ms
Dr

**Address** Parameters:
Name	Parameter	Data Type	Required
Street	form	string	No
City	form	string	No
ZipCode	form	string	No
State	form	string	No
CountryRegionId	form	string	No
DPID	form	int	No
Suburb	form	string	No

**RewardType** Enum:
None
BonusTicket

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /orders/{OrderId}/return HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"orderId":"String","requestReference":{"campaignId":"String","retailChannelId":"String","referenceId":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"receiptNumber":"String","orderId":"String","createdDate":"0001-01-01T00:00:00.0000000","lastModified":"0001-01-01T00:00:00.0000000","customerId":"String","items":[{"artUnion":"String","productId":"String","lineItemId":"String","inventTransId":"String","productName":"String","productTicketCount":0,"quantity":0,"subTotal":0,"ticketNumbers":"String","drawDate":"0001-01-01T00:00:00.0000000","gameType":"String","artUnionDictionary":{"String":"String"},"artUnionStatus":"0","lineItemStatus":"0","isRefunded":false,"artUnionId":"String","isVIPDraw":false}],"status":"Unknown","total":0,"campaignId":"String","giftRecipient":{"contactId":"String","title":"Mr","firstName":"String","lastName":"String","dateOfBirth":"0001-01-01T00:00:00.0000000","homePhone":"String","mobilePhone":"String","email":"String","address":{"street":"String","city":"String","zipCode":"String","state":"String","countryRegionId":"String","dpid":0,"suburb":"String"}},"giftMessage":"String","isGift":true,"rewardType":"None"}

Rsl.Lotteries

ReturnOrder

Allowable Values

HTTP + JSON