Add a variant to a product

curl --request POST \
  --url https://api.mercemur.com/api/v1/products/{productId}/variants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "price_minor": 1,
  "currency_code": "<string>",
  "title": "<string>",
  "sku": "<string>",
  "manage_inventory": true,
  "allow_backorder": true,
  "requires_shipping": true,
  "variant_rank": 123,
  "selections": {}
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    price_minor: 1,
    currency_code: '<string>',
    title: '<string>',
    sku: '<string>',
    manage_inventory: true,
    allow_backorder: true,
    requires_shipping: true,
    variant_rank: 123,
    selections: {}
  })
};

fetch('https://api.mercemur.com/api/v1/products/{productId}/variants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/products/{productId}/variants"

payload = {
    "price_minor": 1,
    "currency_code": "<string>",
    "title": "<string>",
    "sku": "<string>",
    "manage_inventory": True,
    "allow_backorder": True,
    "requires_shipping": True,
    "variant_rank": 123,
    "selections": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/products/{productId}/variants"

	payload := strings.NewReader("{\n  \"price_minor\": 1,\n  \"currency_code\": \"<string>\",\n  \"title\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"manage_inventory\": true,\n  \"allow_backorder\": true,\n  \"requires_shipping\": true,\n  \"variant_rank\": 123,\n  \"selections\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/products/{productId}/variants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'price_minor' => 1,
    'currency_code' => '<string>',
    'title' => '<string>',
    'sku' => '<string>',
    'manage_inventory' => true,
    'allow_backorder' => true,
    'requires_shipping' => true,
    'variant_rank' => 123,
    'selections' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "allow_backorder": true,
    "currency_code": "<string>",
    "id": "<string>",
    "manage_inventory": true,
    "price_minor": 123,
    "requires_shipping": true,
    "selections": {
      "Size": "<string>"
    },
    "sku": "<string>",
    "title": "<string>",
    "variant_rank": 123
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

POST

api

products

{productId}

variants

Add a variant to a product

curl --request POST \
  --url https://api.mercemur.com/api/v1/products/{productId}/variants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "price_minor": 1,
  "currency_code": "<string>",
  "title": "<string>",
  "sku": "<string>",
  "manage_inventory": true,
  "allow_backorder": true,
  "requires_shipping": true,
  "variant_rank": 123,
  "selections": {}
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    price_minor: 1,
    currency_code: '<string>',
    title: '<string>',
    sku: '<string>',
    manage_inventory: true,
    allow_backorder: true,
    requires_shipping: true,
    variant_rank: 123,
    selections: {}
  })
};

fetch('https://api.mercemur.com/api/v1/products/{productId}/variants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/products/{productId}/variants"

payload = {
    "price_minor": 1,
    "currency_code": "<string>",
    "title": "<string>",
    "sku": "<string>",
    "manage_inventory": True,
    "allow_backorder": True,
    "requires_shipping": True,
    "variant_rank": 123,
    "selections": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/products/{productId}/variants"

	payload := strings.NewReader("{\n  \"price_minor\": 1,\n  \"currency_code\": \"<string>\",\n  \"title\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"manage_inventory\": true,\n  \"allow_backorder\": true,\n  \"requires_shipping\": true,\n  \"variant_rank\": 123,\n  \"selections\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/products/{productId}/variants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'price_minor' => 1,
    'currency_code' => '<string>',
    'title' => '<string>',
    'sku' => '<string>',
    'manage_inventory' => true,
    'allow_backorder' => true,
    'requires_shipping' => true,
    'variant_rank' => 123,
    'selections' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "allow_backorder": true,
    "currency_code": "<string>",
    "id": "<string>",
    "manage_inventory": true,
    "price_minor": 123,
    "requires_shipping": true,
    "selections": {
      "Size": "<string>"
    },
    "sku": "<string>",
    "title": "<string>",
    "variant_rank": 123
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key

string

required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

productId

string

required

Body

application/json

price_minor

integer

required

Required on create. Minor units of the store's base currency. Absent is refused rather than treated as zero, because a zero price takes the free checkout path.

Required range: x >= 0

currency_code

string

required

Required on create, and an assertion rather than a choice: it must equal the store's base currency or the write is refused with 409 currency_mismatch.

title

string

sku

string

manage_inventory

boolean

Defaults to true.

allow_backorder

boolean

Defaults to false.

requires_shipping

boolean

Defaults to true. False is what makes a variant digital.

variant_rank

integer

selections

object

Maps each of the product's option titles to this variant's value, and must cover them exactly.

Show child attributes

Response

Created

data

object

Show child attributes

Overview

Endpoints

Add a variant to a product

Authorizations

Headers

Path Parameters

Body

Response