| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderId | path | string | Yes | The order identifier |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Value |
|---|---|
| Draft | 1 |
| Approved | 2 |
| PreOrder | 3 |
| Open | 4 |
| Closed | 5 |
| Batching | 6 |
| Sellout | 7 |
| Name | Value |
|---|---|
| Open | 1 |
| Closed | 2 |
| PreOrder | 3 |
| Name | Value |
|---|---|
| Unknown | 0 |
| Open | 1 |
| Invoiced | 4 |
| Cancelled | 5 |
| Pending | 6 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | form | string | No | |
| Title | form | PersonTitle? | No | Person titleAllowable Values
|
| FirstName | form | string | No | |
| LastName | form | string | No | |
| DateOfBirth | form | DateTime? | No | |
| HomePhone | form | string | No | |
| MobilePhone | form | string | No | |
| form | string | No | ||
| Address | form | Address | No |
| Mr |
| Mrs |
| Miss |
| Ms |
| Dr |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| None |
| BonusTicket |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/FindOrderById HTTP/1.1
Host: azs-stg-lotteries-web.azurewebsites.net
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"orderId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}