Create option group

POST 
/api/v2/catalog/options

Create a new option group for a given business or product

You must provide either a business_id or a product_id

Request

application/json

Body

required

anyOf

MOD1

business_id uuidrequired

Business ID to associate the group with

MOD2

product_id stringrequired

Possible values: >= 12 characters and <= 12 characters, Value must match regular expression ^[0-9a-z]+$

Product ID to associate the group with

name stringrequired

Possible values: non-empty

Name of the product option group

options

object[]

Array [

name stringrequired

Possible values: non-empty

Name of the product option

price decimalrequired

Default value: 0

The additional price of the option, can be 0 or negative

sku stringnullable

The SKU of the option

ref_code stringnullable

The reference code of the option

available boolean

Default value: true

Mark the option as not available

]

order integer

Default value: 0

Used to order the item, order defaults to ascending.

Responses

201

application/json

Schema

Schema

id stringrequired

Possible values: >= 12 characters and <= 12 characters, Value must match regular expression ^[0-9a-z]+$

Unique ID of the product option group

name stringrequired

Possible values: non-empty

Name of the product option group

business_id uuid

Business id linked to the group

options

object[]

required

Array [

name stringrequired

Possible values: non-empty

Name of the product option

price decimalrequired

Default value: 0

The additional price of the option, can be 0 or negative

sku stringnullable

The SKU of the option

ref_code stringnullable

The reference code of the option

available boolean

Default value: true

Mark the option as not available

]

order integerrequired

Default value: 0

Used to order the item, order defaults to ascending.

created_at date-timerequired
updated_at date-timerequired

Example (from schema)

{
  "id": "95a1o6hmh0qv",
  "name": "Additional Ingredients",
  "business_id": "cd9feea7-99f4-4e90-897f-8b4f7cac8c59",
  "options": [
    {
      "name": "Mushrooms",
      "price": "12.5",
      "sku": "123456",
      "ref_code": "123456",
      "available": true
    }
  ],
  "order": 1,
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...