Skip to main content

CustomerModel

Customer profile.

Breaking Changes​

No breaking changes.

Examples​

Fill this template out with real values.

{
"addresses": "array[[CustomerAddressModel](/docs/data_types/CustomerAddressModel)]",
"contacts": "array[[CustomerContactModel](/docs/data_types/CustomerContactModel)]",
"created_on": "String",
"id": "Integer",
"last_updated_on": "String",
"locations": "array[[DispatchCustomerSettingsModel](/docs/data_types/DispatchCustomerSettingsModel)]",
"name": "String",
"parent_id": "Integer"
}

Fields​

addresses Array[CustomerAddressModel], Required

Refer to CustomerAddressModel.

contacts Array[CustomerContactModel], Required

Refer to CustomerContactModel.

created_on String, Required

Timestamp of creation (must be in past).

  • Date occurring in the past in an ISO 8601 compatible format.

id Integer, Required

Customer identifier.

last_updated_on String, Required

  • Date occurring in the past in an ISO 8601 compatible format.

locations Array[DispatchCustomerSettingsModel], Required

Refer to DispatchCustomerSettingsModel.

name String, Required

Name (free text).

  • At least 1 and no more than 64 characters.

parent_id Integer, Required

Parent record identifier.