GET api/me/orders/{orderId}
This method will retrieve order by id for a current user
Requires Authorization!
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderId |
Existing order id |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Instance of
OrderModelName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
UserId | integer |
None. |
|
Items | Collection of OrderLineItemModel |
None. |
|
TaxRate | decimal number |
None. |
|
AmountCharged | decimal number |
None. |
|
TotalAmount | decimal number |
None. |
|
OrderNumber | string |
None. |
|
PaymentProviderToken | string |
None. |
|
OrderStatusId | integer |
None. |
|
OrderStatus | string |
None. |
|
TermsOfUsePolicyId | integer |
None. |
|
OrderDate | date |
None. |
|
TotalDiscountAmount | decimal number |
None. |
|
CurrencyCode | string |
None. |
|
ProviderChargeId | string |
None. |
|
IsBusinessUserClient | boolean |
None. |
|
AgencyCaseId | integer |
None. |
|
UserPropertyCaseId | integer |
None. |
|
IsPaid | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "id": 1, "userId": 1, "items": [ { "id": 1, "discountCode": "sample string 2", "taxYear": 3, "quantity": 4, "price": 5.0, "discountAmount": 6.0, "discountPercent": 7.0, "createdDate": "2025-05-20T15:52:41.6857636-05:00", "formattedPin": "sample string 9", "addressLine1": "sample string 10", "addressLastLine": "sample string 11", "productBundleName": "sample string 12", "productBundleId": 13, "previewImageUrl": "sample string 14", "propertyImageUrl": "sample string 15", "documents": [ { "id": 1, "agencyCaseId": 1, "orderId": 2, "orderNumber": "sample string 3", "userId": 4, "userName": "sample string 5", "productBundleId": 6, "bundleName": "sample string 7", "productId": 8, "productName": "sample string 9", "documentId": 10, "documentName": "sample string 11", "description": "sample string 12", "appealYear": 13, "documentTemplateUri": "sample string 14", "documentUri": "sample string 15", "isReport": true, "previewImageUrl": "sample string 17", "countyId": 18, "countyName": "sample string 19", "agencyId": 20, "agencyName": "sample string 21", "addedDate": "2025-05-20T15:52:41.6857636-05:00", "orderDate": "2025-05-20T15:52:41.6857636-05:00", "improvementId": 1, "userPropertyCaseId": 24, "clientCanView": true, "isSignatureRequired": true, "regenerationAllowed": true }, { "id": 1, "agencyCaseId": 1, "orderId": 2, "orderNumber": "sample string 3", "userId": 4, "userName": "sample string 5", "productBundleId": 6, "bundleName": "sample string 7", "productId": 8, "productName": "sample string 9", "documentId": 10, "documentName": "sample string 11", "description": "sample string 12", "appealYear": 13, "documentTemplateUri": "sample string 14", "documentUri": "sample string 15", "isReport": true, "previewImageUrl": "sample string 17", "countyId": 18, "countyName": "sample string 19", "agencyId": 20, "agencyName": "sample string 21", "addedDate": "2025-05-20T15:52:41.6857636-05:00", "orderDate": "2025-05-20T15:52:41.6857636-05:00", "improvementId": 1, "userPropertyCaseId": 24, "clientCanView": true, "isSignatureRequired": true, "regenerationAllowed": true } ], "secondaryProductBundleName": "sample string 16", "secondaryProductBundleId": 17, "secondaryPreviewImageUrl": "sample string 18", "agencyId": 19, "agencyName": "sample string 20" }, { "id": 1, "discountCode": "sample string 2", "taxYear": 3, "quantity": 4, "price": 5.0, "discountAmount": 6.0, "discountPercent": 7.0, "createdDate": "2025-05-20T15:52:41.6857636-05:00", "formattedPin": "sample string 9", "addressLine1": "sample string 10", "addressLastLine": "sample string 11", "productBundleName": "sample string 12", "productBundleId": 13, "previewImageUrl": "sample string 14", "propertyImageUrl": "sample string 15", "documents": [ { "id": 1, "agencyCaseId": 1, "orderId": 2, "orderNumber": "sample string 3", "userId": 4, "userName": "sample string 5", "productBundleId": 6, "bundleName": "sample string 7", "productId": 8, "productName": "sample string 9", "documentId": 10, "documentName": "sample string 11", "description": "sample string 12", "appealYear": 13, "documentTemplateUri": "sample string 14", "documentUri": "sample string 15", "isReport": true, "previewImageUrl": "sample string 17", "countyId": 18, "countyName": "sample string 19", "agencyId": 20, "agencyName": "sample string 21", "addedDate": "2025-05-20T15:52:41.6857636-05:00", "orderDate": "2025-05-20T15:52:41.6857636-05:00", "improvementId": 1, "userPropertyCaseId": 24, "clientCanView": true, "isSignatureRequired": true, "regenerationAllowed": true }, { "id": 1, "agencyCaseId": 1, "orderId": 2, "orderNumber": "sample string 3", "userId": 4, "userName": "sample string 5", "productBundleId": 6, "bundleName": "sample string 7", "productId": 8, "productName": "sample string 9", "documentId": 10, "documentName": "sample string 11", "description": "sample string 12", "appealYear": 13, "documentTemplateUri": "sample string 14", "documentUri": "sample string 15", "isReport": true, "previewImageUrl": "sample string 17", "countyId": 18, "countyName": "sample string 19", "agencyId": 20, "agencyName": "sample string 21", "addedDate": "2025-05-20T15:52:41.6857636-05:00", "orderDate": "2025-05-20T15:52:41.6857636-05:00", "improvementId": 1, "userPropertyCaseId": 24, "clientCanView": true, "isSignatureRequired": true, "regenerationAllowed": true } ], "secondaryProductBundleName": "sample string 16", "secondaryProductBundleId": 17, "secondaryPreviewImageUrl": "sample string 18", "agencyId": 19, "agencyName": "sample string 20" } ], "taxRate": 2.0, "amountCharged": 3.0, "totalAmount": 4.0, "orderNumber": "sample string 5", "paymentProviderToken": "sample string 6", "orderStatusId": 7, "orderStatus": "sample string 8", "termsOfUsePolicyId": 9, "orderDate": "2025-05-20T15:52:41.6857636-05:00", "totalDiscountAmount": 11.0, "currencyCode": "sample string 12", "providerChargeId": "sample string 13", "isBusinessUserClient": true, "agencyCaseId": 1, "userPropertyCaseId": 1, "isPaid": true }
text/html
Sample:
{"id":1,"userId":1,"items":[{"id":1,"discountCode":"sample string 2","taxYear":3,"quantity":4,"price":5.0,"discountAmount":6.0,"discountPercent":7.0,"createdDate":"2025-05-20T15:52:41.6857636-05:00","formattedPin":"sample string 9","addressLine1":"sample string 10","addressLastLine":"sample string 11","productBundleName":"sample string 12","productBundleId":13,"previewImageUrl":"sample string 14","propertyImageUrl":"sample string 15","documents":[{"id":1,"agencyCaseId":1,"orderId":2,"orderNumber":"sample string 3","userId":4,"userName":"sample string 5","productBundleId":6,"bundleName":"sample string 7","productId":8,"productName":"sample string 9","documentId":10,"documentName":"sample string 11","description":"sample string 12","appealYear":13,"documentTemplateUri":"sample string 14","documentUri":"sample string 15","isReport":true,"previewImageUrl":"sample string 17","countyId":18,"countyName":"sample string 19","agencyId":20,"agencyName":"sample string 21","addedDate":"2025-05-20T15:52:41.6857636-05:00","orderDate":"2025-05-20T15:52:41.6857636-05:00","improvementId":1,"userPropertyCaseId":24,"clientCanView":true,"isSignatureRequired":true,"regenerationAllowed":true},{"id":1,"agencyCaseId":1,"orderId":2,"orderNumber":"sample string 3","userId":4,"userName":"sample string 5","productBundleId":6,"bundleName":"sample string 7","productId":8,"productName":"sample string 9","documentId":10,"documentName":"sample string 11","description":"sample string 12","appealYear":13,"documentTemplateUri":"sample string 14","documentUri":"sample string 15","isReport":true,"previewImageUrl":"sample string 17","countyId":18,"countyName":"sample string 19","agencyId":20,"agencyName":"sample string 21","addedDate":"2025-05-20T15:52:41.6857636-05:00","orderDate":"2025-05-20T15:52:41.6857636-05:00","improvementId":1,"userPropertyCaseId":24,"clientCanView":true,"isSignatureRequired":true,"regenerationAllowed":true}],"secondaryProductBundleName":"sample string 16","secondaryProductBundleId":17,"secondaryPreviewImageUrl":"sample string 18","agencyId":19,"agencyName":"sample string 20"},{"id":1,"discountCode":"sample string 2","taxYear":3,"quantity":4,"price":5.0,"discountAmount":6.0,"discountPercent":7.0,"createdDate":"2025-05-20T15:52:41.6857636-05:00","formattedPin":"sample string 9","addressLine1":"sample string 10","addressLastLine":"sample string 11","productBundleName":"sample string 12","productBundleId":13,"previewImageUrl":"sample string 14","propertyImageUrl":"sample string 15","documents":[{"id":1,"agencyCaseId":1,"orderId":2,"orderNumber":"sample string 3","userId":4,"userName":"sample string 5","productBundleId":6,"bundleName":"sample string 7","productId":8,"productName":"sample string 9","documentId":10,"documentName":"sample string 11","description":"sample string 12","appealYear":13,"documentTemplateUri":"sample string 14","documentUri":"sample string 15","isReport":true,"previewImageUrl":"sample string 17","countyId":18,"countyName":"sample string 19","agencyId":20,"agencyName":"sample string 21","addedDate":"2025-05-20T15:52:41.6857636-05:00","orderDate":"2025-05-20T15:52:41.6857636-05:00","improvementId":1,"userPropertyCaseId":24,"clientCanView":true,"isSignatureRequired":true,"regenerationAllowed":true},{"id":1,"agencyCaseId":1,"orderId":2,"orderNumber":"sample string 3","userId":4,"userName":"sample string 5","productBundleId":6,"bundleName":"sample string 7","productId":8,"productName":"sample string 9","documentId":10,"documentName":"sample string 11","description":"sample string 12","appealYear":13,"documentTemplateUri":"sample string 14","documentUri":"sample string 15","isReport":true,"previewImageUrl":"sample string 17","countyId":18,"countyName":"sample string 19","agencyId":20,"agencyName":"sample string 21","addedDate":"2025-05-20T15:52:41.6857636-05:00","orderDate":"2025-05-20T15:52:41.6857636-05:00","improvementId":1,"userPropertyCaseId":24,"clientCanView":true,"isSignatureRequired":true,"regenerationAllowed":true}],"secondaryProductBundleName":"sample string 16","secondaryProductBundleId":17,"secondaryPreviewImageUrl":"sample string 18","agencyId":19,"agencyName":"sample string 20"}],"taxRate":2.0,"amountCharged":3.0,"totalAmount":4.0,"orderNumber":"sample string 5","paymentProviderToken":"sample string 6","orderStatusId":7,"orderStatus":"sample string 8","termsOfUsePolicyId":9,"orderDate":"2025-05-20T15:52:41.6857636-05:00","totalDiscountAmount":11.0,"currencyCode":"sample string 12","providerChargeId":"sample string 13","isBusinessUserClient":true,"agencyCaseId":1,"userPropertyCaseId":1,"isPaid":true}
application/xml, text/xml
Sample:
<OrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.OrderProcessing"> <AgencyCaseId>1</AgencyCaseId> <AmountCharged>3</AmountCharged> <CurrencyCode>sample string 12</CurrencyCode> <Id>1</Id> <IsBusinessUserClient>true</IsBusinessUserClient> <IsPaid>true</IsPaid> <Items> <OrderLineItemModel> <AddressLastLine>sample string 11</AddressLastLine> <AddressLine1>sample string 10</AddressLine1> <AgencyId>19</AgencyId> <AgencyName>sample string 20</AgencyName> <CreatedDate>2025-05-20T15:52:41.6857636-05:00</CreatedDate> <DiscountAmount>6</DiscountAmount> <DiscountCode>sample string 2</DiscountCode> <DiscountPercent>7</DiscountPercent> <Documents xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos.DocGen"> <d4p1:OrderDocumentModel> <d4p1:AddedDate>2025-05-20T15:52:41.6857636-05:00</d4p1:AddedDate> <d4p1:AgencyCaseId>1</d4p1:AgencyCaseId> <d4p1:AgencyId>20</d4p1:AgencyId> <d4p1:AgencyName>sample string 21</d4p1:AgencyName> <d4p1:AppealYear>13</d4p1:AppealYear> <d4p1:BundleName>sample string 7</d4p1:BundleName> <d4p1:ClientCanView>true</d4p1:ClientCanView> <d4p1:CountyId>18</d4p1:CountyId> <d4p1:CountyName>sample string 19</d4p1:CountyName> <d4p1:Description>sample string 12</d4p1:Description> <d4p1:DocumentId>10</d4p1:DocumentId> <d4p1:DocumentName>sample string 11</d4p1:DocumentName> <d4p1:DocumentTemplateUri>sample string 14</d4p1:DocumentTemplateUri> <d4p1:DocumentUri>sample string 15</d4p1:DocumentUri> <d4p1:Id>1</d4p1:Id> <d4p1:ImprovementId>1</d4p1:ImprovementId> <d4p1:IsReport>true</d4p1:IsReport> <d4p1:IsSignatureRequired>true</d4p1:IsSignatureRequired> <d4p1:OrderDate>2025-05-20T15:52:41.6857636-05:00</d4p1:OrderDate> <d4p1:OrderId>2</d4p1:OrderId> <d4p1:OrderNumber>sample string 3</d4p1:OrderNumber> <d4p1:PreviewImageUrl>sample string 17</d4p1:PreviewImageUrl> <d4p1:ProductBundleId>6</d4p1:ProductBundleId> <d4p1:ProductId>8</d4p1:ProductId> <d4p1:ProductName>sample string 9</d4p1:ProductName> <d4p1:RegenerationAllowed>true</d4p1:RegenerationAllowed> <d4p1:UserId>4</d4p1:UserId> <d4p1:UserName>sample string 5</d4p1:UserName> <d4p1:UserPropertyCaseId>24</d4p1:UserPropertyCaseId> </d4p1:OrderDocumentModel> <d4p1:OrderDocumentModel> <d4p1:AddedDate>2025-05-20T15:52:41.6857636-05:00</d4p1:AddedDate> <d4p1:AgencyCaseId>1</d4p1:AgencyCaseId> <d4p1:AgencyId>20</d4p1:AgencyId> <d4p1:AgencyName>sample string 21</d4p1:AgencyName> <d4p1:AppealYear>13</d4p1:AppealYear> <d4p1:BundleName>sample string 7</d4p1:BundleName> <d4p1:ClientCanView>true</d4p1:ClientCanView> <d4p1:CountyId>18</d4p1:CountyId> <d4p1:CountyName>sample string 19</d4p1:CountyName> <d4p1:Description>sample string 12</d4p1:Description> <d4p1:DocumentId>10</d4p1:DocumentId> <d4p1:DocumentName>sample string 11</d4p1:DocumentName> <d4p1:DocumentTemplateUri>sample string 14</d4p1:DocumentTemplateUri> <d4p1:DocumentUri>sample string 15</d4p1:DocumentUri> <d4p1:Id>1</d4p1:Id> <d4p1:ImprovementId>1</d4p1:ImprovementId> <d4p1:IsReport>true</d4p1:IsReport> <d4p1:IsSignatureRequired>true</d4p1:IsSignatureRequired> <d4p1:OrderDate>2025-05-20T15:52:41.6857636-05:00</d4p1:OrderDate> <d4p1:OrderId>2</d4p1:OrderId> <d4p1:OrderNumber>sample string 3</d4p1:OrderNumber> <d4p1:PreviewImageUrl>sample string 17</d4p1:PreviewImageUrl> <d4p1:ProductBundleId>6</d4p1:ProductBundleId> <d4p1:ProductId>8</d4p1:ProductId> <d4p1:ProductName>sample string 9</d4p1:ProductName> <d4p1:RegenerationAllowed>true</d4p1:RegenerationAllowed> <d4p1:UserId>4</d4p1:UserId> <d4p1:UserName>sample string 5</d4p1:UserName> <d4p1:UserPropertyCaseId>24</d4p1:UserPropertyCaseId> </d4p1:OrderDocumentModel> </Documents> <FormattedPin>sample string 9</FormattedPin> <Id>1</Id> <PreviewImageUrl>sample string 14</PreviewImageUrl> <Price>5</Price> <ProductBundleId>13</ProductBundleId> <ProductBundleName>sample string 12</ProductBundleName> <PropertyImageUrl>sample string 15</PropertyImageUrl> <Quantity>4</Quantity> <SecondaryPreviewImageUrl>sample string 18</SecondaryPreviewImageUrl> <SecondaryProductBundleId>17</SecondaryProductBundleId> <SecondaryProductBundleName>sample string 16</SecondaryProductBundleName> <TaxYear>3</TaxYear> </OrderLineItemModel> <OrderLineItemModel> <AddressLastLine>sample string 11</AddressLastLine> <AddressLine1>sample string 10</AddressLine1> <AgencyId>19</AgencyId> <AgencyName>sample string 20</AgencyName> <CreatedDate>2025-05-20T15:52:41.6857636-05:00</CreatedDate> <DiscountAmount>6</DiscountAmount> <DiscountCode>sample string 2</DiscountCode> <DiscountPercent>7</DiscountPercent> <Documents xmlns:d4p1="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos.DocGen"> <d4p1:OrderDocumentModel> <d4p1:AddedDate>2025-05-20T15:52:41.6857636-05:00</d4p1:AddedDate> <d4p1:AgencyCaseId>1</d4p1:AgencyCaseId> <d4p1:AgencyId>20</d4p1:AgencyId> <d4p1:AgencyName>sample string 21</d4p1:AgencyName> <d4p1:AppealYear>13</d4p1:AppealYear> <d4p1:BundleName>sample string 7</d4p1:BundleName> <d4p1:ClientCanView>true</d4p1:ClientCanView> <d4p1:CountyId>18</d4p1:CountyId> <d4p1:CountyName>sample string 19</d4p1:CountyName> <d4p1:Description>sample string 12</d4p1:Description> <d4p1:DocumentId>10</d4p1:DocumentId> <d4p1:DocumentName>sample string 11</d4p1:DocumentName> <d4p1:DocumentTemplateUri>sample string 14</d4p1:DocumentTemplateUri> <d4p1:DocumentUri>sample string 15</d4p1:DocumentUri> <d4p1:Id>1</d4p1:Id> <d4p1:ImprovementId>1</d4p1:ImprovementId> <d4p1:IsReport>true</d4p1:IsReport> <d4p1:IsSignatureRequired>true</d4p1:IsSignatureRequired> <d4p1:OrderDate>2025-05-20T15:52:41.6857636-05:00</d4p1:OrderDate> <d4p1:OrderId>2</d4p1:OrderId> <d4p1:OrderNumber>sample string 3</d4p1:OrderNumber> <d4p1:PreviewImageUrl>sample string 17</d4p1:PreviewImageUrl> <d4p1:ProductBundleId>6</d4p1:ProductBundleId> <d4p1:ProductId>8</d4p1:ProductId> <d4p1:ProductName>sample string 9</d4p1:ProductName> <d4p1:RegenerationAllowed>true</d4p1:RegenerationAllowed> <d4p1:UserId>4</d4p1:UserId> <d4p1:UserName>sample string 5</d4p1:UserName> <d4p1:UserPropertyCaseId>24</d4p1:UserPropertyCaseId> </d4p1:OrderDocumentModel> <d4p1:OrderDocumentModel> <d4p1:AddedDate>2025-05-20T15:52:41.6857636-05:00</d4p1:AddedDate> <d4p1:AgencyCaseId>1</d4p1:AgencyCaseId> <d4p1:AgencyId>20</d4p1:AgencyId> <d4p1:AgencyName>sample string 21</d4p1:AgencyName> <d4p1:AppealYear>13</d4p1:AppealYear> <d4p1:BundleName>sample string 7</d4p1:BundleName> <d4p1:ClientCanView>true</d4p1:ClientCanView> <d4p1:CountyId>18</d4p1:CountyId> <d4p1:CountyName>sample string 19</d4p1:CountyName> <d4p1:Description>sample string 12</d4p1:Description> <d4p1:DocumentId>10</d4p1:DocumentId> <d4p1:DocumentName>sample string 11</d4p1:DocumentName> <d4p1:DocumentTemplateUri>sample string 14</d4p1:DocumentTemplateUri> <d4p1:DocumentUri>sample string 15</d4p1:DocumentUri> <d4p1:Id>1</d4p1:Id> <d4p1:ImprovementId>1</d4p1:ImprovementId> <d4p1:IsReport>true</d4p1:IsReport> <d4p1:IsSignatureRequired>true</d4p1:IsSignatureRequired> <d4p1:OrderDate>2025-05-20T15:52:41.6857636-05:00</d4p1:OrderDate> <d4p1:OrderId>2</d4p1:OrderId> <d4p1:OrderNumber>sample string 3</d4p1:OrderNumber> <d4p1:PreviewImageUrl>sample string 17</d4p1:PreviewImageUrl> <d4p1:ProductBundleId>6</d4p1:ProductBundleId> <d4p1:ProductId>8</d4p1:ProductId> <d4p1:ProductName>sample string 9</d4p1:ProductName> <d4p1:RegenerationAllowed>true</d4p1:RegenerationAllowed> <d4p1:UserId>4</d4p1:UserId> <d4p1:UserName>sample string 5</d4p1:UserName> <d4p1:UserPropertyCaseId>24</d4p1:UserPropertyCaseId> </d4p1:OrderDocumentModel> </Documents> <FormattedPin>sample string 9</FormattedPin> <Id>1</Id> <PreviewImageUrl>sample string 14</PreviewImageUrl> <Price>5</Price> <ProductBundleId>13</ProductBundleId> <ProductBundleName>sample string 12</ProductBundleName> <PropertyImageUrl>sample string 15</PropertyImageUrl> <Quantity>4</Quantity> <SecondaryPreviewImageUrl>sample string 18</SecondaryPreviewImageUrl> <SecondaryProductBundleId>17</SecondaryProductBundleId> <SecondaryProductBundleName>sample string 16</SecondaryProductBundleName> <TaxYear>3</TaxYear> </OrderLineItemModel> </Items> <OrderDate>2025-05-20T15:52:41.6857636-05:00</OrderDate> <OrderNumber>sample string 5</OrderNumber> <OrderStatus>sample string 8</OrderStatus> <OrderStatusId>7</OrderStatusId> <PaymentProviderToken>sample string 6</PaymentProviderToken> <ProviderChargeId>sample string 13</ProviderChargeId> <TaxRate>2</TaxRate> <TermsOfUsePolicyId>9</TermsOfUsePolicyId> <TotalAmount>4</TotalAmount> <TotalDiscountAmount>11</TotalDiscountAmount> <UserId>1</UserId> <UserPropertyCaseId>1</UserPropertyCaseId> </OrderModel>