openapi: 3.1.0
info:
  title: 'Admin Management: Wishlists'
  version: 1.0.0
paths:
  /stores/{store_hash}/v3/wishlists:
    get:
      operationId: getWishlists
      summary: List Wishlists
      description: Returns a list of wishlists. Optional filter parameters can be passed in.
      tags:
        - wishlists
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: customer_id
          in: query
          description: All wishlists relating to the customer.
          required: false
          schema:
            type: integer
        - name: page
          in: query
          description: >-
            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.
          required: false
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          description: The number of items to return per page. Default is 50 and maximum is 250.
          required: false
          schema:
            type: integer
            default: 50
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Customers | modify | `store_v2_customers` |

            |  Customers | read-only | `store_v2_customers_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Wishlists_getWishlists_Response_200'
        '401':
          description: Authentication information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWishlistsRequestUnauthorizedError'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWishlistsRequestInternalServerError'
    post:
      operationId: createWishlist
      summary: Create Wishlist
      description: |-
        Creates a wishlist and wishlist item. More than one item can be added in the POST.

        **Required Fields**
        * name
        * customer_id
      tags:
        - wishlists
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Customers | modify | `store_v2_customers` |

            |  Customers | read-only | `store_v2_customers_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Wishlists_createWishlist_Response_201'
        '401':
          description: Authentication information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWishlistRequestUnauthorizedError'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWishlistRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/wishlist_Post'
  /stores/{store_hash}/v3/wishlists/{wishlist_id}:
    get:
      operationId: getWishlist
      summary: Get Wishlist
      description: Returns a single wishlist.
      tags:
        - wishlists
      parameters:
        - name: wishlist_id
          in: path
          description: ID of the Wishlist.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Customers | modify | `store_v2_customers` |

            |  Customers | read-only | `store_v2_customers_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Wishlists_getWishlist_Response_200'
        '401':
          description: Authentication information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWishlistRequestUnauthorizedError'
        '404':
          description: Wishlist not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWishlistRequestNotFoundError'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWishlistRequestInternalServerError'
    put:
      operationId: updateWishlist
      summary: Update Wishlist
      description: >-
        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](/developer/api-reference/rest/admin/management/wishlists/wishlists-items).
      tags:
        - wishlists
      parameters:
        - name: wishlist_id
          in: path
          description: ID of the Wishlist.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Customers | modify | `store_v2_customers` |

            |  Customers | read-only | `store_v2_customers_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Wishlists_updateWishlist_Response_201'
        '401':
          description: Authentication information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWishlistRequestUnauthorizedError'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWishlistRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/wishlist_Put'
    delete:
      operationId: deleteWishlist
      summary: Delete Wishlist
      description: Deletes a wishlist.
      tags:
        - wishlists
      parameters:
        - name: wishlist_id
          in: path
          description: ID of the Wishlist.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Customers | modify | `store_v2_customers` |

            |  Customers | read-only | `store_v2_customers_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Authentication information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWishlistRequestUnauthorizedError'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWishlistRequestInternalServerError'
  /stores/{store_hash}/v3/wishlists/{wishlist_id}/items/{item_id}:
    delete:
      operationId: deleteWishlistItem
      summary: Delete Wishlist Item
      description: Deletes a wishlist item.
      tags:
        - wishlistsItems
      parameters:
        - name: wishlist_id
          in: path
          description: ID of the Wishlist.
          required: true
          schema:
            type: integer
        - name: item_id
          in: path
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Customers | modify | `store_v2_customers` |

            |  Customers | read-only | `store_v2_customers_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Wishlists Items_deleteWishlistItem_Response_200'
        '401':
          description: Authentication information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWishlistItemRequestUnauthorizedError'
        '404':
          description: Wishlist not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWishlistItemRequestNotFoundError'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWishlistItemRequestInternalServerError'
  /stores/{store_hash}/v3/wishlists/{wishlist_id}/items:
    post:
      operationId: addWishlistItem
      summary: Add Wishlist Item
      description: Adds a wishlist item. More than one item can be added at a time.
      tags:
        - wishlistsItems
      parameters:
        - name: wishlist_id
          in: path
          description: ID of the Wishlist.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Customers | modify | `store_v2_customers` |

            |  Customers | read-only | `store_v2_customers_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Wishlists Items_addWishlistItem_Response_201'
        '401':
          description: Authentication information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddWishlistItemRequestUnauthorizedError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/wishlistItem_Post'
servers:
  - url: https://api.bigcommerce.com
    description: https://api.bigcommerce.com
components:
  schemas:
    wishlistItem_Full:
      type: object
      properties:
        id:
          type: integer
          description: The ID of the item.
        product_id:
          type: integer
          description: The ID of the product.
        variant_id:
          type: integer
          description: The variant ID of the product.
      title: wishlistItem_Full
    wishlist_Full:
      type: object
      properties:
        id:
          type: integer
          description: Wishlist ID, provided after creating a wishlist with a POST.
        customer_id:
          type: integer
          description: The ID the customer to which the wishlist belongs.
        name:
          type: string
          description: The name of the wishlist.
        is_public:
          type: boolean
          description: Whether the wishlist is available to the public.
        token:
          type: string
          format: uuid
          description: >-
            The token of the wishlist. This is created internally within BigCommerce. The wishlist ID is to be used for
            external apps. Read-Only.
        items:
          type: array
          items:
            $ref: '#/components/schemas/wishlistItem_Full'
          description: Array of wishlist items.
      title: wishlist_Full
    pagination:
      type: object
      properties:
        total:
          type: integer
          description: Total number of items in the result set.
        count:
          type: integer
          description: Total number of items in the collection response.
        per_page:
          type: integer
          description: The amount of items returned in the collection per page, controlled by the limit parameter.
        current_page:
          type: integer
          description: The page you are currently on within the collection.
        total_pages:
          type: integer
          description: The total number of pages in the collection.
      description: Data about the response, including pagination and collection totals.
      title: pagination
    metaCollection:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/pagination'
      title: metaCollection
    Wishlists_getWishlists_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/wishlist_Full'
        meta:
          $ref: '#/components/schemas/metaCollection'
      title: Wishlists_getWishlists_Response_200
    GetWishlistsRequestUnauthorizedError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: GetWishlistsRequestUnauthorizedError
    GetWishlistsRequestInternalServerError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: GetWishlistsRequestInternalServerError
    WishlistPostItemsItems:
      type: object
      properties:
        product_id:
          type: integer
          description: The ID of the product.
        variant_id:
          type: integer
          description: The variant ID of the product.
      title: WishlistPostItemsItems
    wishlist_Post:
      type: object
      properties:
        customer_id:
          type: integer
          description: The customer id.
        is_public:
          type: boolean
          description: Whether the wishlist is available to the public.
        name:
          type: string
          description: The title of the wishlist.
        items:
          type: array
          items:
            $ref: '#/components/schemas/WishlistPostItemsItems'
          description: Array of wishlist items.
      required:
        - customer_id
      title: wishlist_Post
    WishlistsPostResponsesContentApplicationJsonSchemaMeta:
      type: object
      properties: {}
      description: Response metadata.
      title: WishlistsPostResponsesContentApplicationJsonSchemaMeta
    Wishlists_createWishlist_Response_201:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/wishlist_Full'
        meta:
          $ref: '#/components/schemas/WishlistsPostResponsesContentApplicationJsonSchemaMeta'
          description: Response metadata.
      title: Wishlists_createWishlist_Response_201
    CreateWishlistRequestUnauthorizedError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: CreateWishlistRequestUnauthorizedError
    CreateWishlistRequestInternalServerError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: CreateWishlistRequestInternalServerError
    WishlistsWishlistIdGetResponsesContentApplicationJsonSchemaMeta:
      type: object
      properties: {}
      description: Response metadata.
      title: WishlistsWishlistIdGetResponsesContentApplicationJsonSchemaMeta
    Wishlists_getWishlist_Response_200:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/wishlist_Full'
        meta:
          $ref: '#/components/schemas/WishlistsWishlistIdGetResponsesContentApplicationJsonSchemaMeta'
          description: Response metadata.
      title: Wishlists_getWishlist_Response_200
    GetWishlistRequestUnauthorizedError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: GetWishlistRequestUnauthorizedError
    GetWishlistRequestNotFoundError:
      type: object
      properties: {}
      title: GetWishlistRequestNotFoundError
    GetWishlistRequestInternalServerError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: GetWishlistRequestInternalServerError
    WishlistPutItemsItems:
      type: object
      properties:
        id:
          type: integer
          description: The ID of the item.
        product_id:
          type: integer
          description: The ID of the product.
        variant_id:
          type: integer
          description: The variant ID of the product.
      title: WishlistPutItemsItems
    wishlist_Put:
      type: object
      properties:
        customer_id:
          type: integer
          description: The customer ID. A read-only value.
        is_public:
          type: boolean
          description: Whether the wishlist is available to the public.
        name:
          type: string
          description: The title of the wishlist.
        items:
          type: array
          items:
            $ref: '#/components/schemas/WishlistPutItemsItems'
          description: Array of wishlist items.
      required:
        - customer_id
        - items
      title: wishlist_Put
    WishlistsWishlistIdPutResponsesContentApplicationJsonSchemaMeta:
      type: object
      properties: {}
      description: Response metadata.
      title: WishlistsWishlistIdPutResponsesContentApplicationJsonSchemaMeta
    Wishlists_updateWishlist_Response_201:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/wishlist_Full'
        meta:
          $ref: '#/components/schemas/WishlistsWishlistIdPutResponsesContentApplicationJsonSchemaMeta'
          description: Response metadata.
      title: Wishlists_updateWishlist_Response_201
    UpdateWishlistRequestUnauthorizedError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: UpdateWishlistRequestUnauthorizedError
    UpdateWishlistRequestInternalServerError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: UpdateWishlistRequestInternalServerError
    DeleteWishlistRequestUnauthorizedError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: DeleteWishlistRequestUnauthorizedError
    DeleteWishlistRequestInternalServerError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: DeleteWishlistRequestInternalServerError
    WishlistsWishlistIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaMeta:
      type: object
      properties: {}
      description: Response metadata.
      title: WishlistsWishlistIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaMeta
    Wishlists Items_deleteWishlistItem_Response_200:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/wishlist_Full'
        meta:
          $ref: '#/components/schemas/WishlistsWishlistIdItemsItemIdDeleteResponsesContentApplicationJsonSchemaMeta'
          description: Response metadata.
      title: Wishlists Items_deleteWishlistItem_Response_200
    DeleteWishlistItemRequestUnauthorizedError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: DeleteWishlistItemRequestUnauthorizedError
    DeleteWishlistItemRequestNotFoundError:
      type: object
      properties: {}
      title: DeleteWishlistItemRequestNotFoundError
    DeleteWishlistItemRequestInternalServerError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: DeleteWishlistItemRequestInternalServerError
    WishlistItemPostItemsItems:
      type: object
      properties:
        product_id:
          type: integer
        variant_id:
          type: integer
      title: WishlistItemPostItemsItems
    wishlistItem_Post:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WishlistItemPostItemsItems'
      title: wishlistItem_Post
    WishlistsWishlistIdItemsPostResponsesContentApplicationJsonSchemaMeta:
      type: object
      properties: {}
      description: Response metadata.
      title: WishlistsWishlistIdItemsPostResponsesContentApplicationJsonSchemaMeta
    Wishlists Items_addWishlistItem_Response_201:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/wishlist_Full'
        meta:
          $ref: '#/components/schemas/WishlistsWishlistIdItemsPostResponsesContentApplicationJsonSchemaMeta'
          description: Response metadata.
      title: Wishlists Items_addWishlistItem_Response_201
    AddWishlistItemRequestUnauthorizedError:
      type: object
      properties:
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      title: AddWishlistItemRequestUnauthorizedError
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        ### OAuth scopes


        | UI Name | Permission | Parameter |

        |:--------|:-----------|:----------|

        |  Customers | modify | `store_v2_customers` |

        |  Customers | read-only | `store_v2_customers_read_only` |


        ### Authentication header


        | Header | Argument | Description |

        |:-------|:---------|:------------|

        | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to
        API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


        ### Further reading


        For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example
        Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


        For more about BigCommerce OAuth scopes, see our [Guide to API
        Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


        For a list of API status codes, see [API Status
        Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
