> For the complete documentation index, see [llms.txt](https://the-wishlist-documentation.gitbook.io/the-wishlist-documentation-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://the-wishlist-documentation.gitbook.io/the-wishlist-documentation-docs/customer-rest-api/models.md).

# Models

## The AddressDto object

```json
{"openapi":"3.0.3","info":{"title":"Customer REST API","version":"0.0.1"},"components":{"schemas":{"AddressDto":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"addressName":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultAddress":{"type":"boolean","description":"default_address"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"},"provinceCode":{"type":"string"}},"title":"AddressDto"}}}}
```

## The AttributeGroupDto object

```json
{"openapi":"3.0.3","info":{"title":"Customer REST API","version":"0.0.1"},"components":{"schemas":{"AttributeGroupDto":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"}},"title":"AttributeGroupDto"}}}}
```

## The CustomerDto object

```json
{"openapi":"3.0.3","info":{"title":"Customer REST API","version":"0.0.1"},"components":{"schemas":{"CustomerDto":{"type":"object","properties":{"accepts_marketing":{"type":"boolean"},"active":{"type":"boolean"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressDto"}},"alternateCustomerRef":{"type":"string"},"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeGroupDto"}},"averageSpendPerAnnum":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"customerRef":{"type":"string"},"customer_state":{"type":"string","enum":["disabled","invited","enabled","declined"]},"defaultAddress":{"$ref":"#/components/schemas/AddressDto"},"dob":{"type":"string","pattern":"^\\d{1,2}-\\d{1,2}-\\d{4}$"},"email":{"type":"string"},"firstName":{"type":"string","description":"first_name"},"id":{"type":"string"},"initials":{"type":"string"},"jobTitle":{"type":"string"},"joinedStoreId":{"type":"string"},"joinedStoreName":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastName":{"type":"string","description":"last_name"},"lastOrder":{"type":"string","format":"date-time"},"lastOrderDate":{"type":"string"},"lastOrderRef":{"type":"string"},"lifetimeOrderValue":{"type":"string"},"location":{"type":"string","description":"location"},"loyaltyTier":{"type":"string"},"marketing_optin_level":{"type":"string","enum":["single_opt_in","confirmed_opt_in","unknown"]},"marketing_preferences_updated_at":{"type":"string","format":"date-time"},"memberSince":{"type":"string"},"mobile":{"type":"string"},"optin_preferences":{"$ref":"#/components/schemas/OptinPreferencesDto"},"phone":{"type":"string"},"preferredStore":{"type":"string"},"privacy":{"type":"boolean"},"running12monthSpend":{"type":"number"},"sex":{"type":"string"},"spendToNextTier":{"type":"string"},"taxExempt":{"type":"boolean","description":"tax_exempt"},"taxExemptions":{"type":"array","description":"tax_exemptions","items":{"type":"string"}},"title":{"type":"string"},"totalOrders":{"type":"string"},"totalSpend":{"type":"number"},"verified_email":{"type":"boolean"},"vipStatus":{"type":"boolean"},"work":{"type":"string"}},"title":"CustomerDto"},"AddressDto":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"addressName":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"country":{"type":"string"},"countryCode":{"type":"string"},"defaultAddress":{"type":"boolean","description":"default_address"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"postcode":{"type":"string"},"province":{"type":"string"},"provinceCode":{"type":"string"}},"title":"AddressDto"},"AttributeGroupDto":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"}},"title":"AttributeGroupDto"},"OptinPreferencesDto":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/OptinValuesDto"},"sms":{"$ref":"#/components/schemas/OptinValuesDto"}},"title":"OptinPreferencesDto"},"OptinValuesDto":{"type":"object","properties":{"opt_in_active":{"type":"boolean"},"opt_in_updated_at":{"type":"string","format":"date-time"},"opted_in_at":{"type":"string","format":"date-time"}},"title":"OptinValuesDto"}}}}
```

## The OptinPreferencesDto object

```json
{"openapi":"3.0.3","info":{"title":"Customer REST API","version":"0.0.1"},"components":{"schemas":{"OptinPreferencesDto":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/OptinValuesDto"},"sms":{"$ref":"#/components/schemas/OptinValuesDto"}},"title":"OptinPreferencesDto"},"OptinValuesDto":{"type":"object","properties":{"opt_in_active":{"type":"boolean"},"opt_in_updated_at":{"type":"string","format":"date-time"},"opted_in_at":{"type":"string","format":"date-time"}},"title":"OptinValuesDto"}}}}
```

## The OptinValuesDto object

```json
{"openapi":"3.0.3","info":{"title":"Customer REST API","version":"0.0.1"},"components":{"schemas":{"OptinValuesDto":{"type":"object","properties":{"opt_in_active":{"type":"boolean"},"opt_in_updated_at":{"type":"string","format":"date-time"},"opted_in_at":{"type":"string","format":"date-time"}},"title":"OptinValuesDto"}}}}
```