> 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/wishlist-items/createwishlistitem.md).

# createWishListItem

Adds a single wishlist item into an existing wishlist. The wishlist can be identified by either the TWC internal identifier ***id*** (most often), or the ***wishlistRef***, which is the retailer’s own wishlist identifier (which in practice is rarely used).

To create a wishlist item, you need to provide either of the following:

* BOTH the TWC product identifier AND TWC variant identifer (i.e. the TWC productID and variantID which you can get from TWC in a prior call), OR
* BOTH your own internal product identifier AND variant identifer (i.e. productRef and variantRef).

```json
{"openapi":"3.0.3","info":{"title":"Wishlist REST API","version":"0.0.1"},"tags":[{"name":"wishlist-items","description":"Add, update, remove and query the items on a wishlist."}],"servers":[{"url":"https://api.au-aws.thewishlist.io/services/wsservice"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","description":"OAuth2 bearer token issued by TWC Keycloak, sent as `Bearer <token>`."}},"parameters":{"productId":{"name":"productId","in":"query","required":false,"description":"TWC's unique parent product identifier.  (We recommend using endpoints with productRef, which is the retailer's own product identifier, and for Shopify users is automatically loaded into TWC as the Shopify product identifier)","schema":{"type":"string"}},"variantId":{"name":"variantId","in":"query","required":false,"description":"TWC's unique variant identifier.  (We recommend using endpoints with variantRef, which is the retailer's own variant identifier, and the Shopify variant ID where the retailer is using Shopify, and automatically loaded into TWC)","schema":{"type":"string"}},"productRef":{"name":"productRef","in":"query","required":false,"description":"The retailer's unique identifier for a parent product.   For Shopify this is the Shopify product id.","schema":{"type":"string"}},"variantRef":{"name":"variantRef","in":"query","required":false,"description":"The retailer's unique identifier for a product variant.  For Shopify this is the variant ID.","schema":{"type":"string"}},"X-TWC-Tenant-2":{"name":"X-TWC-Tenant","in":"header","required":false,"description":"tenant-key (your retail store's unique identifier in TWC)","schema":{"type":"string"}}},"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"}}},"paths":{"/api/wishlist/items":{"post":{"summary":"createWishListItem","operationId":"createWishListItemUsingPOST","parameters":[{"$ref":"#/components/parameters/productId"},{"$ref":"#/components/parameters/variantId"},{"$ref":"#/components/parameters/productRef"},{"$ref":"#/components/parameters/variantRef"},{"$ref":"#/components/parameters/X-TWC-Tenant-2"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addedByStaff":{"type":"boolean"},"addedFromCart":{"type":"boolean"},"attributeGroups":{"type":"object","properties":{"property1":{"type":"object","properties":{"attributes":{"type":"object","properties":{"property1":{"type":"string"},"property2":{"type":"string"}}},"description":{"type":"string"}}},"property2":{"type":"object","properties":{"attributes":{"type":"object","properties":{"property1":{"type":"string"},"property2":{"type":"string"}}},"description":{"type":"string"}}}}},"disableNotification":{"type":"boolean"},"locationId":{"type":"string"},"locationRef":{"type":"string"},"notifyMe":{"type":"boolean"},"prerelease":{"type":"boolean"},"product":{"type":"object","properties":{"oldVariantId":{"type":"string"},"oldVariantRef":{"type":"string"},"productId":{"type":"string"},"productRef":{"type":"string"},"selectedVariantId":{"type":"string"},"selectedVariantRef":{"type":"string"}}},"purchasedAndRemoved":{"type":"boolean"},"staffRef":{"type":"string"},"wishlistId":{"type":"string"},"wishlistItemRef":{"type":"string"},"wishlistRef":{"type":"string"}}}}},"description":"wishlistItemDto","required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WishlistItemDto"}}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false,"description":"Adds a single wishlist item into an existing wishlist. The wishlist can be identified by either the TWC internal identifier ***id*** (most often),  or the ***wishlistRef***, which is the retailer’s own wishlist identifier (which in practice is rarely used).\n\nTo create a wishlist item, you need to provide either of the following:\n\n- BOTH the TWC product identifier AND TWC variant identifer (i.e. the TWC productID and variantID which you can get from TWC in a prior call), OR\n- BOTH your own internal product identifier AND variant identifer (i.e. productRef and variantRef).","tags":["wishlist-items"]}}}}
```