Optional. Use it if you need to specify addresses already created in the extension. As a result, cross border returns will be redirected to the specified warehouse address.
Example value:
{"AU": "1002"} // country code and address id
| | OMNITRON\_URL |Required field. Base URL of the brand’s Omnitron.
Used to retrieve product price and currency information.
Example: https\://{OMNITRON\_URL}.com
| | OMNITRON\_TOKEN | Required field. Authentication token of the brand’s Omnitron service. Used to retrieve product price and currency information. | | PACKAGE\_SOURCE | Required field. Specifies the source of product price and currency data. Can be either OMS or OMNITRON. The default value is OMNITRON | | 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 Carriyo 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 Carriyo, 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": "\
"generate\_shipment\_product\_strategy": true,
"generate\_shipment\_product\_attributes": \[
"weight",
“unit”
]
},
"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”: {
"description": "description",
"name": "{product\_attribute\_code}",
"weight": "{product\_attribute\_code}",
"unit": "{product\_attribute\_code}",
"hs\_code": "{product\_attribute\_code}",
"country\_of\_origin": "{product\_attribute\_code}"
}
}
| | 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
]
]
}
}