Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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:

    Code Block
    {
    	"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:

    Code Block
    [{
    	"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:

    Code Block
    {
    	"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:

    Code Block
    [{
    	"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:

    Code Block
    {
    	"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:

    Code Block
    [{
    	"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:

    Code Block
    {
    	"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:

    Code Block
    [{
    	"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:

    Code Block
    {
    	"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:

    Code Block
    [{
    		"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:

    Code Block
    {
    	"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:

    Code Block
    [{
    		"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"}