Wishlists
API calls
Endpoint: /wishlists
| Endpoint | Method | Payload |
|---|---|---|
/wishlists/:wishlist |
GET |
|
/wishlists/:wishlist/entries/:entry |
GET |
|
| /wishlists | POST |
wishlist payload |
/wishlists/:wishlist/entries |
POST |
wishlist entry payload |
/wishlists/:wishlist |
PUT |
update wishlist payload |
/wishlists/:wishlist/entries/:entry |
PUT |
update wishlist entry payload |
/wishlists/:wishlist |
DELETE |
|
/wishlists/:wishlist/entries/:entry |
DELETE |
Wishlist payload
{
name*: string,
total*,
discount: nullable,
entries: [{
amount*,
product_id*: int,
product_name*,
product_price*,
product_sku*: int,
product_url*,
variables: [{
id*: int,
name*: string,
required*: boolean,
type*,
options: [{
id*: int,
type*,
name*,
price*,
}]
}],
category*
}]^
}*required ^ all required only if entries present
Wishlist entry payload
{
product_id*: int|(product/id)**,
amount: int,
options: array
}*required
** must exist in table/column
Update wishlist payload
{
name*: string
}*required
Update wishlist entry payload
{
amount: int|(min:1),
options: array
}*required