GET POS/Sales/Orders/{Id} Try Now
Get Order
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The OrderId.
|
string |
Required
|
Body Parameters
None.
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.