Options

PreviousTypes NextTypes

catalog Product Custom Option Repository V1Get Get

get

Get custom option for a specific product

Path parameters

skustringRequired

(Required)

Example: <string>

optionIdstringRequired

(Required)

Example: <integer>

Responses

200

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

GET /V1/products/{sku}/options/{optionId} HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "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>"
  }
}

catalog Product Custom Option Repository V1Delete By Identifier Delete

delete

Path parameters

skustringRequired

(Required)

Example: <string>

optionIdstringRequired

(Required)

Example: <integer>

Responses

200

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

delete

DELETE /V1/products/{sku}/options/{optionId} HTTP/1.1
Host: {{baseurl}}
Accept: */*

true

catalog Product Custom Option Repository V1Get List Get

get

Get the list of custom options for a specific product

Path parameters

skustringRequired

(Required)

Example: <string>

Responses

200

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

GET /V1/products/{sku}/options HTTP/1.1
Host: {{baseurl}}
Accept: */*

[
  {
    "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>"
    }
  }
]

catalog Product Custom Option Repository V1Save Post

post

Save Custom Option

Header parameters

Content-TypestringOptionalExample: application/json

Body

objectOptionalExample:

{"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

200

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

POST /V1/products/options HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 656

{
  "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>"
    }
  }
}

{
  "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>"
  }
}

catalog Product Custom Option Repository V1Save Put

put

Save Custom Option

Path parameters

optionIdstringRequired

(Required)

Example: <string>

Header parameters

Content-TypestringOptionalExample: application/json

Body

objectOptionalExample:

{"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

200

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

put

PUT /V1/products/options/{optionId} HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 656

{
  "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>"
    }
  }
}

{
  "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>"
  }
}