# Add a variant to a product

```http
POST https://secure.yoprint.com/v1/api/store/{team_slug}/product/{hash_id}/variant
```

- API version: v1
- Operation ID: `v1_public_product_variant_store`
- Section: Products and catalog › [Product variants](https://developer.yoprint.com/reference/product-variants.md)
- Web page: https://developer.yoprint.com/reference/product-variants/v1-product-variant-store/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Adds one size and color combination to a variant product, returns it, and updates the product's `size_data` and `color_data`.

Send the options the product's `variant_type` uses: `size_id` and `size_label` for sizes, `color_id`, `color_label` and `color_hex` for colors.

A size or color the product already has keeps its current name, and a color its hex; the names sent for it are ignored. A new size or color whose name another size, or another color, of the product already has returns 422 option_label_taken. Case and surrounding spaces are ignored.

## Permission

Needs the Manage Products permission at the level that can create products.

## Business rules

- The options you send must match the product's `variant_type` (422 `variant_type_mismatch`).
- Each size and color combination exists once (422; `error.size_id` / `error.color_id` name the clash).
- Adds no stock.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The product's id (`id` from List products). A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `EDhVUaC6jbLbed`.

## Request body

Content type `application/json`, required.

Fields:

- `default_price` (integer, required): Required. This variant's selling price. Send a whole number of thousandths: `9000` is 9.00.
- `barcode` (string, optional): Saved as sent; not checked.
- `color_hex` (string, optional): For products with colors, such as `#1F2937`.
- `color_id` (string, optional): For products with colors: your id for the color. The rule depends on the case: - When creating a product: use an id from `color_data`. - When adding a variant to a color-only product: send a new id to add a color. Reusing an existing id is a duplicate (422). - When adding a variant to a size-and-color product: reuse an id from `color_data` to add a new size in an existing color, or send a new id to add a color.
- `color_label` (string, optional): For products with colors. For a color the product already has, its current name is kept.
- `enable` (boolean, optional): Saved as sent (default true); returned as `enable`. Nothing enforces it: phase a variant out to stop selling it.
- `price_data` (map of objects, optional): Prices for pricing groups, keyed by pricing group id: `{"<pricing group id>": {"price": 11000}}`. A line priced with that group uses this price instead of `default_price`. Send a whole number of thousandths: `11000` is 11.00.
  - Each item:
    - `price` (integer, required): Send a whole number of thousandths: `11000` is 11.00.
- `size_id` (string, optional): For products with sizes: your id for the size. The rule depends on the case: - When creating a product: use an id from `size_data`. - When adding a variant to a size-only product: send a new id to add a size. Reusing an existing id is a duplicate (422). - When adding a variant to a size-and-color product: reuse an id from `size_data` to add a new color for an existing size, or send a new id to add a size.
- `size_label` (string, optional): For products with sizes. For a size the product already has, its current name is kept.
- `supplier_id` (string, optional): The supplier's code for this variant.
- `track_inventory` (boolean, optional): Saved as sent (default true); not checked.
- `vendor_id` (string, optional)
- `weight` (number, optional): The variant's weight.

### Example request

```bash
curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/product/EDhVUaC6jbLbed/variant' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "color_hex": "#000000",
    "color_id": "black",
    "color_label": "Black",
    "default_price": 9500,
    "size_id": "L",
    "size_label": "L"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `type` (string, required): Always `"variant_option"`.
  - `default_price` (integer | number | string, required): This variant's selling price. Never null. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
  - `id` (string, required): The variant id: the `db_variant` line's product id.
  - `phased_out` (boolean, required)
  - `trashed` (boolean, required)
  - `barcode` (string | null, optional)
  - `brand` (string | null, optional): The parent product's brand.
  - `color_hex` (string | null, optional)
  - `color_id` (string | null, optional)
  - `color_label` (string | null, optional)
  - `description` (string | null, optional): The parent product's description.
  - `enable` (boolean, optional)
  - `phased_out_at` (string (date-time) | null, optional)
  - `phased_out_by` (object | null, optional): Who did it, as `{id, name}`; null when on sale or nobody was recorded.
    - `id` (string, optional)
    - `name` (string, optional)
  - `price_data` (object | array, optional): Prices for pricing groups, as saved: keyed by the pricing group's internal number (not its hash id), each `{"price": <thousandths>}`. An empty list `[]` when there are none.
  - `size_id` (string | null, optional)
  - `size_label` (string | null, optional)
  - `supplier_id` (string | null, optional)
  - `taxable` (boolean, optional): The parent product's `taxable`.
  - `title` (string | null, optional): The parent product's title.
  - `track_inventory` (boolean, optional)
  - `vendor_id` (string, optional): The vendor id, or an empty string when none.
  - `weight` (number | string | null, optional)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "barcode": null,
    "brand": "Northwind",
    "color_hex": "#000000",
    "color_id": "black",
    "color_label": "Black",
    "default_price": 9500,
    "description": null,
    "enable": true,
    "id": "AcFtx9EgT0KtCW",
    "phased_out": false,
    "phased_out_at": null,
    "phased_out_by": null,
    "price_data": [],
    "size_id": "L",
    "size_label": "L",
    "supplier_id": null,
    "taxable": true,
    "title": "Classic Tee",
    "track_inventory": true,
    "trashed": false,
    "type": "variant_option",
    "vendor_id": "",
    "weight": null
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role cannot create products. This 403 has a short body, `{"message": "Insufficient Permission"}`, with no `success` or `error`. Fix: Ask a team owner to set Manage Products to "Users CAN view, update and create products".
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: No live variant product with this id. `error.code` is null and `error.message` names the record type. Fix: Check the product id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: The options you sent don't match the product's `variant_type` (`error.code` `variant_type_mismatch`). Fix: Send exactly the options the product uses.
  - When: The size and color combination already exists. `error.code` and `error.message` are null; `error.size_id` and/or `error.color_id` say `unique.error` or `size_color.unique.error`. Fix: List the variants to see what exists.
  - When: A new size or color takes a name another option already has (`error.code` `option_label_taken`; `error.options` lists them). Fix: Pick another name.
  - When: `default_price` is missing, or a size or color field is missing. `error.code` is `validation_failed`. Fix: Fix each field named in `error.fields`; its keys are field paths such as `contact.0.phone`.
- `500` A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as `action_not_allowed`; an unexpected failure answers `{"message": "Server Error"}`. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.
  - When: `default_price` is not a whole number of thousandths, such as `9.5`. Nothing is saved. Fix: Send a whole number: `9500` for 9.50.

## Related

- [List a product's variants](https://developer.yoprint.com/reference/product-variants/v1-product-variant-index.md): `GET /v1/api/store/{team_slug}/product/{hash_id}/variant`
- [Rename sizes and colors of a product](https://developer.yoprint.com/reference/product-variants/v1-product-variant-rename-options.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant/rename_options`