Location Data Layout
Structure of location data in graphiteConnect supplier profiles, including address sub-fields and validation indicators.
Location Data Layout
Location data in graphiteConnect is validated by graphiteConnect before it appears in the API. A full list of all locations provided by a company is stored as an array under the Locations_List key in the profile JSON.
Relationship Addresses
Suppliers may designate specific locations for the relationship. These are identified by dedicated keys at the root level of the profile:
| Key | Description |
|---|---|
Locations_List | All locations provided by the company (full array) |
Payment_Address | The location chosen for remittance (paying the supplier) |
Ordering_Address | The location used for purchase orders |
Sales_Address | The sales contact location |
Payment_Address, Ordering_Address, and Sales_Address reference a single location object from Locations_List and are the specific locations chosen for the relationship between your company and that supplier.
Location Object Structure
Each object in Locations_List contains the following fields:
| Field | Description |
|---|---|
_id | Internal graphiteConnect identifier for this location instance. Used in PATCH /profile/{publicId} and the acknowledge API. |
Location_Type | A list indicating what is located at this address (e.g., Warehouse, Office, Remit To, Order From) |
Location_Name | Customer-supplied name for this location |
Address | Nested object containing the actual address data (see sub-fields below) |
data | Internal graphiteConnect data (format subject to change; do not rely on this field) |
XXX__Validated_X | Validation indicators (see below) |
Address Sub-Fields
The Address object within each location contains the following fields:
| Field | Description |
|---|---|
Address_Country | Country the address is located in |
Address_1 | First address line |
Address_2 | Second address line (optional) |
Address_Region_State | US state or international region. For countries with multi-layered regions, multiple numbered values are returned from highest to lowest administrative level (e.g., Address_Region_State, Address_Region_State_2) |
Address_Postal_Code | Postal or ZIP code |
Example Location Object
{
"_id": "23ab88546bfc97223f2c4802936f26e4",
"Location_Type": ["Remit To", "Warehouse"],
"Location_Name": "East Coast Distribution Center",
"Address": {
"Address_Country": "US",
"Address_1": "456 Industrial Blvd",
"Address_2": "Suite 100",
"Address_Region_State": "NY",
"Address_Postal_Code": "10001"
}
}Address Validation Fields
Fields matching the pattern XXX__Validated_X indicate whether graphiteConnect has validated an address, when it was validated, and by whom. These fields are managed by graphiteConnect and should be treated as read-only.
Related Documentation
- Company Data Layout — Overview of the full profile data structure
- Banking Data Layout — Structure of banking data
- ERP Record — ERP_Record group field definitions
Updated about 7 hours ago
