Skip to content

rapidez/multiple-wishlists

Repository files navigation

Rapidez Multiple Wishlist

Installation

composer require rapidez/multiple-wishlists

It's not recommended to publish every view, rather you should overwrite only the files necessary. However, you can still publish all of the views with the following command:

php artisan vendor:publish --provider="Rapidez\MultipleWishlist\MultipleWishlistServiceProvider" --tag=views

You also should probably add a new "wishlists" button to the Rapidez account menu, if you use it in your project (which is in rapidez/account/resources/views/partials/menu.blade.php)

API endpoints

The API uses mostly Laravel apiResource endpoints. All of the exposed endpoints can be found below. Note that every request except for GET /wishlists/shared/{token} requires a bearer token header for authorization. This is the magento oauth token of the customer.

Endpoint Parameters Description
GET /wishlists/ None Gets a list of all the customer's wishlists
POST /wishlists/
  • title
Creates a new wishlist with the given title
PATCH /wishlists/{id}
  • title(str, max 255)
  • description(str, max 65535)
  • share(bool)
Updates the data of a wishlist
DELETE /wishlists/{id} None Deletes a wishlist
GET /wishlists/shared/{token} None Gets a shared wishlist
Endpoint Parameters Description
POST /wishlists/item
  • wishlist_id(int)
  • product_id(int)
  • qty(int)
Adds a new item to the given wishlist
PATCH /wishlists/item/{id}
  • description(str, max 255)
  • qty(int)
Updates the data of an item
DELETE /wishlists/item/{id} None Deletes an item