BigCommerce · Schema

wishlist_Post

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
customer_id integer The customer id.
is_public boolean Whether the wishlist is available to the public.
name string The title of the wishlist.
items array Array of wishlist items.
View JSON Schema on GitHub

JSON Schema

bigcommerce-wishlist-post-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/wishlist_Post",
  "title": "wishlist_Post",
  "required": [
    "customer_id"
  ],
  "type": "object",
  "properties": {
    "customer_id": {
      "type": "integer",
      "description": "The customer id.",
      "format": "int32",
      "example": 12
    },
    "is_public": {
      "type": "boolean",
      "description": "Whether the wishlist is available to the public.",
      "example": false
    },
    "name": {
      "type": "string",
      "description": "The title of the wishlist.",
      "example": "School Shopping"
    },
    "items": {
      "type": "array",
      "description": "Array of wishlist items.",
      "items": {
        "title": "Add item to wishlist",
        "type": "object",
        "properties": {
          "product_id": {
            "type": "integer",
            "description": "The ID of the product.",
            "format": "int32",
            "example": 12
          },
          "variant_id": {
            "type": "integer",
            "description": "The variant ID of the product.",
            "format": "int32",
            "example": 152
          }
        }
      }
    }
  },
  "x-internal": false
}