XTL interface settings

The XTL Interface software module is used to transfer shipment data to XTL via the API provided by XTL.

Job and schedules

The export is executed by the job 0017:0001 XTL interface shipment export. The frequency of the export is determined via the schedule of the job.

General settings

• 010: This is the URI (Uniform Resource Identifier) for the API call. This is specified by XTL.
• 020: The API key for calling the API. This is specified by XTL.
• 030: The type of export for calling the API. This is specified by XTL.
• 040: Defines the entry time from which shipments are taken into account.

Services

Shipments with the services defined here are taken into account during export. At least one service must be defined, otherwise no consignments will be exported. The main service of a shipment is filtered.

In addition, a valid number must be assigned for the desired articles of the defined services in the setting 200: XTL interface, article number. This is specified by XTL. Shipments with an article without this setting will not be transmitted.

If new services are defined, then a current date should be set for the setting 040 (Entry time for consignments from) under the general settings. Otherwise all consignments with the newly added services before this date will also be taken into account.

Counties

Shipments with the districts defined here are taken into account during export. At least one district, one depot, one district group or one district structure must be defined, otherwise no consignments will be exported. The current district of a consignment is filtered.

For carrier route structures, carrier route groups and depots, the affiliation of a carrier route at the time of the last carrier route determination is valid.

For district groups, the associated district structure is shown in the Path column, and for districts, the associated district structure and district group. Otherwise, the column is empty.

If new carrier routes, depots, carrier route groups or carrier route structures are defined, then a current date should be set under the general settings for the setting 040 (entry time for consignments from). Otherwise, all shipments with the newly added carrier routes, securities accounts, carrier route groups or carrier route structures are also taken into account before this date.

Status and status messages

If a shipment was successfully transmitted, the delivery date is stored in the extended shipment attribute XTL interface: Last Exported Delivery Date the delivery date of the shipment is stored.

If a shipment could not be transmitted or if errors or warnings occurred during processing at XTL, these are stored in the extended shipment attribute XTL interface: Processing Errors.