Order Detail
Request Parameters:
Retrieve the order detail by customer and order identifier.
URL ../Api/Client/GetOrderDetail
Header:
Content-Type:application/json
Required Parameters :
Case-1. Exception Response :
Parameter :
{
"ApiSecretKey":"i99b98d117m116a112o98k115c111",
"CustomerGUID":"B0B93485-CBB2-40DC-AB06-7D98583AA404",
"LanguageId":"1",
"OrderId":"10"
}
Response :
{
"Status": 0,
"Message": "Order not found",
"Data": null,
"ValidationMessage": [],
"ErrorMessage": null
}
Exception-2 :
Parameter:
{
"ApiSecretKey":"i99b98d117m116a112o98k115c111",
"CustomerGUID":"B0B93485-CBB2-40DC-AB06-7D98583AA411",
"LanguageId":"1",
"OrderId":"10"
}
Response :
{
"Status": 0,
"Message": "No customer found with id b0b93485-cbb2-40dc-ab06-7d98583aa411",
"Data": null,
"ValidationMessage": [],
"ErrorMessage": null
}
Case-2. Success Response :
Parameter:
{
"ApiSecretKey":"e108y110o106r113e99c102t109o105",
"CustomerGUID":"A22D997F-3D87-4FD1-8D41-22915F1A386F",
"LanguageId":"1",
"OrderId":"1"
}
Response :
{
"Status": 1,
"Message": "Success.",
"Data": {
"Items": [
{
"ProductType": "Simple",
"OrderItemGuid": "277bb08a-e1d2-4e63-84f7-0e1cad696271",
"Sku": "RB_AVR_SG",
"ProductId": 33,
"ProductName": "Ray Ban Aviator Sunglasses",
"ProductSeName": "ray-ban-aviator-sunglasses",
"UnitPrice": "$25.00",
"SubTotal": "$25.00",
"Quantity": 1,
"AttributeInfo": "",
"RentalInfo": null,
"VendorName": "",
"DownloadId": 0,
"LicenseId": 0,
"Id": 13,
"CustomProperties": {}
}
],
"PrintMode": false,
"PdfInvoiceDisabled": false,
"CustomOrderNumber": "6",
"CreatedOn": "2021-05-07T16:24:41",
"OrderStatus": "Processing",
"IsReOrderAllowed": true,
"IsReturnRequestAllowed": false,
"IsShippable": true,
"PickupInStore": false,
"PickupAddress": {
"FirstName": null,
"LastName": null,
"Email": null,
"CompanyEnabled": false,
"CompanyRequired": false,
"Company": null,
"CountryEnabled": false,
"CountryId": null,
"CountryName": null,
"StateProvinceEnabled": false,
"StateProvinceId": null,
"StateProvinceName": null,
"CountyEnabled": false,
"CountyRequired": false,
"County": null,
"CityEnabled": false,
"CityRequired": false,
"City": null,
"StreetAddressEnabled": false,
"StreetAddressRequired": false,
"Address1": null,
"StreetAddress2Enabled": false,
"StreetAddress2Required": false,
"Address2": null,
"ZipPostalCodeEnabled": false,
"ZipPostalCodeRequired": false,
"ZipPostalCode": null,
"PhoneEnabled": false,
"PhoneRequired": false,
"PhoneNumber": null,
"FaxEnabled": false,
"FaxRequired": false,
"FaxNumber": null,
"AvailableCountries": [],
"AvailableStates": [],
"FormattedCustomAddressAttributes": null,
"CustomAddressAttributes": [],
"Id": 0,
"CustomProperties": {}
},
"ShippingStatus": "Delivered",
"ShippingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Email": "admin@yourStore.com",
"CompanyEnabled": true,
"CompanyRequired": false,
"Company": "Nop Solutions Ltd",
"CountryEnabled": true,
"CountryId": 237,
"CountryName": "United States of America",
"StateProvinceEnabled": true,
"StateProvinceId": 1709,
"StateProvinceName": "New York",
"CountyEnabled": false,
"CountyRequired": false,
"County": null,
"CityEnabled": true,
"CityRequired": true,
"City": "New York",
"StreetAddressEnabled": true,
"StreetAddressRequired": true,
"Address1": "21 West 52nd Street",
"StreetAddress2Enabled": true,
"StreetAddress2Required": false,
"Address2": "",
"ZipPostalCodeEnabled": true,
"ZipPostalCodeRequired": true,
"ZipPostalCode": "10021",
"PhoneEnabled": true,
"PhoneRequired": true,
"PhoneNumber": "12345678",
"FaxEnabled": true,
"FaxRequired": false,
"FaxNumber": "",
"AvailableCountries": [],
"AvailableStates": [],
"FormattedCustomAddressAttributes": "",
"CustomAddressAttributes": [],
"Id": 23,
"CustomProperties": {}
},
"ShippingMethod": "Ground",
"Shipments": [
{
"TrackingNumber": "456",
"ShippedDate": "2021-05-07T16:25:40",
"DeliveryDate": "2021-05-07T16:32:40",
"Id": 4,
"CustomProperties": {}
}
],
"BillingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Email": "admin@yourStore.com",
"CompanyEnabled": true,
"CompanyRequired": false,
"Company": "Nop Solutions Ltd",
"CountryEnabled": true,
"CountryId": 237,
"CountryName": "United States of America",
"StateProvinceEnabled": true,
"StateProvinceId": 1709,
"StateProvinceName": "New York",
"CountyEnabled": false,
"CountyRequired": false,
"County": null,
"CityEnabled": true,
"CityRequired": true,
"City": "New York",
"StreetAddressEnabled": true,
"StreetAddressRequired": true,
"Address1": "21 West 52nd Street",
"StreetAddress2Enabled": true,
"StreetAddress2Required": false,
"Address2": "",
"ZipPostalCodeEnabled": true,
"ZipPostalCodeRequired": true,
"ZipPostalCode": "10021",
"PhoneEnabled": true,
"PhoneRequired": true,
"PhoneNumber": "12345678",
"FaxEnabled": true,
"FaxRequired": false,
"FaxNumber": "",
"AvailableCountries": [],
"AvailableStates": [],
"FormattedCustomAddressAttributes": "",
"CustomAddressAttributes": [],
"Id": 22,
"CustomProperties": {}
},
"VatNumber": null,
"PaymentMethod": "Check / Money Order",
"PaymentMethodStatus": "Pending",
"CanRePostProcessPayment": false,
"CustomValues": {},
"OrderSubtotal": "$25.00",
"OrderSubTotalDiscount": null,
"OrderShipping": "$0.00",
"PaymentMethodAdditionalFee": null,
"CheckoutAttributeInfo": "Gift wrapping: No",
"PricesIncludeTax": false,
"DisplayTaxShippingInfo": false,
"Tax": "$0.00",
"TaxRates": [
{
"Rate": "0",
"Value": "$0.00",
"CustomProperties": {}
}
],
"DisplayTax": true,
"DisplayTaxRates": false,
"OrderTotalDiscount": null,
"RedeemedRewardPoints": 0,
"RedeemedRewardPointsAmount": null,
"OrderTotal": "$25.00",
"GiftCards": [],
"ShowSku": true,
"OrderNotes": [],
"ShowVendorName": false,
"Id": 6,
"CustomProperties": {}
},
"ValidationMessage": [],
"ErrorMessage": null
}