Http API: GetOrderDetails
This article describes the GetOrderDetails API call.
GetOrderDetails
URI | /GetOrderDetails |
URL Structure | https://host/api/Order/GetOrderDetails |
HTTP Method | GET/GetOrderDetails |
Default format | JSON |
Description | Signifikant will call the GetOrderDetails function when user clicks on an order in order history to navigate into the actual order. |
JSON structure sample
RequestUri
https://host/API/Order/GetOrderDetail?orderNumber=PO-30&UserName=sign&UserId=sign&cultureCode=en-GBResponse
{
"Order": {
"Id": null,
"UserId": null,
"SalesOrigin": null,
"Number": "PO-30",
"CompanyInternalOrderNumber": null,
"Title": "Order Detail-824",
"Description": null,
"OrderLines": [
{
"LineId": "1",
"Part": {
"Identifier": false,
"Id": null,
"PartNumber": "SIG 1",
"PersistentIdentity": null,
"Name": {
"ResolveMode": 1,
"Value": "Part-1",
"Key": null,
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"Description": null,
"SupplierPartNumber": null,
"Brand": null,
"IsKit": false,
"QuantityUnit": null,
"Properties": []
},
"Replacement": null,
"ReplacedPart": null,
"Quantity": 4.0,
"QuantityDelivered": 4.0,
"QuantityUnit": {
"ResolveMode": 1,
"Value": "4",
"Key": null,
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"Note": null,
"UnitPrice": 63.0,
"TotalPrice": 331.0,
"PriceInformations": [],
"TotalPriceInformations": [],
"Reference": null,
"Context": null,
"Availabiliy": null,
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
},
{
"LineId": "2",
"Part": {
"Identifier": false,
"Id": null,
"PartNumber": "SIG 2",
"PersistentIdentity": null,
"Name": {
"ResolveMode": 1,
"Value": "Part-2",
"Key": null,
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"Description": null,
"SupplierPartNumber": null,
"Brand": null,
"IsKit": false,
"QuantityUnit": null,
"Properties": []
},
"Replacement": null,
"ReplacedPart": null,
"Quantity": 4.0,
"QuantityDelivered": 4.0,
"QuantityUnit": {
"ResolveMode": 1,
"Value": "4",
"Key": null,
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"Note": null,
"UnitPrice": 63.0,
"TotalPrice": 331.0,
"PriceInformations": [],
"TotalPriceInformations": [],
"Reference": null,
"Context": null,
"Availabiliy": null,
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
},
{
"LineId": "3",
"Part": {
"Identifier": false,
"Id": null,
"PartNumber": "SIG 3",
"PersistentIdentity": null,
"Name": {
"ResolveMode": 1,
"Value": "Part-3",
"Key": null,
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"Description": null,
"SupplierPartNumber": null,
"Brand": null,
"IsKit": false,
"QuantityUnit": null,
"Properties": []
},
"Replacement": null,
"ReplacedPart": null,
"Quantity": 4.0,
"QuantityDelivered": 4.0,
"QuantityUnit": {
"ResolveMode": 1,
"Value": "4",
"Key": null,
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"Note": null,
"UnitPrice": 63.0,
"TotalPrice": 331.0,
"PriceInformations": [],
"TotalPriceInformations": [],
"Reference": null,
"Context": null,
"Availabiliy": null,
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
}
],
"OrderShipmentDetail": [
{
"ShipmentDate": "2020-02-14T13:45:57.3645741+01:00",
"ShipmentMethod": "LMN",
"TrackingNumber": "trace6",
"ShipmentName": "ABC",
"Forwarder": "XYZ",
"PackingSlipId": "PS-SE11000001",
"ShippingCarrierCompanyUrl": "http://www.signifikant.se",
"OrderShipmentLines": [
{
"PartNumber": "105310193",
"PartName": "XYBN",
"Qty": 1.0,
"TrackingNumber": null,
"ShippingCarrierCompanyUrl": null,
"QtyDelivered": 1.0,
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
}
],
"ShippingCarrierCompany": [],
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
}
],
"CreatedOn": "0001-01-01T00:00:00",
"PlacedDate": "2020-02-14T00:00:00+01:00",
"OrderStatus": "Placed",
"OrderType": "Dag",
"SubTotalPrice": null,
"TotalPrice": 824.0,
"TotalQuantity": null,
"Currency": "SEK",
"ShippingAddress": {
"Id": null,
"Name": null,
"IsTemporary": null,
"Addressee": "Mattias",
"IsDefault": false,
"StreetAddress1": "Shipping-Abra-824",
"StreetAddress2": null,
"StreetAddress3": null,
"State": null,
"ZipCode": "400607",
"City": "Stockholm",
"Country": "SE",
"AddressType": null,
"ReferenceId": null,
"RefernceType": null,
"ReferencePersistentIdentity": null,
"Properties": []
},
"BillingAddress": {
"Id": null,
"Name": null,
"IsTemporary": null,
"Addressee": "Kenneth",
"IsDefault": false,
"StreetAddress1": "Billing-Abra-824",
"StreetAddress2": null,
"StreetAddress3": null,
"State": null,
"ZipCode": "400607",
"City": "Mumbai",
"Country": "IN",
"AddressType": null,
"ReferenceId": null,
"RefernceType": null,
"ReferencePersistentIdentity": null,
"Properties": []
},
"DeliveryOption": null,
"ReferencePerson": "Abra-824",
"ReferencePhoneNumber": null,
"ConfirmationEmail": null,
"Note": null,
"PriceInformations": [],
"CustomerNumber": null,
"BillingAddressModifiedByCurrentUser": false,
"ShippingAddressModifiedByCurrentUser": false,
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
},
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
}Configuration
Configuration is done in profile.config
<OrderDetailProvider>
<RESTOrderDetailProvider delete-old-trace-log-after-number-of-folder="30" trace-folder="D:\Temp\Trace-logs\" url="https://host/API/" />
</OrderDetailProvider>