Parameter
- ser_hcskb_api
Parameters are used to extend the available standard attributes of transports, deliveries and other objects with industry and business logic specific information.
Usage of parameters is optional and may be agreed upon as part of integration projects.
Attribute | Description | Type (Length) | Example | Mandatory |
|---|---|---|---|---|
qualifier | Identifier | CHAR(50) | custom.number | True |
value | The value of the parameter | TEXT | 15237 | True |
shipperVisibility | Deprecated | CHAR(3) | YES | False |
exportToCarrier | Deprecated | CHAR(3) | YES | False |
carrierVisibility | Deprecated | CHAR(50) | ASSIGNED | False |
Note that some qualifiers are reserved for standard parameters that can be used by any customer. For example, the “objectType” and “number” qualifiers are used to exchange processing results, see “Processing results” section. The “consigneeName” qualifier is used on delivery level if the consignee is different from the company specified in the “company_name” attribute of a station. For the list of reserved qualifiers, please refer to Reserved Parameter Qualifiers.
ShipperVisibility, exportToCarrier, carrierVisibility attributes are now defined for each parameter during the project phase and are pre-configured in our system.
Please discuss the introduction of additional parameters and their intended behavior with the responsible project manager before or during the project implementation phase.
Note that it is not necessary to send a full list of additional parameters with each push transport message. If a parameter value or other attribute has not changed since the last update, it can be omitted from the message. If you send some new parameters without any previous ones in the next message, both the old and new parameters will be saved with their values. If you need to remove a parameter or its value, resend the parameter with a null or empty value.