List product variants - Velocity for BigCommerce API Docs

List product variants

curl --request GET \
  --url https://{tenant}.api.velocity.medshift.com/v1/product_variants/ \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{tenant}.api.velocity.medshift.com/v1/product_variants/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.api.velocity.medshift.com/v1/product_variants/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{tenant}.api.velocity.medshift.com/v1/product_variants/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{tenant}.api.velocity.medshift.com/v1/product_variants/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bigcommerce_id": 123,
    "sku": "<string>",
    "is_purchasable": true,
    "base_price": "<string>",
    "list_price": "<string>",
    "cost_price": "<string>",
    "inventory_level": 123,
    "custom_fields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "value": null
      }
    ],
    "product": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bigcommerce_id": 123,
      "name": "<string>",
      "is_digital": true,
      "thumbnail_url": "<string>",
      "is_purchasable": true,
      "order_quantity_min": 123,
      "order_quantity_max": 123,
      "inventory_level": 123,
      "commission_programs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ],
      "tax_code": "<string>",
      "lot_serial_required": true
    },
    "options": [
      {
        "bigcommerce_option_id": 123,
        "option_name": "<string>",
        "bigcommerce_value_id": 123,
        "value_label": "<string>"
      }
    ]
  }
]

Authorizations

X-API-Key

string

header

required

Query Parameters

commission_program_ids

string<uuid>[]

Multiple values may be separated by commas.

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

ordering

string

Which field to use when ordering the results.

product_id

string<uuid>

string

A search term.

Response

200 - application/json

string<uuid>

required

read-only

bigcommerce_id

integer

required

read-only

sku

string

required

Required string length: 1 - 255

is_purchasable

boolean

required

read-only

base_price

string<decimal>

required

read-only

The regular price, before any sale.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

list_price

string<decimal>

required

read-only

The price currently charged, which reflects any sale in progress.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

cost_price

string<decimal>

required

read-only

What this variant costs the store.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

inventory_level

integer | null

required

read-only

null when inventory is not tracked at the variant level.

custom_fields

object[]

required

Show child attributes

product

object

required

Show child attributes

options

object[]

required

read-only

Show child attributes

List product variants

curl --request GET \
  --url https://{tenant}.api.velocity.medshift.com/v1/product_variants/ \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{tenant}.api.velocity.medshift.com/v1/product_variants/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.api.velocity.medshift.com/v1/product_variants/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{tenant}.api.velocity.medshift.com/v1/product_variants/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{tenant}.api.velocity.medshift.com/v1/product_variants/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bigcommerce_id": 123,
    "sku": "<string>",
    "is_purchasable": true,
    "base_price": "<string>",
    "list_price": "<string>",
    "cost_price": "<string>",
    "inventory_level": 123,
    "custom_fields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "value": null
      }
    ],
    "product": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bigcommerce_id": 123,
      "name": "<string>",
      "is_digital": true,
      "thumbnail_url": "<string>",
      "is_purchasable": true,
      "order_quantity_min": 123,
      "order_quantity_max": 123,
      "inventory_level": 123,
      "commission_programs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ],
      "tax_code": "<string>",
      "lot_serial_required": true
    },
    "options": [
      {
        "bigcommerce_option_id": 123,
        "option_name": "<string>",
        "bigcommerce_value_id": 123,
        "value_label": "<string>"
      }
    ]
  }
]