DocsDocsReference

Create or get share token for wishlist

Generate a shareable token for a wishlist. Returns existing valid token if one exists (otherwise creates a new one). The expires_at field is optional (can be null for no expiration, or a timestamp).

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

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

Generate a shareable token for a wishlist. Returns existing valid token if one exists (otherwise creates a new one). The expires_at field is optional (can be null for no expiration, or a timestamp).

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\}/share
  • Summary: Create or get share token for wishlist
  • Description: Generate a shareable token for a wishlist. Returns existing valid token if one exists (otherwise creates a new one). The expires_at field is optional (can be null for no expiration, or a timestamp).
  • 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: Share token request (expires_at can be null or a timestamp)
  • Content: application/json (object)

Create Wishlist Share Request

PropertyTypeRequiredDetails
expires_atstringNo-

Generated example (synthetic):

{
  "expires_at": "string"
}
Responses5 statuses
StatusDescriptionContent
200OKapplication/json (object)
400Invalid request or expiration timeapplication/json (object)
401Unauthorizedapplication/json (object)
404Wishlist not foundapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Wishlist Share Token

PropertyTypeRequiredDetails
created_atstringNo-
expires_atstringNo-
tokenstringNo-
wishlist_idstringNo-

Generated example (synthetic):

{
  "created_at": "string",
  "expires_at": "string",
  "token": "string",
  "wishlist_id": "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\}/share
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Wishlist
  • OpenAPI summary: Create or get share token for wishlist

Create or get share token for wishlist

# Create or get share token for wishlist Generate a shareable token for a wishlist. Returns existing valid token if one exists (otherwise creates a new one). The expires_at field is optional (can be null for no expiration, or a timestamp).
POST /api/v1/{app_id}/wishlists/{id}/share
Purpose

Generate a shareable token for a wishlist.

Required inputs

app_id path id path

Primary response

200 ยท OK

Operation key

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

## 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}/share` - Summary: Create or get share token for wishlist - Description: Generate a shareable token for a wishlist. Returns existing valid token if one exists (otherwise creates a new one). The expires_at field is optional (can be null for no expiration, or a timestamp). - OpenAPI contract: auth-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `auth-api:POST:/api/v1/{app_id}/wishlists/{id}/share` 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: Share token request (expires_at can be null or a timestamp) - Content: application/json (object) ### Create Wishlist Share Request | Property | Type | Required | Details | | --- | --- | --- | --- | | `expires_at` | string | No | - | **Generated example (synthetic):** ```json { "expires_at": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | OK | application/json (object) | | 400 | Invalid request or expiration time | application/json (object) | | 401 | Unauthorized | application/json (object) | | 404 | Wishlist not found | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Wishlist Share Token | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `expires_at` | string | No | - | | `token` | string | No | - | | `wishlist_id` | string | No | - | **Generated example (synthetic):** ```json { "created_at": "string", "expires_at": "string", "token": "string", "wishlist_id": "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}/share` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `auth-api:POST:/api/v1/{app_id}/wishlists/{id}/share` - OpenAPI tag: Wishlist - OpenAPI summary: Create or get share token for wishlist