additional parameters

Additional parameters defined by the manifest.xml file

The ISF format from version 2.0 allows you to send your own custom nodes that can be used
by the courier to generate a label. To supplement them, you can use variables defined by the
developer in the manifest.xml file.
The manifest.xml file contains information about the endpoint where the ISF is to be sent, the
structure of the additionalParams node in the ISF, and the configuration of individual variables.
In ISF 2.0 it is a key element of correct integration.
Structure:
/manifest/ - (required) root node
/manifest/url/ - (required) endpoint of courier API
/manifest/additional_parameters/ - (required) any XML structure defined by the developer
/manifest/config/ - (optional) configuration of variables defined by the developer
/manifest/config/option/ - (required)
/manifest/config/option/@type/ - (required) variable
typej values: “input” / “radio” / “select”
/manifest/config/option/@id/ - (required) name of the variable declared in the
additional_parameters
/manifest/config/option/@name/ - (required) – name present in the panel
/manifest/config/option/values/ - (required) only ifi @type = “radio” / “select”
/manifest/config/option/values/value/ - (required) the value of this node is
the value changed for the variable in additional_parameters
/manifest/config/option/values/value/@name/ - (required) the name of
the option visible in the panel

manifest.xml example code

<?xml version="1.0" encoding="UTF-8"?>
<manifest type="isf" version="1548698901">
  <url>https://endpoint.com/isf/test</url>
  <additional_parameters>
    <products> [iai:foreach_products_list-begin]
    <pickup_hour>[courier:pickupHour]</pickup_hour>
    <is_radioactive>[courier_config:isRadioactive]</is_radioactive>
    <referenceField>[courier_config:referenceField]</referenceField>
  </additional_parameters>
  <config>
    <option type="select" id="pickupHour" name="Pickup hour">
      <values>
        <value name="8 am">10</value>
        <value name="4 pm ">12</value>
      </values>
    </option>
    <option type="radio" id="isRadioactive" name="Is package radioactive?">
      <values>
        <value name="Yes">yes</value>
        <value name="No">no</value>
      </values>
    </option>
    <option type="input" id="referenceField" name="Additional reference field"></option>
  </config>
</manifest>

Did this page help you?