POST POS/Sales/OrderItems/Search Try Now
Search Order Item
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId |
The invoice identifier.
|
string |
None.
|
| OrderNumber |
The invoice number.
|
long |
None.
|
| EventId |
The event identifier.
|
string |
None.
|
| VenueId |
The venue identifier.
|
string |
None.
|
| Event |
The event.
|
string |
None.
|
| Venue |
The venue.
|
string |
None.
|
| EventDate |
The event date.
|
DateValue |
None.
|
| OrderDate |
The invoice date.
|
DateValue |
None.
|
| TicketNumber |
The ticket number.
|
long |
None.
|
| Section |
The section.
|
string |
None.
|
| Row |
The row.
|
string |
None.
|
| LowSeat |
The low seat.
|
integer |
None.
|
| HighSeat |
The high seat.
|
integer |
None.
|
| PurchaseOrderId |
The purchase order identifier.
|
string |
None.
|
| ExternalOrderNumber |
The external order number.
|
string |
None.
|
| Performer |
The performer.
|
string |
None.
|
| IncludeInactive |
A value indicating whether [include inactive].
|
boolean |
None.
|
| IsPending | boolean |
None.
|
|
| Tags | Collection of string |
None.
|
|
| OrderBy |
Sets the order by.(Note: Please use column Name Given in Response only,Don't use "Page" or "ItemsPerPage").
|
string |
None.
|
| SortOrder |
The SortOrder i.e. "ASC" or "DESC"
|
string |
None.
|
| DateUpdated |
Set Date Updated you can use either Date Updated Or UpdatedSince.
|
date |
None.
|
| UpdatedSince |
Set From Date and To Date value. Return result for between date , From Date And To Date.
|
DateValue |
None.
|
| Page |
Sets the page.
|
integer |
None.
|
| ItemsPerPage |
Sets the items per page.
|
integer |
None.
|
Request Formats
application/json, text/json
Sample:
{
"OrderId": "",
"OrderNumber": 2,
"EventId": "",
"VenueId": "",
"Event": "",
"Venue": "",
"EventDate": {
"FromDate": "2024-04-04T00:23",
"ToDate": "2024-04-04T00:24",
"FilterByTime": true
},
"OrderDate": {
"FromDate": "2024-04-04T00:23",
"ToDate": "2024-04-04T00:24",
"FilterByTime": true
},
"TicketNumber": 7,
"Section": "",
"Row": "",
"LowSeat": 10,
"HighSeat": 11,
"PurchaseOrderId": "",
"ExternalOrderNumber": "",
"Performer": "",
"IncludeInactive": true,
"IsPending": true,
"Tags": [
""
],
"OrderBy": "",
"SortOrder": null,
"DateUpdated": "2024-04-04T00:23",
"UpdatedSince": {
"FromDate": "2024-04-04T00:23",
"ToDate": "2024-04-04T00:24",
"FilterByTime": true
},
"Page": 20,
"ItemsPerPage": 21
}
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId |
The order identifier.
|
string |
None.
|
| OrderNumber |
The order number.
|
integer |
None.
|
| Zone |
Zone
|
Zone |
None.
|
| CustomerId |
Customer Id
|
string |
None.
|
| ShipTo |
Ship To Contact
|
Contact |
None.
|
| BillTo |
Bill To Contact
|
Contact |
None.
|
| ShipFrom |
Ship From Address
|
SubscriberAddress |
None.
|
| OrderStatus |
The order status.
|
InvoiceStatus |
None.
|
| ShippingStatus |
The shipping status.
|
ShippingStatus |
None.
|
| PaymentStatus |
The payment status.
|
PaymentStatus |
None.
|
| ExternalOrderNumber |
The external order number.
|
string |
None.
|
| Items |
The order items.
|
Collection of OrderItem |
None.
|
| ShippingType |
The type ofThe shipping.
|
ShippingType |
None.
|
| ShippingService |
The shipping service.
|
string |
None.
|
| ShippingTrackingNumber |
The shipping tracking number.
|
string |
None.
|
| ShippingCost |
The shipping cost.
|
Money |
None.
|
| Tax |
The tax.
|
Money |
None.
|
| ServiceFee |
The overs.
|
Money |
None.
|
| Discount |
The discount.
|
Money |
None.
|
| Commission |
The commission.
|
Money |
None.
|
| SubTotal |
The sub total.
|
Money |
None.
|
| GrandTotal |
The grand total.
|
Money |
None.
|
| Notes |
The notes.
|
string |
None.
|
| PrivateNotes |
Order private notes.
|
Collection of PrivateNote |
None.
|
| VoidReason |
The void reason.
|
string |
None.
|
| Tags |
The tags.
|
Collection of string |
None.
|
| ReferralTypeId |
The Referral Type Id.
|
string |
None.
|
| ReferralType |
The Referral Type.
|
string |
None.
|
| ReferralName |
The referral name.
|
string |
None.
|
| ClientCompany |
The client company.
|
string |
None.
|
| ClientCSR |
The client CSR.
|
string |
None.
|
| SubscriberCSR |
The subscriber CSR.
|
string |
None.
|
| OrderDate |
The order date.
|
date |
None.
|
| AllocationStatus |
The order allocation status.
|
AllocationStatus |
None.
|
Response Formats
application/json, text/json
Sample:
Sample not available.