Retrieve variant detail

Authorizations

Authorization

string

header

required

Access token

Path Parameters

product_id

string

required

product id

variant_id

string

required

variant id

Query Parameters

customer_group

string

use this param only if different pricing is configured as per customer group

Response

200 - application/json

content

object

required

content.variant

object

content.variant.associated_options

object

content.variant.description

string

content.variant.id

string

variant id

content.variant.images

object[]

content.variant.images.alternate_text

string

content.variant.images.sort_order

integer

content.variant.images.title

string

content.variant.images.url_standard

string

content.variant.images.url_thumbnail

string

content.variant.images.url_tiny

string

content.variant.images.url_zoom

string

content.variant.metadata

object[]

content.variant.metadata.key

string

content.variant.metadata.value

string

content.variant.name

string

variant name

content.variant.packaging

object

content.variant.packaging.calculated_weight

number

in kg

content.variant.packaging.pack_dry_weight

number

in kg

content.variant.packaging.pack_height

number

in cm

content.variant.packaging.pack_length

number

in cm

content.variant.packaging.pack_width

number

in cm

content.variant.packaging.shipper_dry_weight

number

content.variant.packaging.shipper_height

number

content.variant.packaging.shipper_length

number

content.variant.packaging.shipper_width

number

content.variant.packaging.units_per_pack

integer

content.variant.packaging.units_per_shipper

integer

content.variant.packaging.vertical_rotation

boolean

content.variant.packaging.volume_of_packsize

number

content.variant.pricing

object

content.variant.pricing.currency

string

content.variant.pricing.listing_price

number

content.variant.pricing.max_order_quantity

integer

content.variant.pricing.min_order_quantity

integer

content.variant.pricing.price_including_tax

boolean

content.variant.pricing.selling_price

number

content.variant.pricing.tax_rate

number

content.variant.pricing.tax_region

string

content.variant.pricing.tax_type

enum<string>

Available options:

GST

content.variant.promotion

object[]

content.variant.promotion.details

content.variant.promotion.details.discount_type

enum<string>

required

Available options:

percentage,

fixed-amount

content.variant.promotion.details.customer_group_id

string

required for B2B flow only.

content.variant.promotion.details.discount_fixed_amount

string

required if discount_type = fixed-amount

content.variant.promotion.details.discount_percent

string

required if discount_type = percentage

content.variant.promotion.expires_at

string

content.variant.promotion.promotion_type

enum<string>

Available options:

discount,

free_goods,

volume_based

content.variant.promotion.starts_at

string

content.variant.seo

object

content.variant.seo.meta_description

string

content.variant.seo.meta_keywords

string[]

content.variant.seo.meta_title

string

content.variant.seo.slug

string

content.variant.shipping

object

content.variant.shipping.availability_description

string

content.variant.shipping.country_of_origin

string

default:

India

content.variant.shipping.fixed_cost_shipping_price

number

content.variant.shipping.is_fixed_cost_shipping

boolean

default:

false

content.variant.shipping.is_free_shipping

boolean

default:

false

content.variant.shipping.mid_code

string

content.variant.shipping.shipping_price_including_tax

boolean

content.variant.shipping.ships_internationally

boolean

content.variant.shipping.tax_rate

number

content.variant.shipping.tax_region

string

content.variant.shipping.tax_type

string

content.variant.short_description

string

content.variant.sku

string

variant sku

content.variant.stock_available

boolean

content.variant.subscription

object[]

content.variant.subscription.billing_frequency

enum<string>

Available options:

weekly,

monthly,

annually

content.variant.subscription.billing_interval

integer

Billing interval determines the frequency for which the customer is charged for the subscription itself.

content.variant.subscription.billing_limit

integer

Optionally limit the number of times this subscription will invoice the customer.

content.variant.subscription.billing_trial_days

integer

Use in digital product only for trial period

content.variant.subscription.fulfill_separately

boolean

default:

false

content.variant.subscription.order_frequency

enum<string>

Available options:

weekly,

monthly,

annully

content.variant.subscription.order_interval

integer

order interval defines the frequency of when the subscription sends customers the product

content.variant.subscription.order_limit

integer

By default this is set to unlimited, meaning the subscription will fulfill indefinitely. Changing the Limit to 10 would force the subscription to end after the tenth interval had been fulfilled.

content.variant.subscription.quantity

integer

The quantity of the plan to which the customer should be subscribed

content.variant.subscription.subscription_plan

string

content.variant.subscription.subscription_price

number

message

string

required

success

boolean

default:

true

required

API Documentation

Authentication APIs

Catalog APIs

Cart & Checkout APIs

Coupons & promotions API

Customers API

Orders APIs

Shipping APIs

Payments API

Common API

Analytics

Campaigns API

Authorizations

Path Parameters

Query Parameters

Response