GET api/Order/{id}
Gets order.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Order Global Id. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Order| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId | integer |
None. |
|
| OpenRegisterId | integer |
None. |
|
| OrderStatusId | integer |
None. |
|
| OrderStatus | string |
None. |
|
| CustomerId | integer |
None. |
|
| OrderDiscount | decimal number |
None. |
|
| OrderNote | string |
None. |
|
| OrderSubTotal | decimal number |
None. |
|
| OrderTax | decimal number |
None. |
|
| OrderShipping | decimal number |
None. |
|
| OrderTotal | decimal number |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedByName | string |
None. |
|
| CreatedDate | date |
None. |
|
| UpdatedBy | string |
None. |
|
| UpdatedByName | string |
None. |
|
| UpdatedDate | date |
None. |
|
| OrderDiscountPercentage | decimal number |
None. |
|
| OrderTaxRate | decimal number |
None. |
|
| GlobalId | string |
None. |
|
| OrganizationId | integer |
None. |
|
| RegisterId | integer |
None. |
|
| RegisterName | string |
None. |
|
| OutletId | integer |
None. |
|
| OutletName | string |
None. |
|
| CustomerName | string |
None. |
|
| OrderProcessedDate | date |
None. |
|
| OrderProcessedByName | string |
None. |
|
| OrderParkedDate | date |
None. |
|
| CustomerPhone | string |
None. |
|
| ItemCount | integer |
None. |
|
| OrderProcessedDateDay | date |
None. |
|
| OrderNumber | integer |
None. |
|
| OrderTypeId | integer |
None. |
|
| OrderType | string |
None. |
|
| IsPaid | boolean |
None. |
|
| AssignedToEmployeeId | integer |
None. |
|
| AssignedToEmployeeName | string |
None. |
|
| PaymentMethod | string |
None. |
|
| IsPOS | integer |
None. |
|
| Customer | string |
None. |
|
| OrderCreatedDate | date |
None. |
|
| OrderCreatedByName | string |
None. |
|
| OrderYear | integer |
None. |
|
| IsRegisterClosed | integer |
None. |
|
| QuoteId | integer |
None. |
|
| QuoteName | string |
None. |
|
| QuoteNumber | integer |
None. |
|
| QuoteDate | date |
None. |
|
| QuoteVersion | integer |
None. |
|
| QuoteTotal | decimal number |
None. |
|
| QuoteGlobalId | string |
None. |
|
| FileCount | integer |
None. |
|
| IsIncome | boolean |
None. |
|
| IsFulfilled | boolean |
None. |
|
| IsDelivered | boolean |
None. |
|
| IncomeCategoryId | integer |
None. |
|
| IncomeReferenceNumber | string |
None. |
|
| IncomeToFinancialAccountId | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"OrderId": 1,
"OpenRegisterId": 1,
"OrderStatusId": 1,
"OrderStatus": "sample string 2",
"CustomerId": 1,
"OrderDiscount": 1.0,
"OrderNote": "sample string 3",
"OrderSubTotal": 1.0,
"OrderTax": 1.0,
"OrderShipping": 1.0,
"OrderTotal": 1.0,
"CreatedBy": "sample string 4",
"CreatedByName": "sample string 5",
"CreatedDate": "2025-12-13T10:30:17.509742+00:00",
"UpdatedBy": "sample string 6",
"UpdatedByName": "sample string 7",
"UpdatedDate": "2025-12-13T10:30:17.509742+00:00",
"OrderDiscountPercentage": 1.0,
"OrderTaxRate": 1.0,
"GlobalId": "sample string 8",
"OrganizationId": 1,
"RegisterId": 1,
"RegisterName": "sample string 9",
"OutletId": 1,
"OutletName": "sample string 10",
"CustomerName": "sample string 11",
"OrderProcessedDate": "2025-12-13T10:30:17.509742+00:00",
"OrderProcessedByName": "sample string 12",
"OrderParkedDate": "2025-12-13T10:30:17.509742+00:00",
"CustomerPhone": "sample string 13",
"ItemCount": 1,
"OrderProcessedDateDay": "2025-12-13T10:30:17.509742+00:00",
"OrderNumber": 1,
"OrderTypeId": 1,
"OrderType": "sample string 14",
"IsPaid": true,
"AssignedToEmployeeId": 1,
"AssignedToEmployeeName": "sample string 15",
"PaymentMethod": "sample string 16",
"IsPOS": 17,
"Customer": "sample string 18",
"OrderCreatedDate": "2025-12-13T10:30:17.509742+00:00",
"OrderCreatedByName": "sample string 19",
"OrderYear": 1,
"IsRegisterClosed": 20,
"QuoteId": 1,
"QuoteName": "sample string 21",
"QuoteNumber": 1,
"QuoteDate": "2025-12-13T10:30:17.509742+00:00",
"QuoteVersion": 1,
"QuoteTotal": 1.0,
"QuoteGlobalId": "sample string 22",
"FileCount": 1,
"IsIncome": true,
"IsFulfilled": true,
"IsDelivered": true,
"IncomeCategoryId": 1,
"IncomeReferenceNumber": "sample string 23",
"IncomeToFinancialAccountId": 1
}
application/xml, text/xml
Sample:
<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CustomersdbWebShared.Models"> <AssignedToEmployeeId>1</AssignedToEmployeeId> <AssignedToEmployeeName>sample string 15</AssignedToEmployeeName> <CreatedBy>sample string 4</CreatedBy> <CreatedByName>sample string 5</CreatedByName> <CreatedDate>2025-12-13T10:30:17.509742+00:00</CreatedDate> <Customer>sample string 18</Customer> <CustomerId>1</CustomerId> <CustomerName>sample string 11</CustomerName> <CustomerPhone>sample string 13</CustomerPhone> <FileCount>1</FileCount> <GlobalId>sample string 8</GlobalId> <IncomeCategoryId>1</IncomeCategoryId> <IncomeReferenceNumber>sample string 23</IncomeReferenceNumber> <IncomeToFinancialAccountId>1</IncomeToFinancialAccountId> <IsDelivered>true</IsDelivered> <IsFulfilled>true</IsFulfilled> <IsIncome>true</IsIncome> <IsPOS>17</IsPOS> <IsPaid>true</IsPaid> <IsRegisterClosed>20</IsRegisterClosed> <ItemCount>1</ItemCount> <OpenRegisterId>1</OpenRegisterId> <OrderCreatedByName>sample string 19</OrderCreatedByName> <OrderCreatedDate>2025-12-13T10:30:17.509742+00:00</OrderCreatedDate> <OrderDiscount>1</OrderDiscount> <OrderDiscountPercentage>1</OrderDiscountPercentage> <OrderId>1</OrderId> <OrderNote>sample string 3</OrderNote> <OrderNumber>1</OrderNumber> <OrderParkedDate>2025-12-13T10:30:17.509742+00:00</OrderParkedDate> <OrderProcessedByName>sample string 12</OrderProcessedByName> <OrderProcessedDate>2025-12-13T10:30:17.509742+00:00</OrderProcessedDate> <OrderProcessedDateDay>2025-12-13T10:30:17.509742+00:00</OrderProcessedDateDay> <OrderShipping>1</OrderShipping> <OrderStatus>sample string 2</OrderStatus> <OrderStatusId>1</OrderStatusId> <OrderSubTotal>1</OrderSubTotal> <OrderTax>1</OrderTax> <OrderTaxRate>1</OrderTaxRate> <OrderTotal>1</OrderTotal> <OrderType>sample string 14</OrderType> <OrderTypeId>1</OrderTypeId> <OrderYear>1</OrderYear> <OrganizationId>1</OrganizationId> <OutletId>1</OutletId> <OutletName>sample string 10</OutletName> <PaymentMethod>sample string 16</PaymentMethod> <QuoteDate>2025-12-13T10:30:17.509742+00:00</QuoteDate> <QuoteGlobalId>sample string 22</QuoteGlobalId> <QuoteId>1</QuoteId> <QuoteName>sample string 21</QuoteName> <QuoteNumber>1</QuoteNumber> <QuoteTotal>1</QuoteTotal> <QuoteVersion>1</QuoteVersion> <RegisterId>1</RegisterId> <RegisterName>sample string 9</RegisterName> <UpdatedBy>sample string 6</UpdatedBy> <UpdatedByName>sample string 7</UpdatedByName> <UpdatedDate>2025-12-13T10:30:17.509742+00:00</UpdatedDate> </Order>