eComm Product Options

Native Store Only

Product Option Object

JSON

{
  "choices": [
    {
      "id": "db3je27rg7",
      "value": "45"
    }
  ],
  "id": "WMd1xylGrp",
  "name": "Shirt size"
}

product_option

Property	Type	Description	Mutable
id	string	Unique identifier for the option	No
name	string	The name of the option	Yes
choices	string	An array of choices for the option. See the section below for details.	Yes

choices

Property	Type	Description	Mutable
id	string	Unique identifier for the choice	No
value	string	Value of the choice	Yes

List Product Options

List Product Options

GET https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/options

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier of the target site.

Query Parameters

Name	Type	Description
offset	int32	Zero-based offset for elements (0..N)
limit	int32	The size of the page to be returned
sort	string	Property on which to sort results
direction	string	[asc,desc] Order direction for the property specified in sort.

400: Bad Request

200: OK object

{
  "limit": 0,
  "offset": 0,
  "results": [
    {
      "choices": [
        {
          "id": "db3je27rg7",
          "value": "45"
        }
      ],
      "id": "WMd1xylGrp",
      "name": "Shirt size"
    }
  ],
  "site_name": "string",
  "total_responses": 0
}

curl

curl --request GET \
     --url 'https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/options?offset=0&limit=20&direction=asc' \
     --header 'accept: application/json'

Create Product Option

Create Product Option

POST https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/options

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site

Request Body

Name	Type	Description
name*	string	Name of the option
choices*	array of strings	List of possible values for the option

400: Bad Request

200: OK object

{
  "choices": [
    {
      "id": "db3je27rg7",
      "value": "45"
    }
  ],
  "id": "WMd1xylGrp",
  "name": "Shirt size"
}

curl

curl --request POST \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/options \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "choices": [
    "45"
  ],
  "name": "Shirt size"
}
'

Get Product Option

Get Product Option

GET https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/options/{option_id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
option_id*	string	Unique identifier for the target option

200: OK object

{
  "choices": [
    {
      "id": "db3je27rg7",
      "value": "45"
    }
  ],
  "id": "WMd1xylGrp",
  "name": "Shirt size"
}

400: Bad Request

curl

curl --request GET \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/options/option_id \
     --header 'accept: application/json'

Delete Product Option

Delete Product Option

DELETE https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/options/{option_id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
option_id*	string	The unique identifier for the target option

204: No Content

400: Bad Request

curl

curl --request DELETE \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/options/option_id \
     --header 'accept: application/json'

Update Product Option

Update Product Option

PUT https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/options/{option_id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
option_id*	string	The unique identifier for the target option

Request Body

Name	Type	Description
name	string	Name of the option

200: OK object

{
  "choices": [
    {
      "id": "db3je27rg7",
      "value": "45"
    }
  ],
  "id": "WMd1xylGrp",
  "name": "Shirt size"
}

400: Bad Request

curl

curl --request PUT \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/options/option_id \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "name": "Shirt size"
}
'

Create Product Option Choice

Create Product Option Choice

POST https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/options/{option_id}/choices

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
option_id*	string	The unique identifier for the target option

Request Body

Name	Type	Description
value	string	The value of the new option choice

200: OK object

{
  "choices": [
    {
      "id": "db3je27rg7",
      "value": "45"
    }
  ],
  "id": "WMd1xylGrp",
  "name": "Shirt size"
}

400: Bad Request

curl

curl --request POST \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/options/option_id/choices \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"value":"45"}'

Delete Product Option Choice

Delete Product Option Choice

DELETE https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/options/{option_id}/choices/{choice_id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
option_id*	string	The unique identifier for the target option
choice_id*	string	The unique identifier for the target choice

204: No Content

400: Bad Request

curl

curl --request DELETE \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/options/option_id/choices/choice_id \
     --header 'accept: application/json'

Update Product Option Choice

Update Product Option Choice

PUT https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/options/{option_id}/choices/{choice_id}

Path Parameters

Name	Type	Description
site_name*	string	The unique identifier for the target site
option_id*	string	The unique identifier for the target option
choice_id*	string	The unique identifier for the target choice

Request Body

Name	Type	Description
value*	string	The updated value for the choice

200: OK object

{
  "choices": [
    {
      "id": "db3je27rg7",
      "value": "46"
    }
  ],
  "id": "WMd1xylGrp",
  "name": "Shirt size"
}

400: Bad Request

curl

curl --request PUT \
     --url https://api.duda.co/api/sites/multiscreen/site_name/ecommerce/options/option_id/choices/choice_id \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"value":"46"}'