Body

• title string Required

  Title of the product

  Minimum length is 1, maximum length is 128.

• shortDescription string | null

  Short Description of the product

  Maximum length is 128.

• description string Required

  Description of the product

  Minimum length is 1, maximum length is 8096.

• variants array[object] Required

  At least 1 variant is required

  Hide variants attributes Show variants attributes array[object]

  • id integer(int64) | null

    Pass it only if you are editing the existing variant

  • title string | null

    Title of the variant

  • description string | null

    Description of the variant

  • shortDescription string | null

    Short Description of the variant

  • priceDetails object
    Hide priceDetails attributes Show priceDetails attributes object

    • amount number(double)
    • currency string | null
    • Additional properties are NOT allowed
  • gateways null | array[object]

    Gateways available for this variant

    Hide gateways attributes Show gateways attributes null | array[object]

    • gateway integer(int32)

      " The list of supported payment gateways. CoinbaseCommerce = 0 Stripe = 1 PayPal = 2 CashApp = 3 PayPalFf = 4 VirtualPayments = 5 Square = 6

      "

      Values are 0, 1, 2, 3, 4, 6, 7, 8, or 9.

    • rules object
      Hide rules attributes Show rules attributes object

      • blockVpn boolean
      • Additional properties are NOT allowed
    • price object
      Hide price attributes Show price attributes object

      • amount number(double)
      • currency string | null
      • Additional properties are NOT allowed
    • Additional properties are NOT allowed
  • productType integer(int32)

    " Serials = 0 Dynamic = 2 Service = 3 If you choose serials, you need to provide only asSerials property If you choose dynamic, you need to provide only asDynamic property If you choose service, you need to provide only asService property"

    Values are 0, 2, or 3.

  • asDynamic object
    Hide asDynamic attributes Show asDynamic attributes object

    • stock integer(int32) | null

      Minimum value is 0, maximum value is 2147483647.

    • externalUrl string | null
    • minAmount integer(int32) | null

      Minimum value is 1, maximum value is 2147483647.

    • maxAmount integer(int32) | null

      Minimum value is 1, maximum value is 2147483647.

    • isInternal boolean
    • Additional properties are NOT allowed
  • asSerials object
    Hide asSerials attributes Show asSerials attributes object

    • delimiter string | null
    • serials string | null
    • minAmount integer(int32) | null

      Minimum value is 1, maximum value is 2147483647.

    • maxAmount integer(int32) | null

      Minimum value is 1, maximum value is 2147483647.

    • removeDuplicates boolean
    • Additional properties are NOT allowed
  • asService object
    Hide asService attributes Show asService attributes object

    • stock integer(int32) | null

      Minimum value is 0, maximum value is 2147483647.

    • text string | null
    • minAmount integer(int32) | null

      Minimum value is 1, maximum value is 2147483647.

    • maxAmount integer(int32) | null

      Minimum value is 1, maximum value is 2147483647.

    • Additional properties are NOT allowed
  • customerNote string | null

    This note will be visible to customer after purchase

  • redirectUrl string | null

    Customer will be redirected to this url after purchase

  • customFields array[object] | null

    Custom fields of the variant

    Hide customFields attributes Show customFields attributes array[object] | null

    • id integer(int64)
    • type integer(int32) Required

      Values are 1, 2, 3, 4, or 5.

    • name string Required

      Minimum length is 1, maximum length is 64.

    • required boolean Required
    • valueString string | null
    • placeholder string | null
    • regex string | null
    • valueInt integer(int32) | null
    • valueBool boolean | null
    • Additional properties are NOT allowed
  • warranty object
    Hide warranty attributes Show warranty attributes object

    • text string | null

      Warranty of the product

    • durationSeconds integer(int32)

      Duration of the warranty in seconds

    • Additional properties are NOT allowed
  • discordSocialConnectSettings object
    Hide discordSocialConnectSettings attributes Show discordSocialConnectSettings attributes object

    • enabled boolean Required

      Is Discord social connect enabled

    • required boolean Required

      Is Discord social connect required

    • beforePurchaseRequireRoles object
      Hide beforePurchaseRequireRoles attributes Show beforePurchaseRequireRoles attributes object

      • guildId string | null
      • roleIds array[string] | null
      • Additional properties are NOT allowed
    • beforePurchaseServer object
      Hide beforePurchaseServer attributes Show beforePurchaseServer attributes object

      • guildId string | null
      • roleIds array[string] | null
      • Additional properties are NOT allowed
    • afterPurchaseServer object
      Hide afterPurchaseServer attributes Show afterPurchaseServer attributes object

      • guildId string | null
      • roleIds array[string] | null
      • Additional properties are NOT allowed
    • Additional properties are NOT allowed
  • Additional properties are NOT allowed
• path string Required

  Path/Slug of the product

  Minimum length is 1.

• seo object Required
  Hide seo attributes Show seo attributes object

  • metaTitle string | null

    Meta title of the product. If not provided, default shop seo settings will be used

  • metaDescription string | null

    Meta description of the product. If not provided, default shop seo settings will be used

  • Additional properties are NOT allowed
• unlisted boolean Required

  Is product unlisted

• private boolean Required

  Is product private

• onHold boolean Required

  Is product on hold

• isInternal boolean | null
• Additional properties are NOT allowed