FarEye Shipment Extension

Extension Installation

Preliminary Works

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

• API_URL

• API_KEY

• API_MERCHANT_CODE

• SLOT_EXTENSION_URL

• OMNITRON_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 'https://<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(str)>, // return_destination_extension_id in Omnitron config,
    "addressName": "Test Address",
    "addressDescription": "test",
    "phone": "9876543210",
    "email": "[email protected]",
    "address": {
        "country": {
            "id": 1,
            "code": "SA",
            "name": "Saudi Arabia"
        },
        "city": {
            "id": 1,
            "name": "Riyadh"
        },
        "district": {
            "id": 1,
            "name": "Najd"
        },
        "township": {
            "id": 1,
            "name": "Najd"
        },
        "zipcode": "110001",
        "addressLine": "Kharghar Navi Mumbai"
    }
}'

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)
API_KEY	In Fareye, the parameter called "api_key" needs to be taken.
API_MERCHANT_CODE	In Fareye, the parameter called "merchant_code" needs to be taken.
SLOT_EXTENSION_URL	This parameter will be the slot extension url of the brand.
OMNITRON_TOKEN	This parameter will be the brand's omnitron token information.
Generic
SECRET_KEY	The generated secret key during the preliminary works phase
ADMIN_PASSWORD	A newly created and extension-specific strong password
ADMIN_USERNAME	A username can be entered (example: ‘akinon’)

Omnitron Settings

Fareye 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 Fareye, 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}" } }
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": [ "weight" ] }, "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”: { "barcode": "{product_barcode_attribute}", "description": "{product_description_attribute}", "name": "{product_name_attribute}" } }
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