Http API: GetDeliveryOptions
This article describes the GetDeliveryOptions API call.
GetDeliveryOptions
URI | /GetDeliveryOptions |
URL Structure | https://host/api/Order/GetDeliveryOptions |
HTTP Method | POST/GetDeliveryOptions |
Default format | JSON |
Description | Signifikant will call the GetDeliveryOptions function when user arrives at order page. It may be called at login if configured. Call will contain user and customer information, as well as complete order information to handle the case that order content effects delivery options. |
JSON structure sample
RequestUri
https://host/API/Order/GetDeliveryOptions?UserName=sign&UserId=signRequest/Response
{
"Id": "0",
"UserId": "2",
"SalesOrigin": null,
"Number": null,
"CompanyInternalOrderNumber": null,
"Title": null,
"Description": null,
"OrderLines": [
{
"LineId": "fd243cf6-d8e3-4354-af10-cf11812cc812",
"Part": {
"Identifier": false,
"Id": null,
"PartNumber": "184452",
"PersistentIdentity": null,
"Name": {
"ResolveMode": 1,
"Value": "Disc",
"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": 1.0,
"QuantityDelivered": null,
"QuantityUnit": null,
"Note": null,
"UnitPrice": 1312.9614,
"TotalPrice": 1312.9614,
"PriceInformations": [
{
"Hidden": false,
"Code": "BRUTTOPRICE",
"Description": null,
"ValueFormat": null,
"Value": 1620.94,
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
},
{
"Hidden": false,
"Code": "ABSOLUTEDISCOUNT",
"Description": null,
"ValueFormat": "Discount {0:C}",
"Value": 307.9786,
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
},
{
"Hidden": false,
"Code": "DISCOUNT",
"Description": {
"ResolveMode": 1,
"Value": null,
"Key": "Discount",
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"ValueFormat": "{0:0.##}%",
"Value": 19.0,
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
}
],
"TotalPriceInformations": [
{
"Hidden": false,
"Code": "SECIAL",
"Description": {
"ResolveMode": 1,
"Value": "Special price",
"Key": null,
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"ValueFormat": null,
"Value": null,
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
}
],
"Reference": null,
"Context": null,
"Availabiliy": null,
"StatusCode": "",
"Message": null,
"HtmlMessage": {
"ResolveMode": 1,
"Value": null,
"Key": null,
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"Properties": []
}
],
"OrderShipmentDetail": [],
"CreatedOn": "0001-01-01T00:00:00",
"PlacedDate": null,
"OrderStatus": null,
"OrderType": null,
"SubTotalPrice": 1312.9614,
"TotalPrice": 1362.9614,
"TotalQuantity": 1.0,
"Currency": null,
"ShippingAddress": {
"Id": "1084866395",
"Name": null,
"IsTemporary": null,
"Addressee": null,
"IsDefault": false,
"StreetAddress1": "SA1.11084866395",
"StreetAddress2": "SA1.21084866395",
"StreetAddress3": "SA1.31084866395",
"State": "ABARA",
"ZipCode": "123456",
"City": "Stockholm",
"Country": "SE",
"AddressType": null,
"ReferenceId": "1084866395",
"RefernceType": null,
"ReferencePersistentIdentity": "1084866395",
"Properties": []
},
"BillingAddress": null,
"DeliveryOption": null,
"ReferencePerson": "Demo Demo",
"ReferencePhoneNumber": null,
"ConfirmationEmail": "info@signifikant.se",
"Note": null,
"PriceInformations": [
{
"Hidden": false,
"Code": "SHIP",
"Description": {
"ResolveMode": 1,
"Value": null,
"Key": "Shippment",
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"ValueFormat": null,
"Value": 50.0,
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
}
],
"CustomerNumber": null,
"BillingAddressModifiedByCurrentUser": false,
"ShippingAddressModifiedByCurrentUser": false,
"StatusCode": "Ok",
"Message": null,
"HtmlMessage": null,
"Properties": []
}Response
{
"Options": [
{
"Id": "STD",
"Description": {
"ResolveMode": 1,
"Value": "Standard",
"Key": null,
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"Available": true,
"EstimatedDeliveryTime": null,
"EstimatedDeliveryTimeSpan": null,
"DeliveryTimeText": null,
"Permissions": [],
"PermissionGroups": [],
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
},
{
"Id": "OWN",
"Description": {
"ResolveMode": 1,
"Value": "Own",
"Key": null,
"Id": null,
"PersistentIdentity": null,
"Translations": null,
"HtmlEncode": false
},
"Available": true,
"EstimatedDeliveryTime": null,
"EstimatedDeliveryTimeSpan": null,
"DeliveryTimeText": null,
"Permissions": [
"TemporaryShippingAddress",
"TemporaryBillingAddress"
],
"PermissionGroups": [],
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
}
],
"StatusCode": "",
"Message": null,
"HtmlMessage": null,
"Properties": []
}Configuration
Configuration is done in profile.config