HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
Guides
These docs are for v2024.02. Click to read the latest docs for v2024.08.01.

SERVICE_PRODUCT_CREATE

{
  "type" : "object",
  "description": "Data used for SERVICE_PRODUCT_CREATE and SERVICE_PRODUCT_UPDATE",
  "properties" : {
    "itemCode" : {
      "type" : "string"
    },
    "itemName" : {
      "type" : "string"
    },
    "itemType" : {
      "type" : "string",
      "enum" : [ "PPV", "SUBSCRIPTION", "ACCESS_PASS", "STOCK" ]
    },
    "active" : {
      "type" : "boolean"
    },
    "activationDate" : {
      "type" : "string",
      "format" : "date-time"
    },
    "deactivationDate" : {
      "type" : "string",
      "format" : "date-time"
    },
    "catalogueCategories" : {
      "type" : "array",
      "items" : {
        "type" : "any"
      }
    },
    "minimumTerm" : {
      "type" : "any"
    },
    "freeTrial" : {
      "type" : "any"
    },
    "frequency" : {
      "type" : "any"
    },
    "prices" : {
      "type" : "array",
      "items" : {
        "type" : "any"
      }
    },
    "subscription" : {
      "type" : "object",
      "properties" : {
        "itemCode" : {
          "type" : "string"
        },
        "itemName" : {
          "type" : "string"
        },
        "entitlementIds" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "entitlements" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "properties" : {
              "id" : {
                "type" : "string"
              },
              "name" : {
                "type" : "string"
              }
            }
          }
        },
        "vcn" : {
          "type" : "integer"
        }
      }
    },
    "ppv" : {
      "type" : "object",
      "properties" : {
        "itemCode" : {
          "type" : "string"
        },
        "itemName" : {
          "type" : "string"
        },
        "entitlementIds" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "entitlements" : {
          "type" : "array",
          "items" : {
            "type" : "object",
          }
        },
        "itemDataId" : {
          "type" : "string"
        },
        "itemDataName" : {
          "type" : "string"
        },
        "vcn" : {
          "type" : "integer"
        }
      }
    },
    "accessPass" : {
      "type" : "object",
      "properties" : {
        "itemCode" : {
          "type" : "string"
        },
        "itemName" : {
          "type" : "string"
        },
        "entitlementIds" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "entitlements" : {
          "type" : "array",
          "items" : {
            "type" : "object",
          }
        },
        "itemDataId" : {
          "type" : "string"
        },
        "itemDataName" : {
          "type" : "string"
        },
        "groupName" : {
          "type" : "string"
        },
        "startTime" : {
          "type" : "string",
          "format" : "date-time"
        },
        "endTime" : {
          "type" : "string",
          "format" : "date-time"
        },
        "hoursDuration" : {
          "type" : "integer"
        }
      }
    }
  },
  "required": ["itemCode", "itemName", "itemType", "active", "prices" ]
}