Skip to main content
The Contacts Data Model simplifies the handling and retrieval of contact-related information across various e-commerce platforms.
  • Unified contact properties: The model unifies essential contact details, such as name, email, phone, and status, enabling easier access and management of contact data from different platforms.
  • Multiple addresses support: In V4, contacts can have multiple associated addresses (billing, shipping) for comprehensive contact management.
  • Expandable relationships: Use the expand parameter to include related Address objects in API responses.

​
Attributes

FieldTypeDescriptionRequiredExpandable
rootfi_idintegerUnique identifier assigned by Commenda for this contact recordYesNo
rootfi_created_atdatetimeTimestamp when this record was first created in Commenda’s system (ISO 8601 format)YesNo
rootfi_updated_atdatetimeTimestamp when this record was last updated in Commenda’s system (ISO 8601 format)YesNo
rootfi_company_idintegerIdentifier of the company this contact belongs to within Commenda’s systemYesNo
platform_idstringUnique identifier for this contact in the source e-commerce platform (e.g., Shopify customer ID)YesNo
namestringFull name of the contact (e.g., “John Smith”)YesNo
emailstringPrimary email address for the contact, used for communication and identificationNoNo
phonestringPrimary phone number in E.164 format (e.g., “+1-555-123-4567”)NoNo
typeenumType of contact relationshipNoNo
statusenumCurrent status of the contact accountYesNo
created_atdatetimeOriginal creation timestamp from the source platform (ISO 8601 format)YesNo
updated_atdatetimeLast modification timestamp from the source platform (ISO 8601 format)YesNo
addressesarrayCollection of Address objects associated with this contactNoYes

​
Type Enum Values

ValueDescription
customerContact is a customer who makes purchases
vendorContact is a vendor who supplies products
bothContact acts as both customer and vendor
unknownType cannot be determined

​
Status Enum Values

ValueDescription
activeContact is active and in good standing
inactiveContact has been voluntarily deactivated
suspendedContact is temporarily suspended
archivedContact has been archived for record-keeping
unknownStatus cannot be determined or is not provided by the platform

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=addresses - Includes full Address objects in the response

​
Address Object

Each address in the addresses array contains:
FieldTypeDescriptionRequired
rootfi_idintegerUnique identifier assigned by Commenda for this addressYes
platform_idstringUnique identifier for this address in the source platformNo
typeenumIndicates the purpose of this address (billing, shipping, warehouse)Yes
streetstringStreet address including house/building number and street nameYes
citystringCity or locality nameYes
statestringState, province, or region (typically 2-letter code for US states)No
postal_codestringZIP code, postal code, or equivalentYes
countrystringISO 3166-1 alpha-2 country code (e.g., “US”, “CA”, “GB”)Yes
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "cus_123456",
  "name": "John Smith",
  "email": "john.smith@example.com",
  "phone": "+1-555-123-4567",
  "status": "active",
  "created_at": "2024-01-22T05:07:31.465Z",
  "updated_at": "2024-01-22T05:07:31.465Z",
  "addresses": [
    {
      "rootfi_id": 278264,
      "platform_id": "addr_123456",
      "type": "billing",
      "street": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    },
    {
      "rootfi_id": 278265,
      "platform_id": "addr_123457",
      "type": "shipping",
      "street": "456 Oak Avenue",
      "city": "Brooklyn",
      "state": "NY",
      "postal_code": "11201",
      "country": "US"
    }
  ]
}