Docs
Management API
Wishlists

Wishlist

Create and manage customer wishlists and wishlist items.

Additional Information

Get All Wishlists

GET /wishlists

Request

Returns a list of wishlists. Optional filter parameters can be passed in.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • customer_id in query - integer
    All wishlists relating to the customer.
  • page in query with default of 1 - integer
    The page number of results to return. 1 is the default and starts from record 0. Use in conjunction with the limit query parameter to request a specific set of records.
  • limit in query with default of 50 - integer
    The number of items to return per page. Default is 50 and maximum is 250.
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

example

Response

Body

object | application/json

  • data    array[object]

  • meta    object

example

Create a Wishlist

POST /wishlists

Request

Creates a wishlist and wishlist item. More than one item can be added in the POST.

Required Fields

  • name
  • customer_id

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • customer_id    integer
    required

    The customer id.
    Example: 12

  • is_public    boolean

    Whether the wishlist is available to the public.

  • name    string

    The title of the wishlist.
    Example: School Shopping

  • items    array[object]

    Array of wishlist items.

example

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

Get a Wishlist

GET /wishlists/{wishlist_id}

Request

Returns a single wishlist.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • wishlist_id in path - integer
    required
    ID of the Wishlist.
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

example

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

Update a Wishlist

PUT /wishlists/{wishlist_id}

Request

Updates a wishlist.

Use this endpoint to update existing wishlist items, change the wishlistʼs name and whether the wishlist is available publicly. To add or delete a wishlist item, see Wishlist Items.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • wishlist_id in path - integer
    required
    ID of the Wishlist.
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • customer_id    integer
    required

    The customer ID. A read-only value.

  • is_public    boolean

    Whether the wishlist is available to the public.

  • name    string

    The title of the wishlist.

  • items    array[object]
    required

    Array of wishlist items.

example

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

Delete a Wishlist

DELETE /wishlists/{wishlist_id}

Request

Deletes a wishlist.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • wishlist_id in path - integer
    required
    ID of the Wishlist.
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

example

Response

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Update Tax SettingsGet All Wishlists