Add items to wishlist

Add one or more items to a wishlist for the authenticated user

POST/api/v1/{app_id}/wishlists/{id}/items
API
Auth
OpenAPI
auth-api
Updated
Apr 26, 2026

auth-api:POST:/api/v1/{app_id}/wishlists/{id}/items

Add one or more items to a wishlist for the authenticated user

API ownership

  • API family: Auth API
  • Best for: Customer identity, session, token, cart, and wishlist flows.
  • Do not use from: Merchant admin data syncs or public catalog rendering.
  • Guide route: /apis/auth/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{app_id\}/wishlists/\{id\}/items
  • Summary: Add items to wishlist
  • Description: Add one or more items to a wishlist for the authenticated user
  • OpenAPI contract: auth-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters
NameInRequiredTypeDescription
app_idpathYesstringUUID of the app
idpathYesstringUUID of the wishlist
Request bodyDocumented body
  • Required: Yes
  • Description: Items to add
  • Content: application/json (object)

Add Wishlist Items Request

PropertyTypeRequiredDetails
product_idsstring[]YesminItems: 1

Generated example (synthetic):

{
  "product_ids": [
    "string"
  ]
}
Responses5 statuses
StatusDescriptionContent
200Items added successfullyapplication/json (object)
400Invalid requestapplication/json (object)
401Unauthorizedapplication/json (object)
404Wishlist not foundapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Message

PropertyTypeRequiredDetails
messagestringNo-

Generated example (synthetic):

{
  "message": "string"
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

404 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Auth API
  • Method: POST
  • Path: /api/v1/\{app_id\}/wishlists/\{id\}/items
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Wishlist
  • OpenAPI summary: Add items to wishlist

Add items to wishlist

# Add items to wishlist Add one or more items to a wishlist for the authenticated user
POST /api/v1/{app_id}/wishlists/{id}/items
Purpose

Add one or more items to a wishlist for the authenticated user

Required inputs

app_id path id path

Primary response

200 ยท Items added successfully

Operation key

auth-api:POST:/api/v1/{app_id}/wishlists/{id}/items

## API ownership - API family: Auth API - Best for: Customer identity, session, token, cart, and wishlist flows. - Do not use from: Merchant admin data syncs or public catalog rendering. - Guide route: [/apis/auth/latest](/apis/auth/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{app_id}/wishlists/{id}/items` - Summary: Add items to wishlist - Description: Add one or more items to a wishlist for the authenticated user - OpenAPI contract: auth-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `auth-api:POST:/api/v1/{app_id}/wishlists/{id}/items` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_id | path | Yes | string | UUID of the app | | id | path | Yes | string | UUID of the wishlist | ## Request body - Required: Yes - Description: Items to add - Content: application/json (object) ### Add Wishlist Items Request | Property | Type | Required | Details | | --- | --- | --- | --- | | `product_ids` | string[] | Yes | minItems: 1 | **Generated example (synthetic):** ```json { "product_ids": [ "string" ] } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Items added successfully | application/json (object) | | 400 | Invalid request | application/json (object) | | 401 | Unauthorized | application/json (object) | | 404 | Wishlist not found | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `message` | string | No | - | **Generated example (synthetic):** ```json { "message": "string" } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 404 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Auth API - Method: `POST` - Path: `/api/v1/{app_id}/wishlists/{id}/items` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `auth-api:POST:/api/v1/{app_id}/wishlists/{id}/items` - OpenAPI tag: Wishlist - OpenAPI summary: Add items to wishlist