PayPal · Schema

Create Product Request

The create product request details.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
id	string	The ID of the product. You can specify the SKU for the product. If you omit the ID, the system generates it. System-generated IDs have the `PROD-` prefix.
name	string	The product name.
description	string	The product description.
type	string	The product type. Indicates whether the product is physical or digital goods, or a service.
category	object
image_url	string	The image URL for the product.
home_url	string	The home page URL for the product.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/product_request_POST",
  "title": "Create Product Request",
  "description": "The create product request details.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the product. You can specify the SKU for the product. If you omit the ID, the system generates it. System-generated IDs have the `PROD-` prefix.",
      "minLength": 6,
      "maxLength": 50
    },
    "name": {
      "type": "string",
      "description": "The product name.",
      "minLength": 1,
      "maxLength": 127
    },
    "description": {
      "type": "string",
      "description": "The product description.",
      "minLength": 1,
      "maxLength": 256
    },
    "type": {
      "type": "string",
      "description": "The product type. Indicates whether the product is physical or digital goods, or a service.",
      "minLength": 1,
      "maxLength": 24,
      "pattern": "^[A-Z_]+$",
      "default": "PHYSICAL",
      "enum": [
        "PHYSICAL",
        "DIGITAL",
        "SERVICE"
      ]
    },
    "category": {
      "$ref": "#/components/schemas/product_category"
    },
    "image_url": {
      "type": "string",
      "format": "uri",
      "minLength": 1,
      "maxLength": 2000,
      "description": "The image URL for the product."
    },
    "home_url": {
      "type": "string",
      "format": "uri",
      "minLength": 1,
      "maxLength": 2000,
      "description": "The home page URL for the product."
    }
  },
  "required": [
    "name",
    "type"
  ]
}