POST
/
v2
/
products
/
{productId}
/
children
Create product variant
curl --request POST \
  --url https://api.production.orderprotection.com/v2/products/{productId}/children \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "productId": "123456",
  "status": "ACTIVE",
  "variantId": "123456",
  "name": "123456",
  "description": "This product is super awesome and will solve all of your problems",
  "sku": "123456",
  "price": 22.22,
  "tax": "123456",
  "inventoryType": "FULL",
  "inventoryQuantity": "123456",
  "productImage": "https://somedomain.com/image.png",
  "productType": "This is the type of product. Can be SIMPLE or GROUPED",
  "inStock": true,
  "bundleProductIds": [
    "product-id-1",
    "product-id-2"
  ]
}'
{
  "status": "ok"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
productId
string
required

Body

application/json
​
productId
string
required

Unique ID for the product

Example:

"123456"

​
status
enum<string>
required

Status of the variant

Available options:
ACTIVE,
DRAFT,
ARCHIVED,
DELETED
Example:

"ACTIVE"

​
name
string
required

This is the name of the product.

Example:

"123456"

​
price
number
required

Price of the product

Example:

22.22

​
inventoryQuantity
enum<number>
required

This is the amount remaining in stock. This is used if you are using the FULL inventory type

Example:

"123456"

​
productType
enum<string>
required

This tells us if this product is a bundle or a simple product with variants

Available options:
FULL,
SIMPLE
Example:

"This is the type of product. Can be SIMPLE or GROUPED"

​
variantId
string

If your platform supports variant ids, you can use this field here. Otherwise use the productId field and leave this blank

Example:

"123456"

​
description
string

This is the description of the product. This will help with making sure the correct product is chosen

Example:

"This product is super awesome and will solve all of your problems"

​
sku
string

SKU of the product

Example:

"123456"

​
tax
number

Unique ID for the product

Example:

"123456"

​
inventoryType
enum<string>

What kind of inventory tracking we will do

Available options:
FULL,
SIMPLE
Example:

"FULL"

​
productImage
string

This is the url to show a product image.

Example:

"https://somedomain.com/image.png"

​
inStock
boolean

If using the SIMPLE mode you just simply tell us if the product is in stock or not

Example:

true

​
bundleProductIds
string[]

If you are creating a bundled product and have already created the child products you can include their ids here

Example:
["product-id-1", "product-id-2"]

Response

The variant passes validation and has been successfully created.

​
status
string
required
Example:

"ok"