DUduda
Product customizations API

Create customization

Creates a new product customization for given catalog

post/api/sites/multiscreen/{site_name}/ecommerce/customizations

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/customizations
  • Auth
    HTTP basic

Path parameters

site_namestring required

The site's unique name (its ID), returned when the site is created.

Request body

button_labelstring

Label of the upload button, allowed only for the FILE type

hintstring

Placeholder displayed to site visitors, allowed only for the TEXT type

labelstring

Label displayed to site visitors

mandatoryboolean

Whether site visitors must fill in this customization

pricenumber

Additional price applied when the customization is used

titlestring required

Internal name used by the store owner to manage the customization

type'TEXT' | 'CHECKBOX' | 'FILE' required

Product customization type

Example request

{
  "button_label": "Upload your design",
  "choices": [
    {
      "label": "Gift wrapping",
      "price": 5
    }
  ],
  "hint": "Best t-shirt ever",
  "label": "Enter the text to print on the t-shirt",
  "limitations": {
    "max_choices": 3,
    "min_choices": 1
  },
  "price": 5,
  "title": "T-shirt print"
}

Response

OK

button_labelstring

Label of the upload button, available only for the FILE type

hintstring

Placeholder displayed to site visitors as a pre-filler for the input

idstring

Immutable identifier for referencing

labelstring

Label displayed to site visitors

mandatoryboolean

Whether site visitors must fill in this customization

pricenumber

Additional price applied when the customization is used

titlestring

Internal name used by the store owner to manage the customization

type'TEXT' | 'CHECKBOX' | 'FILE'

Product customization type

Example response

{
  "button_label": "Upload your design",
  "choices": [
    {
      "id": "db3je27rg7",
      "label": "Gift wrapping",
      "price": 5
    }
  ],
  "hint": "Best t-shirt ever",
  "id": "WMd1xylGrp",
  "label": "Enter the text to print on the t-shirt",
  "limitations": {
    "max_choices": 3,
    "min_choices": 1
  },
  "price": 5,
  "title": "T-shirt print"
}

Changes

No recorded changes to this operation across all 1 revision of this API.