Fenix Delivery Estimate API

Application Programming Interface (API)

Intelligent Delivery Platform API with Fenix Commerce default weights and dimension

Intelligent Delivery Platform API request when Customer inventory is not integrated with Fenix commerce and dimensions and weight are not provided by the retailer.
Request Details :

API: https://delest-v3.preprod.fenixcommerce.com/fenixdelest/api/v2/deliveryestimates
Protocol: HTTPS
Method: POST
Headers
- tenantId : 768b656c974245d2a427abe356bb4bf1
- Content-Type: application/json

Request Body:

{
	"sessionTrackId": "{{$guid}}",
	"buyerZipCode": "95129",
	"monetaryValue": 45,
	"pageType": "PDP",
	"responseFormat": "json",
	"skus": [{
		"quantity": 1,
		"sku": "16500",
		"skuInventories": [{
			"locationId": "600",
			"quantity": 10
		}]
	}, {
		"quantity": 1,
		"sku": "12149",
		"skuInventories": [{
			"locationId": "528",
			"quantity": 10
		}]
	}]
}

Intelligent Delivery Platform API with Weights and Dimension

Intelligent Delivery Platform API request when Customer inventory is integrated with Fenix commerce and dimensions and weight are provided by the retailer as part of request body.
Request Details:

API: https://delest-v3.preprod.fenixcommerce.com/fenixdelest/api/v2/deliveryestimates
Protocol: HTTPS
Method: POST
Headers
- tenantId : 768b656c974245d2a427abe356bb4bf1
- Content-Type: application/json

Request Body:

{
	"sessionTrackId": "{{$guid}}",
	"buyerZipCode": "10001",
	"monetaryValue": 45,
	"pageType": "pdp",
	"responseFormat": "json",
	"skus": [{
		"dimensions": {
			"girth": 10,
			"height": 10,
			"length": 10,
			"units": "CM",
			"width": 10
		},
		"quantity": 1,
		"sku": "16500",
		"weight": {
			"units": "LB",
			"value": 10
		},
		"skuInventories": [{
			"locationId": "600",
			"quantity": 10
		}, {
			"locationId": "528",
			"quantity": 10
		}]
	}, {
		"dimensions": {
			"girth": 10,
			"height": 10,
			"length": 10,
			"units": "CM",
			"width": 10
		},
		"quantity": 1,
		"sku": "12149",
		"weight": {
			"units": "LB",
			"value": 10
		},
		"skuInventories": [{
			"locationId": "L3",
			"quantity": 10
		}, {
			"locationId": "L4",
			"quantity": 10
		}]
	}]
}

Intelligent Delivery Platform API with Inventory Integration

Intelligent Delivery Platform API request when Customer inventory is integrated with Fenix commerce.
Request Details:

API: https://delest-v3.preprod.fenixcommerce.com/fenixdelest/api/v2/deliveryestimates
Protocol: HTTPS
Method: POST
Headers
- tenantId : 768b656c974245d2a427abe356bb4bf1
- Content-Type: application/json

Request Body:

{
	"sessionTrackId": "{{$guid}}",
	"buyerZipCode": "95129",
	"moneytoryValue": 10,
	"pageType": "PDP",
	"skus": [{
		"quantity": 1,
		"sku": "16500"
	}, {
		"quantity": 1,
		"sku": "12149"
	}]
}

Attribute	Values/Details	Description
buyerZipCode	Datatype: String Example value: “94016” Required: Yes	Zip code of retail customer. If the buyer lives in New York City and wants to deliver the product to Massachusetts, then you need to pass 01001 as buyerZipcode.
moneytoryValue	Datatype: int Example: 10 Required: yes (optional)	Set the value of the product
PageType	Datatype: String Example: PDP Required: yes	Page Type refer to in which page the delivery estimate services is integrated .The above services will be invoked from multiple pages in Ecommerce like PDP, COP etc. Please find the Valid Pages. Value Description ● PDP Product Detail Page ● COP Check out Page ● MC Mini Cart ● OC Order Confirmation ● SC Shipping Confirmation Send Values as part delivery estimate request
skus	Datatype: List Required: yes	Pass the list of sku items. Minimum of one sku item is required. When you call the Intelligent Delivery Platform from PDP page you will pass only one SKU item.
quantity	Datatype: int Required: yes	Pass the sku quantity. Delivery estimated differ based on the weight. Kindly provide actual quantity requested by the buyer.
sku	Datatype: String Required: yes (Mandatory)	Pass the sku id of the item.
tenantId	Datatype: String Required: yes (Mandatory)	Pass the Actual Tenantid provided by Fenix commerce Inc. In case of any quires or looking for a product trial please contact Fenix commerce Inc. support team.
sessionTrackId	DataType: String Required: yes	This refers to browser session to track the user behavior during the navigation in retailers website
responseFormat	DataType: String Required: yes	The attribute provide the desired delivery estimate response format. Allowed formats are “Json” and “binary”. The Default response format is json.

Response Details
Intelligent Delivery Platform response vary from the type of rule that has been set in business console.

Attributes	Value/Details	Description
hours	Datatype: String	Delivery estimate hours
webId	Datatype: String	Webid is a input sku id . When multiple items are sent as part of request then webid helps to find the delivery estimate of a particular sku
minutes	Datatype: String	Delivery estimate Minutes
carrier	Datatype: String	Name of the Carrier like Fenix, UPS, USPS
response	Datatype: String	Formatted Text Response
shippingCost	Datatype: Object
amount	Datatype: Float	Total shipping cost.
currency	Datatype: String	Currency Code (USD)
shipperLocID	Datatype: String	Distribution Centre/warehouse/store name/ID
ShipperZipCode	Datatype: String	Shipment origin zipcode like Distribution Centre/warehouse/store name
Shipping Method	Datatype: String	Carrier service name like ground, 1day, 2day
Guaranteed Delivery Date	Datatype: String	Final delivery date of the shipment (format: Thu, 30 Nov 2017)
Shipping Delivery Date	Datatype: String	Shipment delivery date of the shipment (format: Thu, 30 Nov 2017).In Case of data range from and to date is separated by – Example (Mon, 27 Nov 2017-Thu, 30 Nov 2017)
Packages	Datatype: Object	If package module is enabled, then able to see the details of package like box length width height etc. For more details contact core-engineering@fenixcommerce.com
Promotions	Datatype: Object	If promotional shipping module is enabled, then able to see the promotional ship cost details. For more details contact core-engineering@fenixcommerce.com

Note: If your facing issues or having difficulty during the integration process, please feel free to contact fenixcommerce inc technical team @ core-engineering@fenixcommerce.com

Intelligent Delivery Platform for all services

All the below examples are show with multi items with default Fenix commerce dimensions API
Shipping charges will vary based on weight and dimensions
The tenant id used in below document is a dummy id. For a valid tenant id please get in touch with sales team info@fenixcommerce.com or core-engineering@fenixcommerce.com

SHOW FASTEST

Set the desired page type as fastest in under Intelligent Delivery Platform for all services. Fenix Commerce will provide the fastest delivery estimate

Show Fastest: PDP
Delivery Options: Delivery Date
Headers
- tenantId : 768b656c974245d2a427abe356bb4bf1
- Content-Type: application/json

Request Body:

{
	"sessionTrackId": "{{$guid}}",
	"buyerZipCode": "95129",
	"monetaryValue": 45,
	"pageType": "PDP",
	"responseFormat": "json",
	"skus": [{
		"quantity": 1,
		"sku": "16500",
		"skuInventories": [{
			"locationId": "600",
			"quantity": 10
		}]
	}, {
		"quantity": 1,
		"sku": "12149",
		"skuInventories": [{
			"locationId": "528",
			"quantity": 10
		}]
	}]
}

Response Body:

[{
	"webId": "16500",
	"hours": "14",
	"minutes": "47",
	"carrier": "FEDEX",
	"response": "Order with in next 14 hours 47 minutes to get it by Wed, 24 Jan 2018.",
	"shippingCost": {
		"amount": 99.79,
		"currency": "USD"
	},
	"shipperLocId": "600",
	"shipperZipCode": "089508",
	"shippingMethod": "STANDARD_OVERNIGHT",
	"shippingMethodDesc": "STANDARD_OVERNIGHT",
	"guaranteedDeliveryDate": "Wed, 24 Jan 2018",
	"errorMessage": null,
	"packages": null,
	"promotions": null,
	"shippingDeliveryDate": "Wed, 24 Jan 2018"
}, {
	"webId": "12149",
	"hours": "14",
	"minutes": "47",
	"carrier": "FEDEX",
	"response": "Order with in next 14 hours 47 minutes to get it by Wed, 24 Jan 2018.",
	"shippingCost": {
		"amount": 39.69,
		"currency": "USD"
	},
	"shipperLocId": "528",
	"shipperZipCode": "91752",
	"shippingMethod": "STANDARD_OVERNIGHT",
	"shippingMethodDesc": "STANDARD_OVERNIGHT",
	"guaranteedDeliveryDate": "Wed, 24 Jan 2018",
	"errorMessage": null,
	"packages": null,
	"promotions": null,
	"shippingDeliveryDate": "Wed, 24 Jan 2018"
}]

SHOW CHEAPEST

Show Cheapest: minicart
Delivery Options: Delivery Date
Headers
- tenantId : 768b656c974245d2a427abe356bb4bf1
- Content-Type: application/json

Request Body:

{
	"sessionTrackId": "{{$guid}}",
	"buyerZipCode": "95129",
	"monetaryValue": 45,
	"pageType": "MC",
	"responseFormat": "json",
	"skus": [{
		"quantity": 1,
		"sku": "16500",
		"skuInventories": [{
			"locationId": "600",
			"quantity": 10
		}]
	}, {
		"quantity": 1,
		"sku": "12149",
		"skuInventories": [{
			"locationId": "528",
			"quantity": 10
		}]
	}]
}

Response Body:

[{
	"webId": "16500",
	"hours": "18",
	"minutes": "19",
	"carrier": "FEDEX",
	"response": "Order with in next 18 hours 19 minutes to get it by Tue, 30 Jan 2018.",
	"shippingCost": {
		"amount": 13.76,
		"currency": "USD"
	},
	"shipperLocId": "600",
	"shipperZipCode": "089508",
	"shippingMethod": "GND",
	"shippingMethodDesc": "FEDEX_GROUND",
	"guaranteedDeliveryDate": "Tue, 30 Jan 2018",
	"errorMessage": null,
	"packages": null,
	"promotions": null,
	"shippingDeliveryDate": "Tue, 30 Jan 2018"
}, {
	"webId": "12149",
	"hours": "18",
	"minutes": "19",
	"carrier": "FEDEX",
	"response": "Order with in next 18 hours 19 minutes to get it by Thu, 25 Jan 2018.",
	"shippingCost": {
		"amount": 9.93,
		"currency": "USD"
	},
	"shipperLocId": "528",
	"shipperZipCode": "91752",
	"shippingMethod": "GND",
	"shippingMethodDesc": "FEDEX_GROUND",
	"guaranteedDeliveryDate": "Thu, 25 Jan 2018",
	"errorMessage": null,
	"packages": null,
	"promotions": null,
	"shippingDeliveryDate": "Thu, 25 Jan 2018"
}]

SHOW DATE RANGE

Show Date Range: Checkout
Delivery Options: Delivery Date
Headers
- tenantId : 768b656c974245d2a427abe356bb4bf1
- Content-Type: application/json

Request Body:

{
	"sessionTrackId": "{{$guid}}",
	"buyerZipCode": "95129",
	"monetaryValue": 45,
	"pageType": "COP",
	"responseFormat": "json",
	"skus": [{
		"quantity": 1,
		"sku": "16500",
		"skuInventories": [{
			"locationId": "600",
			"quantity": 10
		}]
	}, {
		"quantity": 1,
		"sku": "12149",
		"skuInventories": [{
			"locationId": "528",
			"quantity": 10
		}]
	}]
}

Response Body:

[{
	"webId": null,
	"hours": "17",
	"minutes": "18",
	"carrier": null,
	"response": "Order with in next 17 hours 18 minutes to get it by Tue, 30 Jan 2018",
	"shippingCost": null,
	"shipperLocId": null,
	"shipperZipCode": null,
	"shippingMethod": null,
	"shippingMethodDesc": null,
	"guaranteedDeliveryDate": null,
	"errorMessage": null,
	"packages": null,
	"promotions": null,
	"shippingDeliveryDate": "Wed, 24 Jan 2018 - Tue, 30 Jan 2018"
}, {
	"webId": null,
	"hours": "17",
	"minutes": "18",
	"carrier": null,
	"response": "Order with in next 17 hours 18 minutes to get it by Fri, 26 Jan 2018",
	"shippingCost": null,
	"shipperLocId": null,
	"shipperZipCode": null,
	"shippingMethod": null,
	"shippingMethodDesc": null,
	"guaranteedDeliveryDate": null,
	"errorMessage": null,
	"packages": null,
	"promotions": null,
	"shippingDeliveryDate": "Wed, 24 Jan 2018 - Fri, 26 Jan 2018"
}]

INTELLIGENT DELIVERY PLATFORM FOR GROUND SHIPPING

When the given item is in multiple distribution centers, delivery estimate service will compare all location ground delivery estimates and return the fastest/cheapest delivery estimates based on the configuration.

SHOW FASTEST

Show Fastest: PDP
Delivery Options: Delivery Date
Headers
- tenantId : 768b656c974245d2a427abe356bb4bf1
- Content-Type: application/json

Request Body:

{
	"sessionTrackId": "{{$guid}}",
	"buyerZipCode": "95129",
	"monetaryValue": 45,
	"pageType": "PDP",
	"responseFormat": "json",
	"skus": [{
		"quantity": 1,
		"sku": "16500",
		"skuInventories": [{
			"locationId": "600",
			"quantity": 10
		}]
	}, {
		"quantity": 1,
		"sku": "12149",
		"skuInventories": [{
			"locationId": "528",
			"quantity": 10
		}]
	}]
}

Response Body:

[{
	"webId": "16500",
	"hours": "16",
	"minutes": "28",
	"carrier": "FEDEX",
	"response": "Order with in next 16 hours 28 minutes to get it by Tue, 30 Jan 2018.",
	"shippingCost": {
		"amount": 13.76,
		"currency": "USD"
	},
	"shipperLocId": "600",
	"shipperZipCode": "089508",
	"shippingMethod": "GND",
	"shippingMethodDesc": "FEDEX_GROUND",
	"guaranteedDeliveryDate": "Tue, 30 Jan 2018",
	"errorMessage": null,
	"packages": null,
	"promotions": null,
	"shippingDeliveryDate": "Tue, 30 Jan 2018"
}, {
	"webId": "12149",
	"hours": "16",
	"minutes": "28",
	"carrier": "FEDEX",
	"response": "Order with in next 16 hours 28 minutes to get it by Thu, 25 Jan 2018.",
	"shippingCost": {
		"amount": 9.93,
		"currency": "USD"
	},
	"shipperLocId": "528",
	"shipperZipCode": "91752",
	"shippingMethod": "GND",
	"shippingMethodDesc": "FEDEX_GROUND",
	"guaranteedDeliveryDate": "Thu, 25 Jan 2018",
	"errorMessage": null,
	"packages": null,
	"promotions": null,
	"shippingDeliveryDate": "Thu, 25 Jan 2018"
}]

SHOW CHEAPEST

Show Cheapest: Mini Cart
Delivery Options: Delivery Date
Headers
- tenantId : 768b656c974245d2a427abe356bb4bf1
- Content-Type: application/json

Request Body:

{
	"sessionTrackId": "{{$guid}}",
	"buyerZipCode": "95129",
	"monetaryValue": 45,
	"pageType": "MC",
	"responseFormat": "json",
	"skus": [{
		"quantity": 1,
		"sku": "16500",
		"skuInventories": [{
			"locationId": "600",
			"quantity": 10
		}]
	}, {
		"quantity": 1,
		"sku": "12149",
		"skuInventories": [{
			"locationId": "528",
			"quantity": 10
		}]
	}]
}

Response Body:

[{
		"webId": "16500",
		"hours": "16",
		"minutes": "25",
		"carrier": "FEDEX",
		"response": "Order with in next 16 hours 25 minutes to get it by Tue, 30 Jan 2018.",
		"shippingCost": {
			"amount": 13.76,
			"currency": "USD"
		},
		"shipperLocId": "600",
		"shipperZipCode": "089508",
		"shippingMethod": "GND",
		"shippingMethodDesc": "FEDEX_GROUND",
		"guaranteedDeliveryDate": "Tue, 30 Jan 2018",
		"errorMessage": null,
		"packages": null,
		"promotions": null,
		"shippingDeliveryDate": "Tue, 30 Jan 2018"
	},
	{
		"webId": "12149",
		"hours": "16",
		"minutes": "25",
		"carrier": "FEDEX",
		"response": "Order with in next 16 hours 25 minutes to get it by Thu, 25 Jan 2018.",
		"shippingCost": {
			"amount": 9.93,
			"currency": "USD"
		},
		"shipperLocId": "528",
		"shipperZipCode": "91752",
		"shippingMethod": "GND",
		"shippingMethodDesc": "FEDEX_GROUND",
		"guaranteedDeliveryDate": "Thu, 25 Jan 2018",
		"errorMessage": null,
		"packages": null,
		"promotions": null,
		"shippingDeliveryDate": "Thu, 25 Jan 2018"
	}
]

SHOW DATE RANGE

Show date range: Checkout
Delivery Options: Delivery Date
Headers
- tenantId : 768b656c974245d2a427abe356bb4bf1
- Content-Type: application/json

Request body:

{
	"sessionTrackId": "{{$guid}}",
	"buyerZipCode": "95129",
	"monetaryValue": 45,
	"pageType": "COP",
	"responseFormat": "json",
	"skus": [{
		"quantity": 1,
		"sku": "16500",
		"skuInventories": [{
			"locationId": "600",
			"quantity": 10
		}]
	}, {
		"quantity": 1,
		"sku": "12149",
		"skuInventories": [{
			"locationId": "528",
			"quantity": 10
		}]
	}]
}

Response body:

[{
		"webId": null,
		"hours": "15",
		"minutes": "11",
		"carrier": null,
		"response": "Order with in next 15 hours 11 minutes to get it by Tue, 30 Jan 2018",
		"shippingCost": null,
		"shipperLocId": null,
		"shipperZipCode": null,
		"shippingMethod": null,
		"shippingMethodDesc": null,
		"guaranteedDeliveryDate": null,
		"errorMessage": null,
		"packages": null,
		"promotions": null,
		"shippingDeliveryDate": "Tue, 30 Jan 2018"
	},
	{
		"webId": null,
		"hours": "15",
		"minutes": "11",
		"carrier": null,
		"response": "Order with in next 15 hours 11 minutes to get it by Thu, 25 Jan 2018",
		"shippingCost": null,
		"shipperLocId": null,
		"shipperZipCode": null,
		"shippingMethod": null,
		"shippingMethodDesc": null,
		"guaranteedDeliveryDate": null,
		"errorMessage": null,
		"packages": null,
		"promotions": null,
		"shippingDeliveryDate": "Thu, 25 Jan 2018"
	}
]

API RESPONSES

RESPONSE IF API IS NOT AVAILABLE

Variable - lookupsdeliveryEstimatesGetResponse.ErrorMsg
Response – “Service Result Error: lookupsdeliveryEstimates.get.cred, Status: ERROR, result.msg: test.fenixcommerce.com, result.errorMessage: UnknownHostException:test.fenixcommerce.com”

RESPONSE FOR INVALID/UNREACHABLE LOCATIONS

Variable - lookupsdeliveryEstimatesGetResponse.ErrorMsg
Response – Service Result Error: lookupsdeliveryEstimates.get.cred, Status: ERROR, result.msg: , result.errorMessage: {"error_code":"500","identifier":null,"error_message":"Generic application error.","description":"Error occured while retriving delivery estimates for buyer with zipcode: xxxxxx"}

REQUEST/RESPONSE FOR PRODUCT/INVENTORY NOT AVAILABLE

Request Parameters –
- basket – null
- pdpSKU – “123456”
- buyerZipCode – “01801”
- pageType – “PDP”
Response Variable – lookupsdeliveryEstimatesGetResponse.Response
Response – {"webId":"123456","hours":null,"minutes":null,"carrier":null,"response":null,"shippingCost":null,"shipperLocId":null,"shipperZipCode":null,"shippingMethod":null,"shippingMethodDesc":null,"guaranteedDeliveryDate":null,"errorMessage":{"error_code":"400","identifier":null,"error_message":"Invalid Locations","description":"Inventory is not exists in an oragnization's active locations"},"packages":null,"promotions":null,"shippingDeliveryDate":null}

POSITIVE SCENARIOS

Request Parameters –
- basket – null
- pdpSKU – “12149”
- buyerZipCode – “01801”
- pageType – “PDP”
Response Variable – lookupsdeliveryEstimatesGetResponse.Response
Response – {"webId": "12149","hours": "62","minutes": "5","carrier": "UPS","response": "Order with in next 62 hours 5 minutes to get it by Tue, 06 Mar 2018.","shippingCost": {"amount": 14.81,"currency": "USD"},"shipperLocId": "DC-DC_810","shipperZipCode": "08512","shippingMethod": "GND","shippingMethodDesc": "UPS Ground","guaranteedDeliveryDate": "Tue, 06 Mar 2018","errorMessage": null,"packages": [],"promotions": null,"shippingDeliveryDate": "Tue, 06 Mar 2018"}