Sürat Cargo Easy Return Extension

Extension Installation

Preliminary Works

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

• WSDL URL
• Kullanıcı Adı (Username)
• Şifre (Password)

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 'https://extension.lb.akinoncloud.com/addresses' \
--header 'x-akinon-request-id: ••••••' \
--header 'x-akinon-api-version: ••••••'' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data-raw '{
    "id": "1234", // return_destination_extension_id in Omnitron config
    "addressName": "Test Warehouse",
    "addressDescription": "Test Warehouse",
    "phone": "000",
    "email": "[e-mail]",
    "address": {
        "country": {
            "id": 1,
            "code": "tr",
            "name": "Türkiye"
        },
        "city": {
            "id": 1,
            "name": "Adana"
        },
"township": {
            "id": 1,
            "name": "Aladağ"
        },   
        "district": {
            "id": 41,
            "name": "Ceritler Mah."
        },  
        "zipcode": "01722",
        "addressLine": "Test Street No: 7/19"
    }
}'

Label format should be defined as ZPL on the Provider side. If no definition is made the default format will be EPL which is currently not supported.

Supported type: ZPL

Unsupported types: EPL, PDF

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.

An example environment variable input during the setup phase:

Variable	Description
Extension-specific
API_URL	WSDL URL received during the preliminary works phase
API_USERNAME	Username received during the preliminary works phase
API_PASSWORD	Password received during the preliminary works phase
WEBGONDERI	True for using WebServisGonderisi services False for using OrtakBarkodEntegrasyonu services Default: False
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’)

Mapping

If there are differences between the Sürat cargo city/township data and the commerce city/township data, mapping is required. For mapping operations, you can follow the mapping documentation.

User Guide - Mapper Endpoints in Extensions

Generate City Mapping Request:

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

Generate Township Mapping Request:

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

Omnitron Settings

The installed extension must also be defined to the project via Omnitron. For this, Easy Return Shipping Options page should be consulted.

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 table below.

Field	Description
Shipping Company	Extension Cargo
Shipping Company Auth Code	{ "url": "{extension_url}", "username": "extension_username", "password": "extension_password", "return_destination_extension_id": "{destination_id}", “send_user_address”: true/false, “use_prefix”: True/False } *If it is required to add the value specified in the prefix field to the beginning of the return codes, the use_prefix value should be set to True. If this feature is not needed, the use_prefix can be omitted. *send_user_address: If set to true, the return requests sent from the extension will use the user's address. If not set or set to false, the previously configured fixed warehouse address will be used.
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