> 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/wishlist-rest-api/models.md).

# Models

## The AddressDto object

```json
{"openapi":"3.0.3","info":{"title":"Wishlist 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"},"customerId":{"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":"Wishlist REST API","version":"0.0.1"},"components":{"schemas":{"AttributeGroupDto":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"}},"title":"AttributeGroupDto"}}}}
```

## The CustomerAttributeGroupDto object

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

## The CustomerDto object

```json
{"openapi":"3.0.3","info":{"title":"Wishlist 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"}},"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomerAttributeGroupDto"}},"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","format":"date-time"},"email":{"type":"string"},"firstName":{"type":"string","description":"first_name"},"id":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastName":{"type":"string","description":"last_name"},"marketing_optin_level":{"type":"string","enum":["single_opt_in","confirmed_opt_in","unknown"]},"marketing_preferences_updated_at":{"type":"string","format":"date-time"},"mobile":{"type":"string"},"phone":{"type":"string"},"taxExempt":{"type":"boolean","description":"tax_exempt"},"taxExemptions":{"type":"array","description":"tax_exemptions","items":{"type":"string"}},"verified_email":{"type":"boolean"}},"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"},"customerId":{"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"},"CustomerAttributeGroupDto":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"}},"title":"CustomerAttributeGroupDto"}}}}
```

## The CustomerWishlistsDto object

```json
{"openapi":"3.0.3","info":{"title":"Wishlist REST API","version":"0.0.1"},"components":{"schemas":{"CustomerWishlistsDto":{"type":"object","properties":{"lastEvaluatedWishlistId":{"type":"string"},"wishlist":{"type":"array","items":{"$ref":"#/components/schemas/WishlistDto"}},"wishlistCount":{"type":"integer","format":"int32"}},"title":"CustomerWishlistsDto"},"WishlistDto":{"type":"object","properties":{"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeGroupDto"}},"createdTime":{"type":"string","format":"date-time"},"customerId":{"type":"string"},"customerRef":{"type":"string"},"deleted":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"isPrivate":{"type":"boolean"},"itemCount":{"type":"integer","format":"int32"},"lastEvaluatedItemId":{"type":"string"},"modifiedTime":{"type":"string","format":"date-time"},"name":{"type":"string"},"wishlistItems":{"type":"array","items":{"$ref":"#/components/schemas/WishlistItemDto"}},"wishlistRef":{"type":"string"}},"title":"WishlistDto"},"AttributeGroupDto":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"}},"title":"AttributeGroupDto"},"WishlistItemDto":{"type":"object","properties":{"addedByStaff":{"type":"boolean"},"addedFromCart":{"type":"boolean"},"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeGroupDto"}},"createdTime":{"type":"string","format":"date-time"},"datePurchased":{"type":"string","format":"date-time"},"disableNotification":{"type":"boolean"},"id":{"type":"string"},"locationId":{"type":"string"},"locationRef":{"type":"string"},"modifiedTime":{"type":"string","format":"date-time"},"notifyMe":{"type":"boolean"},"prerelease":{"type":"boolean"},"product":{"$ref":"#/components/schemas/ProductDto"},"purchased":{"type":"boolean"},"purchasedAndRemoved":{"type":"boolean"},"staffRef":{"type":"string"},"wishlistId":{"type":"string"},"wishlistItemRef":{"type":"string"},"wishlistRef":{"type":"string"}},"title":"WishlistItemDto"},"ProductDto":{"type":"object","properties":{"oldVariantId":{"type":"string"},"oldVariantRef":{"type":"string"},"productId":{"type":"string"},"productRef":{"type":"string"},"selectedVariantId":{"type":"string"},"selectedVariantRef":{"type":"string"}},"title":"ProductDto"}}}}
```

## The ProductDto object

```json
{"openapi":"3.0.3","info":{"title":"Wishlist REST API","version":"0.0.1"},"components":{"schemas":{"ProductDto":{"type":"object","properties":{"oldVariantId":{"type":"string"},"oldVariantRef":{"type":"string"},"productId":{"type":"string"},"productRef":{"type":"string"},"selectedVariantId":{"type":"string"},"selectedVariantRef":{"type":"string"}},"title":"ProductDto"}}}}
```

## The WishlistDto object

```json
{"openapi":"3.0.3","info":{"title":"Wishlist REST API","version":"0.0.1"},"components":{"schemas":{"WishlistDto":{"type":"object","properties":{"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeGroupDto"}},"createdTime":{"type":"string","format":"date-time"},"customerId":{"type":"string"},"customerRef":{"type":"string"},"deleted":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"isPrivate":{"type":"boolean"},"itemCount":{"type":"integer","format":"int32"},"lastEvaluatedItemId":{"type":"string"},"modifiedTime":{"type":"string","format":"date-time"},"name":{"type":"string"},"wishlistItems":{"type":"array","items":{"$ref":"#/components/schemas/WishlistItemDto"}},"wishlistRef":{"type":"string"}},"title":"WishlistDto"},"AttributeGroupDto":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"}},"title":"AttributeGroupDto"},"WishlistItemDto":{"type":"object","properties":{"addedByStaff":{"type":"boolean"},"addedFromCart":{"type":"boolean"},"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeGroupDto"}},"createdTime":{"type":"string","format":"date-time"},"datePurchased":{"type":"string","format":"date-time"},"disableNotification":{"type":"boolean"},"id":{"type":"string"},"locationId":{"type":"string"},"locationRef":{"type":"string"},"modifiedTime":{"type":"string","format":"date-time"},"notifyMe":{"type":"boolean"},"prerelease":{"type":"boolean"},"product":{"$ref":"#/components/schemas/ProductDto"},"purchased":{"type":"boolean"},"purchasedAndRemoved":{"type":"boolean"},"staffRef":{"type":"string"},"wishlistId":{"type":"string"},"wishlistItemRef":{"type":"string"},"wishlistRef":{"type":"string"}},"title":"WishlistItemDto"},"ProductDto":{"type":"object","properties":{"oldVariantId":{"type":"string"},"oldVariantRef":{"type":"string"},"productId":{"type":"string"},"productRef":{"type":"string"},"selectedVariantId":{"type":"string"},"selectedVariantRef":{"type":"string"}},"title":"ProductDto"}}}}
```

## The WishlistItemDto object

```json
{"openapi":"3.0.3","info":{"title":"Wishlist REST API","version":"0.0.1"},"components":{"schemas":{"WishlistItemDto":{"type":"object","properties":{"addedByStaff":{"type":"boolean"},"addedFromCart":{"type":"boolean"},"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeGroupDto"}},"createdTime":{"type":"string","format":"date-time"},"datePurchased":{"type":"string","format":"date-time"},"disableNotification":{"type":"boolean"},"id":{"type":"string"},"locationId":{"type":"string"},"locationRef":{"type":"string"},"modifiedTime":{"type":"string","format":"date-time"},"notifyMe":{"type":"boolean"},"prerelease":{"type":"boolean"},"product":{"$ref":"#/components/schemas/ProductDto"},"purchased":{"type":"boolean"},"purchasedAndRemoved":{"type":"boolean"},"staffRef":{"type":"string"},"wishlistId":{"type":"string"},"wishlistItemRef":{"type":"string"},"wishlistRef":{"type":"string"}},"title":"WishlistItemDto"},"AttributeGroupDto":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"}},"title":"AttributeGroupDto"},"ProductDto":{"type":"object","properties":{"oldVariantId":{"type":"string"},"oldVariantRef":{"type":"string"},"productId":{"type":"string"},"productRef":{"type":"string"},"selectedVariantId":{"type":"string"},"selectedVariantRef":{"type":"string"}},"title":"ProductDto"}}}}
```

## The WishlistItemsDto object

```json
{"openapi":"3.0.3","info":{"title":"Wishlist REST API","version":"0.0.1"},"components":{"schemas":{"WishlistItemsDto":{"type":"object","properties":{"itemCount":{"type":"integer","format":"int32"},"lastEvaluatedItemId":{"type":"string"},"wishlistItems":{"type":"array","items":{"$ref":"#/components/schemas/WishlistItemDto"}}},"title":"WishlistItemsDto"},"WishlistItemDto":{"type":"object","properties":{"addedByStaff":{"type":"boolean"},"addedFromCart":{"type":"boolean"},"attributeGroups":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeGroupDto"}},"createdTime":{"type":"string","format":"date-time"},"datePurchased":{"type":"string","format":"date-time"},"disableNotification":{"type":"boolean"},"id":{"type":"string"},"locationId":{"type":"string"},"locationRef":{"type":"string"},"modifiedTime":{"type":"string","format":"date-time"},"notifyMe":{"type":"boolean"},"prerelease":{"type":"boolean"},"product":{"$ref":"#/components/schemas/ProductDto"},"purchased":{"type":"boolean"},"purchasedAndRemoved":{"type":"boolean"},"staffRef":{"type":"string"},"wishlistId":{"type":"string"},"wishlistItemRef":{"type":"string"},"wishlistRef":{"type":"string"}},"title":"WishlistItemDto"},"AttributeGroupDto":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"}},"description":{"type":"string"}},"title":"AttributeGroupDto"},"ProductDto":{"type":"object","properties":{"oldVariantId":{"type":"string"},"oldVariantRef":{"type":"string"},"productId":{"type":"string"},"productRef":{"type":"string"},"selectedVariantId":{"type":"string"},"selectedVariantRef":{"type":"string"}},"title":"ProductDto"}}}}
```