ShipX (Inpost) Shipment Extension
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
The following information is requested from the provider for the brand-specific and production (live) environment.
API_URL
API_TOKEN
ORGANIZATION_ID
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 41An 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 '{EXTENSION_URL}/addresses' \
--header 'x-akinon-request-id: 50dac251-048c-402f-91c9-e5573b5a6057' \
--header 'x-akinon-api-version: 1.0' \
--header 'Authorization: Basic {EXTENSION_BASIC_AUTH_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": "1ac38925-6a04-42a5-b3b1-044eb4095e45", // return_destination_extension_id in Omnitron config,
"addressName": "Jacobs Group",
"addressDescription": "totam quisquam qui",
"phone": "+90 216 555 1234",
"email": "[email protected]",
"type": "PICK_UP_LOCATION",
"address": {
"country": {
"id": 0, // optional
"code": "TR",
"name": "Turkey"
},
"city": {
"id": 0, // optional
"name": "Istanbul"
},
"township": {
"id": 0, // optional
"name": "Kadıköy"
},
"district": {
"id": 0, // optional
"name": "ACIBADEM"
},
"coordinates": {
"latitude": -80.2031,
"longitude": 11.2438
},
"zipcode": "1724042906",
"addressLine": "Caferağa Mahallesi, Dr. Esat Işık Caddesi No:35"
}
}'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.
Extension-specific
API_URL
URL received during the preliminary works phase (without a trailing slash at the end) Test: https://sandbox-api-shipx-pl.easypack24.net
API_TOKEN
API TOKEN received during the preliminary works phase
ORGANIZATION_ID
ORGANIZATION ID received during the preliminary works phase
STATIC_EMAIL
Default email used in shipment operations
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’)
ShipX 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.
To add ShipX, a new shipping provider is added to SHIPPING_PROVIDERS in Dynamic Settings through Omnitron.
Example Omnitron Configuration:
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": [ "length", "width", "height", "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" } }
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:
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_attribute}", "width": "{product_width_attribute}", "height": "{product_height_attribute}", "weight": "{product_weight_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
For both the shipment and easy-return modules to function correctly, the customer address provided in the generate-shipment or generate-easy-return step must include the target_point and addressLine values concatenated with a space (" ") in the addressLine field.
Example format: "{target_point} {addressLine}", e.g., "KRA012 Czerniakowska 87A".
The target_point is a required field enforced by the provider for locker-type shipments.