Get inventory of a single variant

Gets the inventory position for a single variant.

Authorizations

Authorization

string

header

required

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

Path Parameters

retailer_pk

number

required

Retailer ID

id

number

required

Inventory ID

Response

200 - application/json

brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

estimated_availability_date

string

required

Estimated availability date of variant

Minimum length: 1

inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

inventory_updated_at

string

required

Time of inventory update (UTC format)

sellable_updated_at

string

required

Time variant was marked sellable (UTC format)

discontinued

boolean

true: Variant is discontinued <br /> false: Variant is active

discontinued_updated_at

string

Time variant marked discontinued (UTC format)

inventory

integer

Count of variant available for sale

inventory_policy

enum<string>

Represents whether vendor wants to manage the inventory or not

Available options:

unmanaged,

managed

locations

object[]

Show child attributes

locations.address

object

Show child attributes

locations.address.city

string

required

City name

Required string length: 1 - 64

locations.address.country

string

required

Country name

Required string length: 1 - 128

locations.address.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

locations.address.postal_code

string

required

Postal code

Required string length: 1 - 32

locations.address.province

string

required

State name

Required string length: 1 - 32

locations.address.street1

string

required

Line 1 of the address

Required string length: 1 - 128

locations.address.email

string | null

Contact email address

Maximum length: 128

locations.address.fax

string | null

Fax number

Maximum length: 32

locations.address.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

locations.address.id

integer

Address ID

locations.address.name2

string | null

Name of the alternative contact?

Maximum length: 64

locations.address.phone1

string | null

Primary contact number

Maximum length: 32

locations.address.phone2

string | null

Alternate contact number

Maximum length: 32

locations.address.street2

string | null

Line 2 of the address

Maximum length: 128

locations.address.type

enum<string> | null

Type of address

Available options:

residential,

commercial

locations.id

integer

Location ID

locations.inventory

integer

Count of sellable variants

locations.nickname

string

Nickname of location

replenishable

boolean

true: Variant is replenishable <br /> false: Variant is not replenishable

sellable

string

true: Variant is sellable <br /> false: Variant is not sellable

variant

object

Show child attributes

variant.active_permit

object

Show child attributes

variant.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

variant.active_permit.attributes

object

variant.active_permit.end_at

string | null

Time of permit end (UTC format)

variant.active_permit.id

integer

Permit ID

variant.active_permit.is_acknowledged

boolean

true: permit is acknowledged <br /> false: permit is not acknowledged

variant.active_permit.is_in_effect

boolean

true: permit is in effect <br /> false: permit is not in effect

variant.active_permit.pricing

object

variant.active_permit.retailer

object

Show child attributes

variant.active_permit.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

variant.active_permit.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variant.active_permit.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

variant.active_permit.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variant.active_permit.retailer.id

integer

Retailer ID

variant.active_permit.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

variant.active_permit.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

variant.active_permit.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variant.active_permit.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variant.active_permit.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variant.active_permit.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variant.active_permit.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variant.active_permit.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variant.active_permit.retailer.website

string | null

Website URL

Maximum length: 100

variant.active_permit.retailer_cost

string | null

Retailer cost of variant

variant.active_permit.retailer_price

string | null

Retailer price of the variant

variant.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

variant.active_permit.start_at

string | null

Time of permit start (UTC format)

variant.attributes

object[]

Show child attributes

variant.attributes.code

string

required

Attribute code

Required string length: 1 - 200

variant.attributes.name

string

required

Attribute name

Required string length: 1 - 200

variant.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

variant.attributes.description

string | null

Attribute description

variant.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

variant.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

variant.attributes.id

integer

Attribute ID

variant.attributes.units

string | null

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

Maximum length: 32

variant.attributes.values

object

Show child attributes

variant.attributes.values.created_at

string

Time of creation

variant.attributes.values.id

integer

Attribute value ID

variant.attributes.values.retailer

object

Show child attributes

variant.attributes.values.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

variant.attributes.values.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variant.attributes.values.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

variant.attributes.values.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variant.attributes.values.retailer.id

integer

Retailer ID

variant.attributes.values.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

variant.attributes.values.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

variant.attributes.values.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variant.attributes.values.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variant.attributes.values.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variant.attributes.values.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variant.attributes.values.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variant.attributes.values.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variant.attributes.values.retailer.website

string | null

Website URL

Maximum length: 100

variant.attributes.values.unit

object

Show child attributes

variant.attributes.values.unit.id

integer

Unit ID

variant.attributes.values.unit.name

string

Unit name

Minimum length: 1

variant.attributes.values.unit.standard_unit

string

Standard unit

Minimum length: 1

variant.attributes.values.unit.symbol

string | null

Unit symbol

Maximum length: 5

variant.attributes.values.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

variant.attributes.values.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

variant.attributes.values.updated_at

string

Time of update

variant.attributes.values.value

string

Attribute value

variant.brand

object

Show child attributes

variant.brand.code

string

required

Vendor code, which is vendor name in lower case and underscore

Required string length: 1 - 64

variant.brand.cover_url

string

URL of the cover image

Minimum length: 1

variant.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

variant.brand.id

integer

Vendor (brand) ID

variant.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

variant.brand.is_on_rcn

boolean

true: is on Dropship network <br /> false: not on Dropship network

variant.brand.is_onboarded

boolean

true: Vendor is onboarded <br /> false: Vendor is not onboarded

variant.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

variant.brand.logo_url

string

URL of the brand logo

Minimum length: 1

variant.brand.name

string

Vendor name

Required string length: 1 - 64

variant.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

variant.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

variant.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

variant.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

variant.brand.subscription_is_delinquent

boolean

true: subscription is overdue <br /> false: subscription is paid

variant.brand.subscription_is_expired

boolean

true: subscription is expired <br /> false: subscription is active

variant.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period <br /> false: subscription is not on grace period

variant.brand.website

string | null

URL of brand website

Maximum length: 100

variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

variant.cartons

object[]

Show child attributes

variant.cartons.height

string | null

Carton height

variant.cartons.height_unit

string

Unit of height

variant.cartons.id

integer

Carton ID

variant.cartons.length

string | null

Carton length

variant.cartons.length_unit

string

Unit of length

variant.cartons.number

integer

Carton number

Required range: -2147483648 < x < 2147483647

variant.cartons.package_girth_inches

string

Girth of the package, in inches

variant.cartons.package_size_inches

string

Size of the package, in inches

variant.cartons.weight

string | null

Carton weight

variant.cartons.weight_unit

string

Unit of weight

variant.cartons.width

string | null

Carton width

variant.cartons.width_unit

string

Unit of width

variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

variant.id

integer

Variant ID

variant.identifier

string | null

Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.

Maximum length: 128

variant.inventory

object

Show child attributes

variant.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

variant.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

variant.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

variant.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

variant.inventory.sellable_updated_at

string

required

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

variant.inventory.discontinued

boolean

true: Product is discontinued <br /> false: Product is active

variant.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

variant.inventory.inventory

integer

Inventory of variant

variant.inventory.locations

object[]

Show child attributes

variant.inventory.locations.address

object

Show child attributes

variant.inventory.locations.address.city

string

required

City name

Required string length: 1 - 64

variant.inventory.locations.address.country

string

required

Country name

Required string length: 1 - 128

variant.inventory.locations.address.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

variant.inventory.locations.address.postal_code

string

required

Postal code

Required string length: 1 - 32

variant.inventory.locations.address.province

string

required

State name

Required string length: 1 - 32

variant.inventory.locations.address.street1

string

required

Line 1 of the address

Required string length: 1 - 128

variant.inventory.locations.address.email

string | null

Contact email address

Maximum length: 128

variant.inventory.locations.address.fax

string | null

Fax number

Maximum length: 32

variant.inventory.locations.address.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

variant.inventory.locations.address.id

integer

Address ID

variant.inventory.locations.address.name2

string | null

Name of the alternative contact?

Maximum length: 64

variant.inventory.locations.address.phone1

string | null

Primary contact number

Maximum length: 32

variant.inventory.locations.address.phone2

string | null

Alternate contact number

Maximum length: 32

variant.inventory.locations.address.street2

string | null

Line 2 of the address

Maximum length: 128

variant.inventory.locations.address.type

enum<string> | null

Type of address

Available options:

residential,

commercial

variant.inventory.locations.id

integer

Location ID

variant.inventory.locations.inventory

integer

Count of sellable variants

variant.inventory.locations.nickname

string

Nickname of location

variant.inventory.replenishable

boolean

true: product is replenishable <br /> false: product is not replenishable

variant.inventory.sellable

string

yes: Variant is sellable <br /> No: Variant is not sellable

variant.is_compatible

boolean

true: variant meets requirement <br /> false: variant doesn not meet requirement

variant.media

object[]

Show child attributes

variant.media.created_at

string

Time of variant image creation (UTC format)

variant.media.height

integer | null

Height of variant image

Required range: -2147483648 < x < 2147483647

variant.media.id

integer

Variant ID

variant.media.media

string

Variant images

variant.media.priority

integer

Order in which the vendor prefers the images to be shown image 1 is shown first.

Required range: -2147483648 < x < 2147483647

variant.media.updated_at

string

Time of variant image update (UTC format)

variant.media.url

string

URL of variant image

variant.media.width

integer | null

Width of variant image

Required range: -2147483648 < x < 2147483647

variant.name

string | null

Variant Name

Maximum length: 200

variant.permits

object[]

Show child attributes

variant.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

variant.permits.attributes

object

variant.permits.end_at

string | null

Time of permit end (UTC format)

variant.permits.id

integer

Permit ID

variant.permits.is_acknowledged

boolean

true: permit is acknowledged <br /> false: permit is not acknowledged

variant.permits.is_in_effect

boolean

true: permit is in effect <br /> false: permit is not in effect

variant.permits.pricing

object

variant.permits.retailer

object

Show child attributes

variant.permits.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

variant.permits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variant.permits.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

variant.permits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variant.permits.retailer.id

integer

Retailer ID

variant.permits.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

variant.permits.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

variant.permits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variant.permits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variant.permits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variant.permits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variant.permits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variant.permits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variant.permits.retailer.website

string | null

Website URL

Maximum length: 100

variant.permits.retailer_cost

string | null

Retailer cost of variant

variant.permits.retailer_price

string | null

Retailer price of the variant

variant.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

variant.permits.start_at

string | null

Time of permit start (UTC format)

variant.proposal_variant

object

Show child attributes

variant.proposal_variant.approve

boolean

true: proposal is approved <br /> false: proposal is not approved

variant.proposal_variant.approved_at

string | null

Time of approval (UTC format)

variant.proposal_variant.attributes

object[]

Show child attributes

variant.proposal_variant.attributes.created_at

string

Time of creation

variant.proposal_variant.attributes.id

integer

Attribute value ID

variant.proposal_variant.attributes.retailer

object

Show child attributes

variant.proposal_variant.attributes.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

variant.proposal_variant.attributes.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variant.proposal_variant.attributes.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

variant.proposal_variant.attributes.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variant.proposal_variant.attributes.retailer.id

integer

Retailer ID

variant.proposal_variant.attributes.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

variant.proposal_variant.attributes.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

variant.proposal_variant.attributes.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variant.proposal_variant.attributes.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variant.proposal_variant.attributes.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variant.proposal_variant.attributes.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variant.proposal_variant.attributes.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variant.proposal_variant.attributes.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variant.proposal_variant.attributes.retailer.website

string | null

Website URL

Maximum length: 100

variant.proposal_variant.attributes.unit

object

Show child attributes

variant.proposal_variant.attributes.unit.id

integer

Unit ID

variant.proposal_variant.attributes.unit.name

string

Unit name

Minimum length: 1

variant.proposal_variant.attributes.unit.standard_unit

string

Standard unit

Minimum length: 1

variant.proposal_variant.attributes.unit.symbol

string | null

Unit symbol

Maximum length: 5

variant.proposal_variant.attributes.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

variant.proposal_variant.attributes.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

variant.proposal_variant.attributes.updated_at

string

Time of update

variant.proposal_variant.attributes.value

string

Attribute value

variant.proposal_variant.created_at

string

Time of creation (UTC format)

variant.proposal_variant.delete

boolean

true: proposal is deleted <br /> false: proposal is not deleted

variant.proposal_variant.id

integer

Proposal variant ID

variant.proposal_variant.issues

object[]

Show child attributes

variant.proposal_variant.issues.created_at

string

Time of issue creation

variant.proposal_variant.issues.id

integer

Issue ID

variant.proposal_variant.issues.is_resolved

string

true: Issue is resolved <br /> false: Issue is not resolved

variant.proposal_variant.issues.issue_id

integer

Issue ID

variant.proposal_variant.issues.memos

object[]

Show child attributes

variant.proposal_variant.issues.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

variant.proposal_variant.issues.memos.created_at

string

Time of memo creation (UTC format)

variant.proposal_variant.issues.memos.created_by

object

Show child attributes

variant.proposal_variant.issues.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

variant.proposal_variant.issues.memos.id

integer

Memo ID

variant.proposal_variant.issues.memos.notify_people

boolean

true: notify stakeholders <br /> false: do not notify

variant.proposal_variant.issues.memos.text

string

Memo text

variant.proposal_variant.issues.memos.updated_at

string

Time of memo update (UTC format)

variant.proposal_variant.issues.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

variant.proposal_variant.issues.message

string

Description or note related to issue

Minimum length: 1

variant.proposal_variant.issues.resolved_at

string

Time of issue resolution

variant.proposal_variant.issues.title

string

Issue title

Minimum length: 1

variant.proposal_variant.issues.updated_at

string

Time of issue update

variant.proposal_variant.memos

object[]

Show child attributes

variant.proposal_variant.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

variant.proposal_variant.memos.created_at

string

Time of memo creation (UTC format)

variant.proposal_variant.memos.created_by

object

Show child attributes

variant.proposal_variant.memos.created_by.first_name

string | null

First name of user

Maximum length: 64

variant.proposal_variant.memos.created_by.id

integer

User ID who accepted or rejected the invoice

variant.proposal_variant.memos.created_by.is_me

boolean

true: user is me: <br /> false: user is not me

variant.proposal_variant.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

variant.proposal_variant.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

variant.proposal_variant.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

variant.proposal_variant.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

variant.proposal_variant.memos.created_by.title

string | null

User title

Maximum length: 64

variant.proposal_variant.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

variant.proposal_variant.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

variant.proposal_variant.memos.id

integer

Memo ID

variant.proposal_variant.memos.notify_people

boolean

true: notify stakeholders <br /> false: do not notify

variant.proposal_variant.memos.text

string

Memo text

variant.proposal_variant.memos.updated_at

string

Time of memo update (UTC format)

variant.proposal_variant.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

variant.proposal_variant.pricing

string

Pricing of variant

variant.proposal_variant.reject

boolean

true: proposal is rejected <br /> false: proposal is not rejected

variant.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

variant.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

variant.proposal_variant.updated_at

string

Time of last update (UTC format)

variant.proposal_variant.variant_id

integer

Variant ID

variant.retailer_categories

object

Show child attributes

variant.retailer_categories.category

string

required

Category name

Required string length: 1 - 256

variant.retailer_categories.id

integer

Retailer category ID

variant.retailer_categories.retailer

object

Show child attributes

variant.retailer_categories.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

variant.retailer_categories.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variant.retailer_categories.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

variant.retailer_categories.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variant.retailer_categories.retailer.id

integer

Retailer ID

variant.retailer_categories.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

variant.retailer_categories.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

variant.retailer_categories.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variant.retailer_categories.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variant.retailer_categories.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variant.retailer_categories.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variant.retailer_categories.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variant.retailer_categories.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variant.retailer_categories.retailer.website

string | null

Website URL

Maximum length: 100

variant.retailer_identifiers

object

Show child attributes

variant.retailer_identifiers.id

integer

Retailer ID

variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

variant.retailer_identifiers.retailer

object

Show child attributes

variant.retailer_identifiers.retailer.code

string

required

Retailer code, which is retailer name in lower case and hyphenated

Required string length: 1 - 32

variant.retailer_identifiers.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variant.retailer_identifiers.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit

variant.retailer_identifiers.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variant.retailer_identifiers.retailer.id

integer

Retailer ID

variant.retailer_identifiers.retailer.is_onboarded

boolean

true: Retailer is onboarded <br /> false: Retailer is not onboarded

variant.retailer_identifiers.retailer.is_rcn_retailer

boolean

true: Retailer is in Dropship network; Retailer is not in Dropship network

variant.retailer_identifiers.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variant.retailer_identifiers.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variant.retailer_identifiers.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variant.retailer_identifiers.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variant.retailer_identifiers.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variant.retailer_identifiers.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variant.retailer_identifiers.retailer.website

string | null

Website URL

Maximum length: 100

variant.ruleset_variant_summary

string

Number of items that are passed and failed in rule validation.

variant.ruleset_variants

object[]

Show child attributes

variant.ruleset_variants.created_at

string

Time of creation (UTC format)

variant.ruleset_variants.id

integer

ID of ruleset variant

variant.ruleset_variants.results

string

Response

variant.ruleset_variants.ruleset

object

Show child attributes

variant.ruleset_variants.ruleset.created_at

string

Time of creation (UTC format)

variant.ruleset_variants.ruleset.id

integer

ID of ruleset variant

variant.ruleset_variants.ruleset.results

string

Response

variant.ruleset_variants.ruleset.ruleset

object

Show child attributes

variant.ruleset_variants.ruleset.ruleset.created_at

string

Time of creation (UTC format)

variant.ruleset_variants.ruleset.ruleset.id

integer

ID of ruleset variant

variant.ruleset_variants.ruleset.ruleset.results

string

Response

variant.ruleset_variants.ruleset.ruleset.ruleset

object

Show child attributes

variant.ruleset_variants.ruleset.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

variant.ruleset_variants.ruleset.ruleset.updated_at

string

Time of last update (UTC format)

variant.ruleset_variants.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

variant.ruleset_variants.ruleset.updated_at

string

Time of last update (UTC format)

variant.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

variant.ruleset_variants.updated_at

string

Time of last update (UTC format)

variant.size

string | null

Size of the item (will be the same value as attributes.size)

Maximum length: 128

variant.style

string | null

Style of the item (will be the same value as attributes.style)

Maximum length: 128

variant.upc

string

UPC or other GTIN

Maximum length: 64