Product customizations API

Get customization by id

Get single product customization by id

get/api/sites/multiscreen/{site_name}/ecommerce/customizations/{customization_id}

Request

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

Path parameters

site_namestring required

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

customization_idstring required

The product customization's ID.

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.