Custom Fields API

Create custom field

Creates new custom fields for referenced catalog

post/api/sites/multiscreen/{site_name}/ecommerce/custom-fields

Request

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

Path parameters

site_namestring required

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

Request body

namestring

Displayed custom field name

type'TEXT' | 'PLAIN_TEXT' | 'IMAGE' | 'VIDEO'

Custom field type

Example request

{
  "name": "Product Details"
}

Response

OK

idstring

Immutable identifier for referencing

namestring

Displayed custom field name

type'TEXT' | 'PLAIN_TEXT' | 'IMAGE' | 'VIDEO'

Custom field type

Example response

{
  "id": "WMd1xylGrp",
  "name": "Product Details"
}

Changes

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