Create a variation option

POST 
/pcm/variations/:variationID/options

Create a variation option

Request

Path Parameters

variationID stringrequired

A unique identifier for the variation.

application/json

Body

data objectrequired

type stringrequired

Possible values: [product-variation-option]

This represents the type of resource object being returned. Always product-variation-option.

attributes objectrequired

name string

A human recognizable identifier for the option, also used in the SLUG for child products. Option names can only contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed.

sort_order integer

By default, variations and variation options are sorted alphabetically. You can use the sort_order attribute to sort the order of your variation and variation options in the variation_matrix.

The sort order value is visible when you add the variations and variation options to your catalogs. You can then use the sort_order value to program your storefront to display the variation options in the order that you want.

The variation option with the highest value of sort_order is displayed first. For example, a variation option with a sort_order value of 3 appears before a variation option with a sort_order value of 2. You can specify any numbers that you want. You can use 1, 2, 3, or 100, 90, 80, and so on, zero or negative numbers.

You can set sort_order to either null or omit it entirely from the request if you wish to remove an existing sort_order attribute.

You must rebuild your products for the sort order changes to take effect.

description string

A description of a product variation option.

Responses

201

Successfully returns the created variation option.

application/json

Schema

Schema

data objectrequired

id string

A unique identifier that is generated when an option is created.

type stringrequired

Possible values: [product-variation-option]

This represents the type of resource object being returned. Always product-variation-option.

attributes objectrequired

name string

A human-recognizable identifier for the option, also used in the SLUG for child products. Option names can only contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed.

description string

A human-recognizable description for the option.

sort_order integer

The sort order value is visible when you add the variations and variation options to your catalogs. You can then use the sort_order value to program your storefront to display the variation options in the order that you want. The variation with the highest value of sort_order is displayed first. For example, a variation with a sort_order value of 3 appears before a variation with a sort_order value of 2. You can specify any numbers that you want. You can use 1, 2, 3, or 100, 90, 80, including, zero or negative numbers. You can set sort_order to either null or omit it entirely from the request if you wish to remove an existing sort_order attribute.

meta object

owner string

Possible values: [organization, store]

The owner of a resource, either organization or store.

created_at date-time

The date and time an option is created.

updated_at date-time

The date and time an option is updated.

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "product-variation-option",
    "attributes": {
      "name": "string",
      "description": "string",
      "sort_order": 0
    },
    "meta": {
      "owner": "organization",
      "created_at": "2020-09-22T09:00:00",
      "updated_at": "2020-09-22T09:00:00"
    }
  }
}

created-variation-option

{
  "data": {
    "type": "product-variation-option",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "attributes": {
      "description": "Our most popular color",
      "name": "Blue",
      "sort_order": 0
    },
    "meta": {
      "owner": "store",
      "created_at": "2024-01-25T11:25:38.001Z",
      "updated_at": "2024-01-25T11:25:38.001Z"
    }
  }
}

422

Bad request. The request failed validation.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

failed-validation

{
  "errors": [
    {
      "title": "Failed Validation",
      "status": "422",
      "detail": "<XYZ> can not be empty"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": "500",
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

Loading...