GET api/SalesOrder?salesOrderReference={salesOrderReference}
Allows you to retrieve created SalesOrder
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| salesOrderReference |
Reference string of sales order |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
SalesOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| SalesOrderId | integer |
None. |
|
| SalesOrderReference | string |
None. |
|
| SalesOrderBarcode | string |
None. |
|
| CustomerName | string |
None. |
|
| CustomerAddress | string |
None. |
|
| CustomerEmail | string |
None. |
|
| CustomerMobileNumber | string |
None. |
|
| CustomerLanguageCode | string |
None. |
|
| Remark | string |
None. |
|
| ResellerId | integer |
None. |
|
| VoucherCode | string |
None. |
|
| Status | string |
None. |
|
| Lines | Collection of SalesOrderLine |
None. |
Response Formats
application/json, text/json
Sample:
{
"salesOrderId": 200001,
"salesOrderReference": "NIT-12345678",
"salesOrderBarcode": null,
"status": null,
"lines": [
{
"productId": 121600,
"ticketCategoryId": 1,
"qty": 1,
"unitPrice": 40.0,
"barcodes": [
"7006196676564688564111"
],
"startDate": "2017-07-21T00:00:00+02:00"
},
{
"productId": 121562,
"ticketCategoryId": 1,
"timeslotId": 136626,
"qty": 1,
"unitPrice": 80.0,
"barcodes": [
"7082954252322264322317"
]
},
{
"productId": 125902,
"ticketCategoryId": 1,
"timeslotId": 134563,
"qty": 1,
"unitPrice": 33.0,
"barcodes": [
"4967964689364188"
]
},
{
"productId": 121564,
"ticketCategoryId": 1,
"timeslotId": 135229,
"qty": 1,
"unitPrice": 33.0,
"barcodes": [
"7069883907079748877532"
]
},
{
"productId": 121600,
"ticketCategoryId": 1,
"qty": 1,
"unitPrice": 33.0,
"barcodes": [
"7068571707869641265664"
],
"startDate": "2017-07-22T00:00:00+02:00"
},
{
"productId": 125902,
"ticketCategoryId": 2,
"timeslotId": 134564,
"qty": 1,
"unitPrice": 29.7,
"barcodes": [
"7069897307079748877647"
]
},
{
"productId": 121564,
"ticketCategoryId": 2,
"timeslotId": 135230,
"qty": 1,
"unitPrice": 29.7,
"barcodes": [
"7008293049463689069245"
]
},
{
"productId": 121600,
"ticketCategoryId": 2,
"qty": 1,
"unitPrice": 30.6,
"barcodes": [
"4962474720176078"
],
"startDate": "2017-07-23T00:00:00+02:00"
}
]
}
Not Successful Http Statuses
Not Found (404) is returned when SalesOrder does not exists