Options

catalog Product Custom Option Repository V1Get Get

Get custom option for a specific product

get

/V1/products/{sku}/options/{optionId}

Path parameters

skustringrequired

(Required)

Example: <string>

optionIdstringrequired

(Required)

Example: <integer>

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{baseurl}}/V1/products/{sku}/options/{optionId}'

200

401

500

200

{
  "product_sku": "<string>",
  "title": "<string>",
  "type": "<string>",
  "sort_order": "<integer>",
  "is_require": "<boolean>",
  "option_id": "<integer>",
  "price": "<number>",
  "price_type": "<string>",
  "sku": "<string>",
  "file_extension": "<string>",
  "max_characters": "<integer>",
  "image_size_x": "<integer>",
  "image_size_y": "<integer>",
  "values": [
    {
      "title": "<string>",
      "sort_order": "<integer>",
      "price": "<number>",
      "price_type": "<string>",
      "sku": "<string>",
      "option_type_id": "<integer>"
    },
    {
      "title": "<string>",
      "sort_order": "<integer>",
      "price": "<number>",
      "price_type": "<string>",
      "sku": "<string>",
      "option_type_id": "<integer>"
    }
  ],
  "extension_attributes": {
    "vertex_flex_field": "<string>"
  }
}

OK

catalog Product Custom Option Repository V1Delete By Identifier Delete

delete

/V1/products/{sku}/options/{optionId}

Path parameters

skustringrequired

(Required)

Example: <string>

optionIdstringrequired

(Required)

Example: <integer>

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/products/{sku}/options/{optionId}'

200

401

500

200

true

OK

catalog Product Custom Option Repository V1Get List Get

Get the list of custom options for a specific product

get

/V1/products/{sku}/options

Path parameters

skustringrequired

(Required)

Example: <string>

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{baseurl}}/V1/products/{sku}/options'

200

401

500

200

[
  {
    "product_sku": "<string>",
    "title": "<string>",
    "type": "<string>",
    "sort_order": "<integer>",
    "is_require": "<boolean>",
    "option_id": "<integer>",
    "price": "<number>",
    "price_type": "<string>",
    "sku": "<string>",
    "file_extension": "<string>",
    "max_characters": "<integer>",
    "image_size_x": "<integer>",
    "image_size_y": "<integer>",
    "values": [
      {
        "title": "<string>",
        "sort_order": "<integer>",
        "price": "<number>",
        "price_type": "<string>",
        "sku": "<string>",
        "option_type_id": "<integer>"
      },
      {
        "title": "<string>",
        "sort_order": "<integer>",
        "price": "<number>",
        "price_type": "<string>",
        "sku": "<string>",
        "option_type_id": "<integer>"
      }
    ],
    "extension_attributes": {
      "vertex_flex_field": "<string>"
    }
  },
  {
    "product_sku": "<string>",
    "title": "<string>",
    "type": "<string>",
    "sort_order": "<integer>",
    "is_require": "<boolean>",
    "option_id": "<integer>",
    "price": "<number>",
    "price_type": "<string>",
    "sku": "<string>",
    "file_extension": "<string>",
    "max_characters": "<integer>",
    "image_size_x": "<integer>",
    "image_size_y": "<integer>",
    "values": [
      {
        "title": "<string>",
        "sort_order": "<integer>",
        "price": "<number>",
        "price_type": "<string>",
        "sku": "<string>",
        "option_type_id": "<integer>"
      },
      {
        "title": "<string>",
        "sort_order": "<integer>",
        "price": "<number>",
        "price_type": "<string>",
        "sku": "<string>",
        "option_type_id": "<integer>"
      }
    ],
    "extension_attributes": {
      "vertex_flex_field": "<string>"
    }
  }
]

OK

catalog Product Custom Option Repository V1Save Post

Save Custom Option

post

/V1/products/options

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"option":{"product_sku":"<string>","title":"<string>","type":"<string>","sort_order":"<integer>","is_require":"<boolean>","option_id":"<integer>","price":"<number>","price_type":"<string>","sku":"<string>","file_extension":"<string>","max_characters":"<integer>","image_size_x":"<integer>","image_size_y":"<integer>","values":[{"title":"<string>","sort_order":"<integer>","price":"<number>","price_type":"<string>","sku":"<string>","option_type_id":"<integer>"},{"title":"<string>","sort_order":"<integer>","price":"<number>","price_type":"<string>","sku":"<string>","option_type_id":"<integer>"}],"extension_attributes":{"vertex_flex_field":"<string>"}}}

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/products/options' \
  --header 'Content-Type: application/json' \
  --data '{
    "option": {
      "product_sku": "<string>",
      "title": "<string>",
      "type": "<string>",
      "sort_order": "<integer>",
      "is_require": "<boolean>",
      "option_id": "<integer>",
      "price": "<number>",
      "price_type": "<string>",
      "sku": "<string>",
      "file_extension": "<string>",
      "max_characters": "<integer>",
      "image_size_x": "<integer>",
      "image_size_y": "<integer>",
      "values": [
        {
          "title": "<string>",
          "sort_order": "<integer>",
          "price": "<number>",
          "price_type": "<string>",
          "sku": "<string>",
          "option_type_id": "<integer>"
        },
        {
          "title": "<string>",
          "sort_order": "<integer>",
          "price": "<number>",
          "price_type": "<string>",
          "sku": "<string>",
          "option_type_id": "<integer>"
        }
      ],
      "extension_attributes": {
        "vertex_flex_field": "<string>"
      }
    }
  }'

200

401

500

200

{
  "product_sku": "<string>",
  "title": "<string>",
  "type": "<string>",
  "sort_order": "<integer>",
  "is_require": "<boolean>",
  "option_id": "<integer>",
  "price": "<number>",
  "price_type": "<string>",
  "sku": "<string>",
  "file_extension": "<string>",
  "max_characters": "<integer>",
  "image_size_x": "<integer>",
  "image_size_y": "<integer>",
  "values": [
    {
      "title": "<string>",
      "sort_order": "<integer>",
      "price": "<number>",
      "price_type": "<string>",
      "sku": "<string>",
      "option_type_id": "<integer>"
    },
    {
      "title": "<string>",
      "sort_order": "<integer>",
      "price": "<number>",
      "price_type": "<string>",
      "sku": "<string>",
      "option_type_id": "<integer>"
    }
  ],
  "extension_attributes": {
    "vertex_flex_field": "<string>"
  }
}

OK

catalog Product Custom Option Repository V1Save Put

Save Custom Option

put

/V1/products/options/{optionId}

Path parameters

optionIdstringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"option":{"product_sku":"<string>","title":"<string>","type":"<string>","sort_order":"<integer>","is_require":"<boolean>","option_id":"<integer>","price":"<number>","price_type":"<string>","sku":"<string>","file_extension":"<string>","max_characters":"<integer>","image_size_x":"<integer>","image_size_y":"<integer>","values":[{"title":"<string>","sort_order":"<integer>","price":"<number>","price_type":"<string>","sku":"<string>","option_type_id":"<integer>"},{"title":"<string>","sort_order":"<integer>","price":"<number>","price_type":"<string>","sku":"<string>","option_type_id":"<integer>"}],"extension_attributes":{"vertex_flex_field":"<string>"}}}

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/products/options/{optionId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "option": {
      "product_sku": "<string>",
      "title": "<string>",
      "type": "<string>",
      "sort_order": "<integer>",
      "is_require": "<boolean>",
      "option_id": "<integer>",
      "price": "<number>",
      "price_type": "<string>",
      "sku": "<string>",
      "file_extension": "<string>",
      "max_characters": "<integer>",
      "image_size_x": "<integer>",
      "image_size_y": "<integer>",
      "values": [
        {
          "title": "<string>",
          "sort_order": "<integer>",
          "price": "<number>",
          "price_type": "<string>",
          "sku": "<string>",
          "option_type_id": "<integer>"
        },
        {
          "title": "<string>",
          "sort_order": "<integer>",
          "price": "<number>",
          "price_type": "<string>",
          "sku": "<string>",
          "option_type_id": "<integer>"
        }
      ],
      "extension_attributes": {
        "vertex_flex_field": "<string>"
      }
    }
  }'

200

401

500

200

{
  "product_sku": "<string>",
  "title": "<string>",
  "type": "<string>",
  "sort_order": "<integer>",
  "is_require": "<boolean>",
  "option_id": "<integer>",
  "price": "<number>",
  "price_type": "<string>",
  "sku": "<string>",
  "file_extension": "<string>",
  "max_characters": "<integer>",
  "image_size_x": "<integer>",
  "image_size_y": "<integer>",
  "values": [
    {
      "title": "<string>",
      "sort_order": "<integer>",
      "price": "<number>",
      "price_type": "<string>",
      "sku": "<string>",
      "option_type_id": "<integer>"
    },
    {
      "title": "<string>",
      "sort_order": "<integer>",
      "price": "<number>",
      "price_type": "<string>",
      "sku": "<string>",
      "option_type_id": "<integer>"
    }
  ],
  "extension_attributes": {
    "vertex_flex_field": "<string>"
  }
}

OK