Fero AI Shipment Extension

Extension Installation

Preliminary Works

The following information is requested from the provider for the brand-specific and production (live) environment.

API_URL
CUSTOMER
API_TOKEN

A secret_key is generated with a minimum length of 41 characters. The generated key must be kept throughout the installation. An example command line to generate a random key:

openssl rand -base64 41

An address ID must be set for the default destination information in easy-return shipments. It can be created using the extension's address creation method (example curl is given below). Ensure that the address ID is accurately configured to facilitate the smooth handling of return shipments within the Omnitron configuration.

curl --location --request POST '{{extension_url}}/addresses' \
--header 'x-akinon-request-id: {{guid}}' \
--header 'x-akinon-api-version: 1.0' \
--header 'Authorization: Basic {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": <id>, // return_destination_extension_id in Omnitron config,
    "addressName": "Test Address Name",
    "addressDescription": "Test Description",
    "phone": "+971547932376",
    "email": "[email protected]",
    "type": "DISTRIBUTION_POINT",
    "address": {
        "country": {
            "id": <id>, // optional
            "code": "AE",
            "name": "AE"
        },
        "city": {
            "id": <id>, // optional
            "name": "Dubai"
        },
        "township": {
            "id": <id>, // optional
            "name": "Al Raffa"
        },
        "district": {
            "id": <id>, // optional
            "name": "Al Quoz Industrial Area 4"
        },
        "zipcode": "Al Quoz Industrial Area 4",
        "addressLine": "6thStreet, 6thStreet DC, 6thStreet No 14 B, Al Raffa, Dubai, AE"
    }
}'

"district" field is optional.

In order to send the correct data to Fero AI, the product attributes with the code names "name", “height”, “width”, “length” and “weight” should be defined.

UAT API_URL: https://ferointegrationuat.feroai.com

PROD API_URL: https://ferointegration.feroai.com

Environment Variables

The extension installed to the relevant project in ACC must have the following environment variables. Environment variables can be entered before or after the deployment phase. As changes are made to the environment variables, the deployment process must be performed again.

Variable

Description

Extension-specific

API_URL

URL received during the preliminary works phase (without a trailing slash at the end)

CUSTOMER

CUSTOMER received during the preliminary works phase. It is customer code/username

API_TOKEN

API TOKEN received during the preliminary works phase

CLOSING_TIME

Closing time of warehouse/store. This is the latest time it should be picked up by the courier. HH:MM

READY_AT_TIME

Opening time of warehouse/store. This is the earliest time it should be picked up by the courier. HH:MM

LANDMARK_MAPPING

Defines which landmark mapping should be used. Default is TOWNSHIP Values: CITY, TOWNSHIP

CREDENTIALS

Can be set for multiple credentials support. JSON, Ex: {“customer_1”:“token_1”,“customer_2”:“token_2”}

TRACKING_URL

Used for obtaining the tracking url for the shipment. Example: https://skyexpressinternational.com/Home/Tracking?trackingType=AWB&tid={waybill_number}

Generic

SECRET_KEY

The generated secret key during the preliminary works phase

ADMIN_EMAIL

The e-mail address of the installer can be entered

ADMIN_PASSWORD

A newly created and extension-specific strong password

ADMIN_USERNAME

A username can be entered (example: ‘akinon’)

Omnitron Settings

Fero AI can be selected as the Shipment Provider in Omnitron to integrate with the extension installed. Additionally, an easy return option can be defined to enable easy return methods. Explanations on how these settings can be configured are detailed in the sections below. Please note that these two operations are independent and optional.

Shipping Provider

To add Fero AI, a new shipping provider is added to SHIPPING_PROVIDERS in Dynamic Settings through Omnitron.

Example Omnitron Configuration:

Field

Description

Klass

ExtensionShippingProvider Class

Urls Code

{ "urls": { "base_url": "{SHIPMENT_EXTENSION_URL}", "tracking_url": "https://skyexpressinternational.com/Home/Tracking?trackingType=AWB&tid={waybill_number}" } }

Serializers

Order Serializer: ExtensionShippingOrderSerializer Class Response Serializer: ExtensionShippingResponseSerializer Class

Configurations Code

{ "strategies": { "query_type": "SHIPMENT_ID", "generate_shipment_origin_strategy": "<addressId>", "generate_shipment_product_strategy": true, "generate_shipment_product_attributes": [ “length”: “{product_length}”, “width”: “{product_width}”, “height”: “{product_height}”, “weight”: “{product_height}” ] }, "pay_on_delivery_option": false, "delivery_type": "CUSTOMER", "auth": { "username": "{SHIPMENT_EXTENSION_ADMIN_USERNAME}", "password": "{SHIPMENT_EXTENSION_ADMIN_PASSWORD}" }, "is_active": { "query": true, "send_shipping_info": true, "delete_shipping_info": true, "query_by_order": true }, "label_options": { "file_extension": "pdf" } }

Easy Return Shipping Option

One easy return shipping option must be defined in Omnitron to be specific for the extension installed. Explanations on how the settings should be made at this stage are in the section below.

Example Omnitron Configuration:

Field

Description

Shipping Company

Extension Cargo

Shipping Company Auth Code

{ "url": "{SHIPMENT_EXTENSION_URL}", "username": "{SHIPMENT_EXTENSION_ADMIN_USERNAME}", "password": "{SHIPMENT_EXTENSION_ADMIN_PASSWORD}", “send_user_address”: True, “easy_return_product_strategy”: True, "return_destination_extension_id":"{address_id}" “product_attributes”: { “length”: “{product_length}”, “width”: “{product_width}”, “height”: “{product_height}”, “weight”: “{product_height}” } }

Start Date Gap

This variable is used to delay the start date for using the return code. If this value is set to 0, the customer can request a refund on the same day.

Delivery Time

The delivery_time variable indicates the duration for which the return code will be valid and usable. If the product is not shipped by the customer within this period, the code becomes invalid.

Shipping Company Prefix

If a prefix is to be added to the return code, this field should contain the short name of the brand. This short name can be any value determined by the brand.

Shipping Company Rules

{ "product": { "field_key": "attributes__easy_return_method", "field_values": [ [ "", null ] ] } }

Status

active

Mapping

This method is used to assign a country, city, landmark, and city_credential to a specific format. Required if these field values aren't the same as Omnitron or OMS .

Map Address Value with country/city_code/city_landmark/township_landmark/city_credential**:** The mapping method takes three values: type, key, and value.

Type: COUNTRY|CITY_CODE|CITY_LANDMARK|TOWNSHIP_LANDMARK|CITY_CREDENTIAL.
Key: Use the Omnitron/OMS value as the key.
Value: Use the Fero AI Equivalent as the value.

Examples:

- Type: COUNTRY
- Key: UAE
- Value: AE
- Type: CITY_CODE
- Key: DUBAI
- Value: DBX
- Type: TOWNSHIP_LANDMARK
- Key: Al-Raffa
- Value: Al Raffa
- Type: CITY_LANDMARK
- Key: Abu Dhabi
- Value: ABU DHABI
- Type: CITY_CREDENTIAL
- Key: DUBAI
- Value: AL1234

To get cities for CITY_LANDMARK from Fero AI, use:

curl --location 'https://ferointegrationuat.feroai.com/api/v1/integration/location/' \
--header 'Token: <token>

To get townships for TOWNSHIP_LANDMARK from Fero AI, use:

curl --location 'https://ferointegrationuat.feroai.com/api/v1/integration/area/' \
--header 'Token: <token>

To get cities for CITY_CODE from Fero AI, use:

curl --location 'https://ferointegrationuat.feroai.com/api/v1/integration/location/' \
--header 'Token: <token>

Field

Description

Extension URL

The URL of the shipment extension

Username

Extension user's name for authorization

Password

Extension user's password for authorization

Type

COUNTRY

Key

Omnitron/OMS value of the field

Value

Fero AI value of the field or customer value for the city-credentials mapping.

Generate Mapping Request:

curl -X POST {{extension_url}}/mapper \
     -u username:password \
     -H "Content-Type: application/json" \
     -d '{
           "type": "",
           "key": "",
           "value": ""
         }'

Example:

curl -X POST {{extension_url}}/mapper \
     -u username:password \
     -H "Content-Type: application/json" \
     -d '{
           "type": "CITY_CREDENTIAL",
           "key": "DUBAI",// city data in Omnitron
           "value": "customer_1" // defined in env. var.
         }'

Update Mapping Request:

The values for key, type, and value should be updated.

curl -X PATCH "{{extension_url}}/mapper/<id>" \
     -u username:password \
     -H "Content-Type: application/json" \
     -d '{
           "type": "",
           "key": "",
           "value": ""
         }'

Get Mapping Request:

When making a query request, it can be filtered by the fields type, key, value, created_date and modified_date.

curl -X GET "{{extension_url}}/mapper?key=<key>" \
     -u username:password \
     -H "Content-Type: application/json"

Delete Mapping Request:

curl -X DELETE "{{extension_url}}/mapper/<id>" \
     -u username:password \
     -H "Content-Type: application/json"

OMS Settings

For OMS, “strategies” field in Shipping Management must be defined accordingly:

{"send_product_info":true,"product_attributes":["length","width","height","weight"]}

Additional Notes

There are no endpoints that allow for a "customer address" change.
If the CREDENTIALS variable doesn’t provided in .env or a city doesn’t have any mapping with CITY_CREDENTIAL, extension uses default credentials as CUSTOMER and API_TOKEN

PreviousPorter Express Shipment Extension NextKolay Gelsin Shipment Extension

Last updated 17 days ago

Was this helpful?