Get details of a single variant

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
Redeem
Earn
Members

Dropship

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

GET

retailers

{retailer_pk}

variants

{id}

Authorizations

Authorization

string

headerrequired

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

Path Parameters

integer

required

Variant ID

retailer_pk

number

required

Retailer ID

Response

200 - application/json

integer

Variant ID

name

string | null

Variant name

Maximum length: 200

brand_identifier

string

Brand identifier

Minimum length: 1

parent_identifier

string | null

Parent identifier of variant

Maximum length: 100

parent_name

string | null

Parent name of variant

Maximum length: 200

attributes

object[]

attributes.id

integer

Attribute ID

attributes.code

string

required

Attribute code

Required string length: 1 - 200

attributes.name

string

required

Attribute name

Required string length: 1 - 200

attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

attributes.description

string | null

Attribute description

attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

attributes.units

string | null

Unit of the selected attribute type. If the attribute type is money, the unit is USD.

Maximum length: 32

attributes.values

object

attributes.values.id

integer

Attribute value ID

attributes.values.value

string

Attribute value

attributes.values.unit

object

attributes.values.retailer

object

attributes.values.updated_at

string

Time of update

attributes.values.created_at

string

Time of creation

brand

object

identifier

string | null

Stock Keeping Unit (SKU), unique identifier of a product

Maximum length: 128

product_id

string

Product ID

cartons

object[]

upc

string

Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store.

Maximum length: 64

color

string | null

Variant color

Maximum length: 128

style

string | null

Variant style

Maximum length: 128

size

string | null

Variant size

Maximum length: 128

active_permit

object

active_permit.id

integer

Permit ID

active_permit.retailer

object

active_permit.retailer_price

string | null

Retailer price of the variant

active_permit.retailer_cost

string | null

Retailer cost of variant

active_permit.pricing

object

active_permit.attributes

object

active_permit.start_at

string | null

Time of permit start (UTC format)

active_permit.end_at

string | null

Time of permit end (UTC format)

active_permit.is_in_effect

boolean

true: permit is in effect false: permit is not in effect

active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

active_permit.is_acknowledged

boolean

true: permit is acknowledged false: permit is not acknowledged

active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

permits

object[]

permits.id

integer

Permit ID

permits.retailer

object

permits.retailer_price

string | null

Retailer price of the variant

permits.retailer_cost

string | null

Retailer cost of variant

permits.pricing

object

permits.attributes

object

permits.start_at

string | null

Time of permit start (UTC format)

permits.end_at

string | null

Time of permit end (UTC format)

permits.is_in_effect

boolean

true: permit is in effect false: permit is not in effect

permits.revoked_at

string | null

Time when permit got revoked (UTC format)

permits.is_acknowledged

boolean

true: permit is acknowledged false: permit is not acknowledged

permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

permits_count

integer

Count of permits

inventory_policy

string

Inventory policy

inventory

object

inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

inventory.sellable_updated_at

string

required

Time when product or variant was marked sellable (UTC format)

inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

inventory.discontinued

boolean

true: Product is discontinued false: Product is active

inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

inventory.inventory

integer

Inventory of variant

inventory.sellable

string

yes: Variant is sellable No: Variant is not sellable

inventory.replenishable

boolean

true: product is replenishable false: product is not replenishable

inventory.locations

object[]

media

object[]

ruleset_variants

object[]

ruleset_variant_summary

string

Summary of ruleset variant

is_compatible

string

true: variant is compatible false: variant is not compatible

proposal_variant

object

proposal_variant.id

integer

Proposal variant ID

proposal_variant.pricing

string

Pricing of variant

proposal_variant.attributes

object[]

proposal_variant.attributes.id

integer

Attribute value ID

proposal_variant.attributes.value

string

Attribute value

proposal_variant.attributes.unit

object

proposal_variant.attributes.retailer

object

proposal_variant.attributes.updated_at

string

Time of update

proposal_variant.attributes.created_at

string

Time of creation

proposal_variant.memos

object[]

proposal_variant.issues

object[]

proposal_variant.issues.id

integer

Issue ID

proposal_variant.issues.memos

object[]

proposal_variant.issues.created_at

string

Time of issue creation

proposal_variant.issues.updated_at

string

Time of issue update

proposal_variant.issues.resolved_at

string

Time of issue resolution

proposal_variant.issues.is_resolved

string

true: Issue is resolved false: Issue is not resolved

proposal_variant.issues.issue_id

integer

Issue ID

proposal_variant.issues.message

string

Description or note related to issue

Minimum length: 1

proposal_variant.issues.title

string

Issue title

Minimum length: 1

proposal_variant.variant_id

integer

Variant ID

proposal_variant.approved_at

string | null

Time of approval (UTC format)

proposal_variant.created_at

string

Time of creation (UTC format)

proposal_variant.updated_at

string

Time of last update (UTC format)

proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

proposal_variant.reject

boolean

true: proposal is rejected false: proposal is not rejected

proposal_variant.approve

boolean

true: proposal is approved false: proposal is not approved

proposal_variant.delete

boolean

true: proposal is deleted false: proposal is not deleted

retailer_identifiers

object[]

retailer_categories

object

Was this page helpful?

Get active permits List products