GET | /customers/{CustomerId}/orders | Known issues (Pending Dynamics 365 Update 10) - Order status is always Unknown - Payment result and gift information are absent - Order items names, line item id, ticket count and ticket numbers are absent |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | path | string | Yes | The customer identifier |
FromCreatedDate | query | DateTime? | No | |
ToCreatedDate | query | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers/{CustomerId}/orders HTTP/1.1 Host: azs-stg-lotteries-web.azurewebsites.net Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"offset":0,"total":0,"results":[{"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"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}