Delivery and Invoice Recipients
Master data for identifying addresses. At Workist, addresses always refer to delivery and invoice addresses. We use the same data structure in Workist for both address types.
Workist typically requires 2 separate files if both delivery and invoice addresses are to be provided. In the Master Data Hub, these are two lists of the type Address; the channel field determines the role a list plays (Delivery Address Lookup ID or Invoice Address Lookup ID).
Even though customer data is treated as a type of address in many systems, Workist uses a separate format for customers! See Customer Master Data.
Column Description
Required: Workist cannot use the record without this column. Recommended: significantly improves recognition. The import itself does not check columns: if a column is missing, the field stays empty.
| # | Field Name | Status | Description |
|---|---|---|---|
| 1 | partition_id | Optional | client_id1 of the customer the address belongs to. Limits the choice to this customer's addresses and significantly increases the recognition rate. Workist offers addresses without a partition_id for every customer. |
| 2 | address_id1 | Required | Primary address number. Workist returns this number in the output. |
| 3 | address_id2 | Optional | Secondary address number (e.g. GLN) |
| 4 | address_id3 | Optional | Tertiary address number |
| 5 | name | Recommended | First address line (e.g. Muster GmbH) |
| 6 | address1 | Recommended | Street and house number (e.g. Musterstraße 1) |
| 7 | street_name | Optional | Street name, if street and house number are separate. Alternative to address1. |
| 8 | street_number | Optional | House number, if separate from street_name |
| 9 | address2 | Optional | Additional address line |
| 10 | zip_code | Recommended | Postal code |
| 11 | city | Recommended | City |
| 12 | country_subdivision | Optional | State or region |
| 13 | country | Recommended | Country. Workist converts country names and three- or one-letter country codes to the two-letter ISO code (e.g. Germany → DE). Values it does not recognise are left empty. |
| 14 | po_box | Optional | PO box for delivery |
| 15 | misc | Optional | Additional information about the address (in some systems also called unloading point, e.g. Gate 4) |
| 16 | contact_person | Optional | Contact person for the address (e.g. Attn.: Sample Person) |
| 17 | phone | Optional | Phone number associated with the address |
| 18 | extra_data | Optional | Additional information as a JSON object, e.g. {"Brand": "Sample"}. Workist stores it with the record and shows it in the data explorer. By default, Workist does not use it for recognition. |
Format
Columns that are not needed can be omitted from the data export.
Example file name: address_list.csv
partition_id;address_id1;name;address1;zip_code;city;country;misc
K001;A001;Muster GmbH - Lager;Lagerstraße 10;12345;Berlin;DE;Tor 2
K001;A002;Muster GmbH - Büro;Musterstraße 1;12345;Berlin;DE;
K002;A003;Beispiel AG;Beispielweg 5;20099;Hamburg;DE;
The example uses ; as delimiter. Set the delimiter in the import configuration; without a setting, Workist expects a comma.
Via the API you send the same columns as a CSV file or as JSON. Endpoint: Swagger, basics: Using the Master Data API.