Use Cases (with sample request)
- Rahul Kumar Sahukar
Fenix’s Unified API provides a single interface for shipping. The API is capable to perform three important functionalities.
Order Sourcing
Cartonizing
Rate Shopping
Retailers/3PL can utilize this API to request one or the other functionality along with Rate Shopping.
Following are a few ways the API can be called.
Use Case 1
Send Packaging and Sourcing in the same API Request
Description
The retailers/3PL may want to perform their own order sourcing and packaging. In such use case, the retailer/3PL can send the packaging and the order sourcing information in the same request.
The to field in the unified request would act as the sourcing location and the shipment_info would serve as the packaging information.
Currently, you can send details of only one package per request.
So, if you think an order is to be shipped in multiple packages, you need to call the API multiple times.
Sample Request |
|---|
{
"from": {
"address1": "700 Indian Springs Drive",
"address2": "",
"city": "Lancaster",
"country": "US",
"state": "PA",
"zipcode": "17601"
},
"to": {
"address1": "210 rose ct",
"address2": "",
"city": "campbell",
"country": "US",
"state": "CA",
"zipcode": "95008"
},
"warehouse_id": "LAN",
"product_infos": [
{
"quantity": 1,
"sku": "A-E-A-101A01-CETD-04G-TNGPP-L"
}
],
"request_id": "12345",
"shipment_id": "12345",
"shipment_info": {
"dimensions": {
"length": 5,
"width": 5,
"height": 5,
"units": "IN"
},
"weight": {
"value": 5,
"units": "LB"
},
"product_infos": [
{
"quantity": 1,
"sku": "A-E-A-101A01-CETD-04G-TNGPP-L"
}
]
},
"tenant_id": "cc29bd79c13d48babb28bf696936379b",
"deliver_within_days": 5
}
|
Use Case 2
Send the packaging details but let the API do the order sourcing
Description
In this scenario, the retailer/3PL send the packaging details in the API request. The API will then first source the order and then uses the packaging details sent in the request to pack the order.
Please note that irrespective of how many locations Fenix eventually sources the order, it is going to use the same package for all those independent orders.
Usually, the packaging happens after the order is sourced. But in this scenario, we are doing the opposite. Though it is an odd scenario, Fenix is well capable to handle this.
Sample Request |
|---|
{
"to": {
"address1": "210 rose ct",
"address2": "",
"city": "campbell",
"country": "US",
"state": "CA",
"zipcode": "95008"
},
"product_infos": [
{
"quantity": 1,
"sku": "A-E-A-101A01-CETD-04G-TNGPP-L"
}
],
"request_id": "12345",
"shipment_id": "12345",
"shipment_info": {
"dimensions": {
"length": 5,
"width": 5,
"height": 5,
"units": "IN"
},
"weight": {
"value": 5,
"units": "LB"
}
},
"tenant_id": "cc29bd79c13d48babb28bf696936379b",
"deliver_within_days": 5
}
|
Use Case 3
Send the product information and let the API do the order sourcing and packaging
Description
In this scenario, the retailer/3PL just sends the product details in the API request. The API will then first source the order and then uses then cartonizes the order at each warehouse and then perform the rate shopping.
Sample Request |
|---|
{
"to": {
"address1": "210 rose ct",
"address2": "",
"city": "campbell",
"country": "US",
"state": "CA",
"zipcode": "95008"
},
"product_infos": [
{
"quantity": 1,
"sku": "A-E-A-101A01-CETD-04G-TNGPP-L"
}
],
"request_id": "12345",
"shipment_id": "12345",
"tenant_id": "cc29bd79c13d48babb28bf696936379b",
"deliver_within_days": 5
} |