Get single product details

Gets the details for a specified product.

Authorizations

Authorization

string

header

required

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

Path Parameters

id

integer

required

Product ID

retailer_pk

number

required

Retailer ID

Response

200 - application/json

attributes

object[]

Show child attributes

attributes.code

string

required

Attribute code

Required string length: 1 - 200

attributes.name

string

required

Attribute name

Required string length: 1 - 200

attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

attributes.description

string | null

Attribute description

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.id

integer

Attribute ID

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

Show child attributes

attributes.values.created_at

string

Time of creation

attributes.values.id

integer

Attribute value ID

attributes.values.retailer

object

Show child attributes

attributes.values.retailer.code

string

required

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

Required string length: 1 - 32

attributes.values.retailer.name

string

required

Retailer name

Required string length: 1 - 64

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

attributes.values.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

attributes.values.retailer.id

integer

Retailer ID

attributes.values.retailer.is_onboarded

boolean

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

attributes.values.retailer.is_rcn_retailer

boolean

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

attributes.values.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

attributes.values.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

attributes.values.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

attributes.values.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

attributes.values.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

attributes.values.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

attributes.values.retailer.website

string | null

Website URL

Maximum length: 100

attributes.values.unit

object

Show child attributes

attributes.values.unit.id

integer

Unit ID

attributes.values.unit.name

string

Unit name

Minimum length: 1

attributes.values.unit.standard_unit

string

Standard unit

Minimum length: 1

attributes.values.unit.symbol

string | null

Unit symbol

Maximum length: 5

attributes.values.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

attributes.values.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

attributes.values.updated_at

string

Time of update

attributes.values.value

string

Attribute value

brand

object

Show child attributes

brand.code

string

required

Vendor code. Same as vendor name in lower case and hyphenated

Required string length: 1 - 64

brand.id

integer

Vendor ID

brand.name

string

Vendor name

Required string length: 1 - 64

brand_category

string | null

Brand category

Required string length: 1 - 64

brand_name

string | null

Brand name

Required string length: 1 - 64

created_at

string

Time of product creation in Dropship

description

string | null

Product description

id

integer

product ID

last_published

object

Show child attributes

last_published.created_at

string

Time of creation

last_published.id

integer

Product ID

last_published.message

string | null

Message added while publishing, for future reference

last_published.platform_account

object

Show child attributes

last_published.platform_account.brand

string

Brand name

last_published.platform_account.credentials

string

Credentials to use account

last_published.platform_account.id

integer

Platform account ID

last_published.platform_account.platform

string

Platform name

last_published.platform_account.retailer

string

Retailer name

last_published.product

object

Show child attributes

last_published.product.identifier

string

required

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

Required string length: 1 - 128

last_published.product.brand

object

Show child attributes

last_published.product.brand.code

string

required

Vendor code. Same as vendor name in lower case and hyphenated

Required string length: 1 - 64

last_published.product.brand.id

integer

Vendor ID

last_published.product.brand.name

string

Vendor name

Required string length: 1 - 64

last_published.product.brand_category

string | null

Brand category

Required string length: 1 - 64

last_published.product.brand_name

string | null

Brand name

Required string length: 1 - 64

last_published.product.created_at

string

Time of product creation in Dropship

last_published.product.description

string | null

Product description

last_published.product.expires_at

string | null

Time of expiry (UTC format)

last_published.product.id

integer

Product ID

last_published.product.name

string | null

Product name

Maximum length: 200

last_published.product.num_variants

integer

Number of product variants

last_published.product.parent_identifier

string

Parent identifier

Minimum length: 1

last_published.product.parent_name

string

Parent name

Minimum length: 1

last_published.product.pricing

string

Product pricing

last_published.product.primary_media

object

Show child attributes

last_published.product.primary_media.created_at

string

Time of product image creation

last_published.product.primary_media.height

integer | null

Product image height

Required range: -2147483648 < x < 2147483647

last_published.product.primary_media.id

integer

Product image ID

last_published.product.primary_media.media

string

Product image media

last_published.product.primary_media.priority

integer

Image priority

Required range: -2147483648 < x < 2147483647

last_published.product.primary_media.updated_at

string

Time of when product image was last updated

last_published.product.primary_media.url

string

Product image URL

last_published.product.primary_media.width

integer | null

Product image width

Required range: -2147483648 < x < 2147483647

last_published.product.published_at

string | null

Time of when product was first published

last_published.product.rcn_status

enum<string>

Status of product in Dropship

Available options:

not_published,

pending,

failed,

expired,

published

last_published.product.updated_at

string

Time of when product was last updated in Dropship

last_published.success

boolean

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

manufacturer

object

Show child attributes

manufacturer.code

string

required

Manufacturer code

Required string length: 1 - 32

manufacturer.cover_url

string

URL of manufacturer's cover image

Minimum length: 1

manufacturer.id

integer

Manufacturer ID

manufacturer.logo_url

string

URL of manufacturer's logo

Minimum length: 1

manufacturer.name

string

Manufacturer name

Required string length: 1 - 64

manufacturer.profile_tile_url

string

URL of manufacturer's profile image

Minimum length: 1

manufacturer.uuid

string

A universally unique identifier (UUID)

Maximum length: 36

manufacturer.website

string | null

URL of manufacturer website

Maximum length: 100

media

object[]

Show child attributes

media.created_at

string

Time of variant image creation (UTC format)

media.height

integer | null

Height of variant image

Required range: -2147483648 < x < 2147483647

media.id

integer

Variant ID

media.media

string

Variant images

media.priority

integer

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

Required range: -2147483648 < x < 2147483647

media.updated_at

string

Time of variant image update (UTC format)

media.url

string

URL of variant image

media.width

integer | null

Width of variant image

Required range: -2147483648 < x < 2147483647

num_variants

integer

Number of variants

parent_identifier

string

ID of parent product

Minimum length: 1

parent_name

string

Parent name

Minimum length: 1

pivot_attributes

object[]

Show child attributes

pivot_attributes.code

string

required

Attribute code

Required string length: 1 - 200

pivot_attributes.name

string

required

Attribute name

Required string length: 1 - 200

pivot_attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

pivot_attributes.available_units

object[]

Show child attributes

pivot_attributes.available_units.id

integer

Unit ID

pivot_attributes.available_units.name

string

Unit name

Minimum length: 1

pivot_attributes.available_units.standard_unit

string

Standard unit

Minimum length: 1

pivot_attributes.available_units.symbol

string | null

Unit symbol

Maximum length: 5

pivot_attributes.available_units.system

enum<string> | null

Unit system

Available options:

metric,

imperial

pivot_attributes.available_units.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

pivot_attributes.default_unit

object[]

Show child attributes

pivot_attributes.default_unit.id

integer

Unit ID

pivot_attributes.default_unit.name

string

Unit name

Minimum length: 1

pivot_attributes.default_unit.standard_unit

string

Standard unit

Minimum length: 1

pivot_attributes.default_unit.symbol

string | null

Unit symbol

Maximum length: 5

pivot_attributes.default_unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

pivot_attributes.default_unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

pivot_attributes.description

string | null

Attribute description

pivot_attributes.editable_by

enum<string> | null

User who can edit attribute

Available options:

retailer,

brand,

any,

none

pivot_attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

pivot_attributes.id

integer

Attribute ID

pivot_attributes.is_bulk_editable

boolean

true: allow bulk edit of attributes <br /> false: bulk edit of attributes are not allowed

pivot_attributes.priority

integer

Attribute priority

Required range: 0 < x < 4294967295

pivot_attributes.units

string | null

Unity based on type

Maximum length: 32

primary_media

object

Show child attributes

primary_media.created_at

string

Time of product image creation

primary_media.height

integer | null

Product image height

Required range: -2147483648 < x < 2147483647

primary_media.id

integer

Product image ID

primary_media.media

string

Product image media

primary_media.priority

integer

Image priority

Required range: -2147483648 < x < 2147483647

primary_media.updated_at

string

Time of when product image was last updated

primary_media.url

string

Product image URL

primary_media.width

integer | null

Product image width

Required range: -2147483648 < x < 2147483647

rcn_status

enum<string>

Status of product in Dropship network

Available options:

not_published,

pending,

failed,

expired,

published

revcascade_taxonomy

object[]

Show child attributes

revcascade_taxonomy.code

string

required

Taxonomy code

Required string length: 1 - 32

revcascade_taxonomy.id

integer

Taxonomy ID

revcascade_taxonomy.name

string

Taxonomy name

Required string length: 1 - 64

revcascade_taxonomy.number_of_children

string

Number of children

revcascade_taxonomy.pivot_attributes

object[]

Show child attributes

revcascade_taxonomy.pivot_attributes.code

string

required

Attribute code

Required string length: 1 - 200

revcascade_taxonomy.pivot_attributes.name

string

required

Attribute name

Required string length: 1 - 200

revcascade_taxonomy.pivot_attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

revcascade_taxonomy.pivot_attributes.available_units

object[]

Show child attributes

revcascade_taxonomy.pivot_attributes.available_units.id

integer

Unit ID

revcascade_taxonomy.pivot_attributes.available_units.name

string

Unit name

Minimum length: 1

revcascade_taxonomy.pivot_attributes.available_units.standard_unit

string

Standard unit

Minimum length: 1

revcascade_taxonomy.pivot_attributes.available_units.symbol

string | null

Unit symbol

Maximum length: 5

revcascade_taxonomy.pivot_attributes.available_units.system

enum<string> | null

Unit system

Available options:

metric,

imperial

revcascade_taxonomy.pivot_attributes.available_units.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

revcascade_taxonomy.pivot_attributes.default_unit

object[]

Show child attributes

revcascade_taxonomy.pivot_attributes.default_unit.id

integer

Unit ID

revcascade_taxonomy.pivot_attributes.default_unit.name

string

Unit name

Minimum length: 1

revcascade_taxonomy.pivot_attributes.default_unit.standard_unit

string

Standard unit

Minimum length: 1

revcascade_taxonomy.pivot_attributes.default_unit.symbol

string | null

Unit symbol

Maximum length: 5

revcascade_taxonomy.pivot_attributes.default_unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

revcascade_taxonomy.pivot_attributes.default_unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

revcascade_taxonomy.pivot_attributes.description

string | null

Attribute description

revcascade_taxonomy.pivot_attributes.editable_by

enum<string> | null

User who can edit attribute

Available options:

retailer,

brand,

any,

none

revcascade_taxonomy.pivot_attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

revcascade_taxonomy.pivot_attributes.id

integer

Attribute ID

revcascade_taxonomy.pivot_attributes.is_bulk_editable

boolean

true: allow bulk edit of attributes <br /> false: bulk edit of attributes are not allowed

revcascade_taxonomy.pivot_attributes.priority

integer

Attribute priority

Required range: 0 < x < 4294967295

revcascade_taxonomy.pivot_attributes.units

string | null

Unity based on type

Maximum length: 32

revcascade_taxonomy.thumbnail_url

string

URL for thumbnail image

Minimum length: 1

revcascade_taxonomy.visible_attributes

object[]

Show child attributes

revcascade_taxonomy.visible_attributes.code

string

required

Attribute code

Required string length: 1 - 200

revcascade_taxonomy.visible_attributes.name

string

required

Attribute name

Required string length: 1 - 200

revcascade_taxonomy.visible_attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

revcascade_taxonomy.visible_attributes.available_units

object[]

Show child attributes

revcascade_taxonomy.visible_attributes.available_units.id

integer

Unit ID

revcascade_taxonomy.visible_attributes.available_units.name

string

Unit name

Minimum length: 1

revcascade_taxonomy.visible_attributes.available_units.standard_unit

string

Standard unit

Minimum length: 1

revcascade_taxonomy.visible_attributes.available_units.symbol

string | null

Unit symbol

Maximum length: 5

revcascade_taxonomy.visible_attributes.available_units.system

enum<string> | null

Unit system

Available options:

metric,

imperial

revcascade_taxonomy.visible_attributes.available_units.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

revcascade_taxonomy.visible_attributes.default_unit

object[]

Show child attributes

revcascade_taxonomy.visible_attributes.default_unit.id

integer

Unit ID

revcascade_taxonomy.visible_attributes.default_unit.name

string

Unit name

Minimum length: 1

revcascade_taxonomy.visible_attributes.default_unit.standard_unit

string

Standard unit

Minimum length: 1

revcascade_taxonomy.visible_attributes.default_unit.symbol

string | null

Unit symbol

Maximum length: 5

revcascade_taxonomy.visible_attributes.default_unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

revcascade_taxonomy.visible_attributes.default_unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

revcascade_taxonomy.visible_attributes.description

string | null

Attribute description

revcascade_taxonomy.visible_attributes.editable_by

enum<string> | null

User who can edit attribute

Available options:

retailer,

brand,

any,

none

revcascade_taxonomy.visible_attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

revcascade_taxonomy.visible_attributes.id

integer

Attribute ID

revcascade_taxonomy.visible_attributes.is_bulk_editable

boolean

true: allow bulk edit of attributes <br /> false: bulk edit of attributes are not allowed

revcascade_taxonomy.visible_attributes.priority

integer

Attribute priority

Required range: 0 < x < 4294967295

revcascade_taxonomy.visible_attributes.units

string | null

Unity based on type

Maximum length: 32

taxonomy

object[]

Show child attributes

taxonomy.code

string

required

Taxonomy code

Required string length: 1 - 32

taxonomy.id

integer

Taxonomy ID

taxonomy.name

string

Taxonomy name

Required string length: 1 - 64

taxonomy.number_of_children

string

Number of children

taxonomy.pivot_attributes

object[]

Show child attributes

taxonomy.pivot_attributes.code

string

required

Attribute code

Required string length: 1 - 200

taxonomy.pivot_attributes.name

string

required

Attribute name

Required string length: 1 - 200

taxonomy.pivot_attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

taxonomy.pivot_attributes.available_units

object[]

Show child attributes

taxonomy.pivot_attributes.available_units.id

integer

Unit ID

taxonomy.pivot_attributes.available_units.name

string

Unit name

Minimum length: 1

taxonomy.pivot_attributes.available_units.standard_unit

string

Standard unit

Minimum length: 1

taxonomy.pivot_attributes.available_units.symbol

string | null

Unit symbol

Maximum length: 5

taxonomy.pivot_attributes.available_units.system

enum<string> | null

Unit system

Available options:

metric,

imperial

taxonomy.pivot_attributes.available_units.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

taxonomy.pivot_attributes.default_unit

object[]

Show child attributes

taxonomy.pivot_attributes.default_unit.id

integer

Unit ID

taxonomy.pivot_attributes.default_unit.name

string

Unit name

Minimum length: 1

taxonomy.pivot_attributes.default_unit.standard_unit

string

Standard unit

Minimum length: 1

taxonomy.pivot_attributes.default_unit.symbol

string | null

Unit symbol

Maximum length: 5

taxonomy.pivot_attributes.default_unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

taxonomy.pivot_attributes.default_unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

taxonomy.pivot_attributes.description

string | null

Attribute description

taxonomy.pivot_attributes.editable_by

enum<string> | null

User who can edit attribute

Available options:

retailer,

brand,

any,

none

taxonomy.pivot_attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

taxonomy.pivot_attributes.id

integer

Attribute ID

taxonomy.pivot_attributes.is_bulk_editable

boolean

true: allow bulk edit of attributes <br /> false: bulk edit of attributes are not allowed

taxonomy.pivot_attributes.priority

integer

Attribute priority

Required range: 0 < x < 4294967295

taxonomy.pivot_attributes.units

string | null

Unity based on type

Maximum length: 32

taxonomy.thumbnail_url

string

URL for thumbnail image

Minimum length: 1

taxonomy.visible_attributes

object[]

Show child attributes

taxonomy.visible_attributes.code

string

required

Attribute code

Required string length: 1 - 200

taxonomy.visible_attributes.name

string

required

Attribute name

Required string length: 1 - 200

taxonomy.visible_attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

taxonomy.visible_attributes.available_units

object[]

Show child attributes

taxonomy.visible_attributes.available_units.id

integer

Unit ID

taxonomy.visible_attributes.available_units.name

string

Unit name

Minimum length: 1

taxonomy.visible_attributes.available_units.standard_unit

string

Standard unit

Minimum length: 1

taxonomy.visible_attributes.available_units.symbol

string | null

Unit symbol

Maximum length: 5

taxonomy.visible_attributes.available_units.system

enum<string> | null

Unit system

Available options:

metric,

imperial

taxonomy.visible_attributes.available_units.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

taxonomy.visible_attributes.default_unit

object[]

Show child attributes

taxonomy.visible_attributes.default_unit.id

integer

Unit ID

taxonomy.visible_attributes.default_unit.name

string

Unit name

Minimum length: 1

taxonomy.visible_attributes.default_unit.standard_unit

string

Standard unit

Minimum length: 1

taxonomy.visible_attributes.default_unit.symbol

string | null

Unit symbol

Maximum length: 5

taxonomy.visible_attributes.default_unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

taxonomy.visible_attributes.default_unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

taxonomy.visible_attributes.description

string | null

Attribute description

taxonomy.visible_attributes.editable_by

enum<string> | null

User who can edit attribute

Available options:

retailer,

brand,

any,

none

taxonomy.visible_attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

taxonomy.visible_attributes.id

integer

Attribute ID

taxonomy.visible_attributes.is_bulk_editable

boolean

true: allow bulk edit of attributes <br /> false: bulk edit of attributes are not allowed

taxonomy.visible_attributes.priority

integer

Attribute priority

Required range: 0 < x < 4294967295

taxonomy.visible_attributes.units

string | null

Unity based on type

Maximum length: 32

updated_at

string

Time of when product was last updated in Dropship

variants

object

Show child attributes

variants.active_permit

object

Show child attributes

variants.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

variants.active_permit.attributes

object

variants.active_permit.end_at

string | null

Time of permit end (UTC format)

variants.active_permit.id

integer

Permit ID

variants.active_permit.is_acknowledged

boolean

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

variants.active_permit.is_in_effect

boolean

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

variants.active_permit.pricing

object

variants.active_permit.retailer

object

Show child attributes

variants.active_permit.retailer.code

string

required

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

Required string length: 1 - 32

variants.active_permit.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variants.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

variants.active_permit.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variants.active_permit.retailer.id

integer

Retailer ID

variants.active_permit.retailer.is_onboarded

boolean

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

variants.active_permit.retailer.is_rcn_retailer

boolean

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

variants.active_permit.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variants.active_permit.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variants.active_permit.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variants.active_permit.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variants.active_permit.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variants.active_permit.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variants.active_permit.retailer.website

string | null

Website URL

Maximum length: 100

variants.active_permit.retailer_cost

string | null

Retailer cost of variant

variants.active_permit.retailer_price

string | null

Retailer price of the variant

variants.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

variants.active_permit.start_at

string | null

Time of permit start (UTC format)

variants.attributes

object[]

Show child attributes

variants.attributes.code

string

required

Attribute code

Required string length: 1 - 200

variants.attributes.name

string

required

Attribute name

Required string length: 1 - 200

variants.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

variants.attributes.description

string | null

Attribute description

variants.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

variants.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

variants.attributes.id

integer

Attribute ID

variants.attributes.units

string | null

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

Maximum length: 32

variants.attributes.values

object

Show child attributes

variants.attributes.values.created_at

string

Time of creation

variants.attributes.values.id

integer

Attribute value ID

variants.attributes.values.retailer

object

Show child attributes

variants.attributes.values.retailer.code

string

required

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

Required string length: 1 - 32

variants.attributes.values.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variants.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

variants.attributes.values.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variants.attributes.values.retailer.id

integer

Retailer ID

variants.attributes.values.retailer.is_onboarded

boolean

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

variants.attributes.values.retailer.is_rcn_retailer

boolean

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

variants.attributes.values.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variants.attributes.values.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variants.attributes.values.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variants.attributes.values.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variants.attributes.values.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variants.attributes.values.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variants.attributes.values.retailer.website

string | null

Website URL

Maximum length: 100

variants.attributes.values.unit

object

Show child attributes

variants.attributes.values.unit.id

integer

Unit ID

variants.attributes.values.unit.name

string

Unit name

Minimum length: 1

variants.attributes.values.unit.standard_unit

string

Standard unit

Minimum length: 1

variants.attributes.values.unit.symbol

string | null

Unit symbol

Maximum length: 5

variants.attributes.values.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

variants.attributes.values.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

variants.attributes.values.updated_at

string

Time of update

variants.attributes.values.value

string

Attribute value

variants.brand

object

Show child attributes

variants.brand.code

string

required

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

Required string length: 1 - 64

variants.brand.cover_url

string

URL of the cover image

Minimum length: 1

variants.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

variants.brand.id

integer

Vendor (brand) ID

variants.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

variants.brand.is_on_rcn

boolean

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

variants.brand.is_onboarded

boolean

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

variants.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

variants.brand.logo_url

string

URL of the brand logo

Minimum length: 1

variants.brand.name

string

Vendor name

Required string length: 1 - 64

variants.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

variants.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

variants.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

variants.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

variants.brand.subscription_is_delinquent

boolean

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

variants.brand.subscription_is_expired

boolean

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

variants.brand.subscription_is_on_grace_period

boolean

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

variants.brand.website

string | null

URL of brand website

Maximum length: 100

variants.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

variants.cartons

object[]

Show child attributes

variants.cartons.height

string | null

Carton height

variants.cartons.height_unit

string

Unit of height

variants.cartons.id

integer

Carton ID

variants.cartons.length

string | null

Carton length

variants.cartons.length_unit

string

Unit of length

variants.cartons.number

integer

Carton number

Required range: -2147483648 < x < 2147483647

variants.cartons.package_girth_inches

string

Girth of the package, in inches

variants.cartons.package_size_inches

string

Size of the package, in inches

variants.cartons.weight

string | null

Carton weight

variants.cartons.weight_unit

string

Unit of weight

variants.cartons.width

string | null

Carton width

variants.cartons.width_unit

string

Unit of width

variants.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

variants.id

integer

Variant ID

variants.identifier

string | null

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

Maximum length: 128

variants.inventory

object

Show child attributes

variants.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

variants.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

variants.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

variants.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

variants.inventory.sellable_updated_at

string

required

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

variants.inventory.discontinued

boolean

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

variants.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

variants.inventory.inventory

integer

Inventory of variant

variants.inventory.locations

object[]

Show child attributes

variants.inventory.locations.address

object

Show child attributes

variants.inventory.locations.address.city

string

required

City name

Required string length: 1 - 64

variants.inventory.locations.address.country

string

required

Country name

Required string length: 1 - 128

variants.inventory.locations.address.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

variants.inventory.locations.address.postal_code

string

required

Postal code

Required string length: 1 - 32

variants.inventory.locations.address.province

string

required

State name

Required string length: 1 - 32

variants.inventory.locations.address.street1

string

required

Line 1 of the address

Required string length: 1 - 128

variants.inventory.locations.address.email

string | null

Contact email address

Maximum length: 128

variants.inventory.locations.address.fax

string | null

Fax number

Maximum length: 32

variants.inventory.locations.address.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

variants.inventory.locations.address.id

integer

Address ID

variants.inventory.locations.address.name2

string | null

Name of the alternative contact?

Maximum length: 64

variants.inventory.locations.address.phone1

string | null

Primary contact number

Maximum length: 32

variants.inventory.locations.address.phone2

string | null

Alternate contact number

Maximum length: 32

variants.inventory.locations.address.street2

string | null

Line 2 of the address

Maximum length: 128

variants.inventory.locations.address.type

enum<string> | null

Type of address

Available options:

residential,

commercial

variants.inventory.locations.id

integer

Location ID

variants.inventory.locations.inventory

integer

Count of sellable variants

variants.inventory.locations.nickname

string

Nickname of location

variants.inventory.replenishable

boolean

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

variants.inventory.sellable

string

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

variants.is_compatible

boolean

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

variants.media

object[]

Show child attributes

variants.media.created_at

string

Time of variant image creation (UTC format)

variants.media.height

integer | null

Height of variant image

Required range: -2147483648 < x < 2147483647

variants.media.id

integer

Variant ID

variants.media.media

string

Variant images

variants.media.priority

integer

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

Required range: -2147483648 < x < 2147483647

variants.media.updated_at

string

Time of variant image update (UTC format)

variants.media.url

string

URL of variant image

variants.media.width

integer | null

Width of variant image

Required range: -2147483648 < x < 2147483647

variants.name

string | null

Variant Name

Maximum length: 200

variants.permits

object[]

Show child attributes

variants.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

variants.permits.attributes

object

variants.permits.end_at

string | null

Time of permit end (UTC format)

variants.permits.id

integer

Permit ID

variants.permits.is_acknowledged

boolean

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

variants.permits.is_in_effect

boolean

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

variants.permits.pricing

object

variants.permits.retailer

object

Show child attributes

variants.permits.retailer.code

string

required

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

Required string length: 1 - 32

variants.permits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variants.permits.retailer.brand_permit_creation_allowed

boolean

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

variants.permits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variants.permits.retailer.id

integer

Retailer ID

variants.permits.retailer.is_onboarded

boolean

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

variants.permits.retailer.is_rcn_retailer

boolean

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

variants.permits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variants.permits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variants.permits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variants.permits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variants.permits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variants.permits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variants.permits.retailer.website

string | null

Website URL

Maximum length: 100

variants.permits.retailer_cost

string | null

Retailer cost of variant

variants.permits.retailer_price

string | null

Retailer price of the variant

variants.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

variants.permits.start_at

string | null

Time of permit start (UTC format)

variants.proposal_variant

object

Show child attributes

variants.proposal_variant.approve

boolean

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

variants.proposal_variant.approved_at

string | null

Time of approval (UTC format)

variants.proposal_variant.attributes

object[]

Show child attributes

variants.proposal_variant.attributes.created_at

string

Time of creation

variants.proposal_variant.attributes.id

integer

Attribute value ID

variants.proposal_variant.attributes.retailer

object

Show child attributes

variants.proposal_variant.attributes.retailer.code

string

required

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

Required string length: 1 - 32

variants.proposal_variant.attributes.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variants.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

variants.proposal_variant.attributes.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variants.proposal_variant.attributes.retailer.id

integer

Retailer ID

variants.proposal_variant.attributes.retailer.is_onboarded

boolean

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

variants.proposal_variant.attributes.retailer.is_rcn_retailer

boolean

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

variants.proposal_variant.attributes.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variants.proposal_variant.attributes.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variants.proposal_variant.attributes.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variants.proposal_variant.attributes.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variants.proposal_variant.attributes.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variants.proposal_variant.attributes.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variants.proposal_variant.attributes.retailer.website

string | null

Website URL

Maximum length: 100

variants.proposal_variant.attributes.unit

object

Show child attributes

variants.proposal_variant.attributes.unit.id

integer

Unit ID

variants.proposal_variant.attributes.unit.name

string

Unit name

Minimum length: 1

variants.proposal_variant.attributes.unit.standard_unit

string

Standard unit

Minimum length: 1

variants.proposal_variant.attributes.unit.symbol

string | null

Unit symbol

Maximum length: 5

variants.proposal_variant.attributes.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

variants.proposal_variant.attributes.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

variants.proposal_variant.attributes.updated_at

string

Time of update

variants.proposal_variant.attributes.value

string

Attribute value

variants.proposal_variant.created_at

string

Time of creation (UTC format)

variants.proposal_variant.delete

boolean

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

variants.proposal_variant.id

integer

Proposal variant ID

variants.proposal_variant.issues

object[]

Show child attributes

variants.proposal_variant.issues.created_at

string

Time of issue creation

variants.proposal_variant.issues.id

integer

Issue ID

variants.proposal_variant.issues.is_resolved

string

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

variants.proposal_variant.issues.issue_id

integer

Issue ID

variants.proposal_variant.issues.memos

object[]

Show child attributes

variants.proposal_variant.issues.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

variants.proposal_variant.issues.memos.created_at

string

Time of memo creation (UTC format)

variants.proposal_variant.issues.memos.created_by

object

Show child attributes

variants.proposal_variant.issues.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

variants.proposal_variant.issues.memos.id

integer

Memo ID

variants.proposal_variant.issues.memos.notify_people

boolean

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

variants.proposal_variant.issues.memos.text

string

Memo text

variants.proposal_variant.issues.memos.updated_at

string

Time of memo update (UTC format)

variants.proposal_variant.issues.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

variants.proposal_variant.issues.message

string

Description or note related to issue

Minimum length: 1

variants.proposal_variant.issues.resolved_at

string

Time of issue resolution

variants.proposal_variant.issues.title

string

Issue title

Minimum length: 1

variants.proposal_variant.issues.updated_at

string

Time of issue update

variants.proposal_variant.memos

object[]

Show child attributes

variants.proposal_variant.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

variants.proposal_variant.memos.created_at

string

Time of memo creation (UTC format)

variants.proposal_variant.memos.created_by

object

Show child attributes

variants.proposal_variant.memos.created_by.first_name

string | null

First name of user

Maximum length: 64

variants.proposal_variant.memos.created_by.id

integer

User ID who accepted or rejected the invoice

variants.proposal_variant.memos.created_by.is_me

boolean

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

variants.proposal_variant.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

variants.proposal_variant.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

variants.proposal_variant.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

variants.proposal_variant.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

variants.proposal_variant.memos.created_by.title

string | null

User title

Maximum length: 64

variants.proposal_variant.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

variants.proposal_variant.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

variants.proposal_variant.memos.id

integer

Memo ID

variants.proposal_variant.memos.notify_people

boolean

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

variants.proposal_variant.memos.text

string

Memo text

variants.proposal_variant.memos.updated_at

string

Time of memo update (UTC format)

variants.proposal_variant.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

variants.proposal_variant.pricing

string

Pricing of variant

variants.proposal_variant.reject

boolean

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

variants.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

variants.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

variants.proposal_variant.updated_at

string

Time of last update (UTC format)

variants.proposal_variant.variant_id

integer

Variant ID

variants.retailer_categories

object

Show child attributes

variants.retailer_categories.category

string

required

Category name

Required string length: 1 - 256

variants.retailer_categories.id

integer

Retailer category ID

variants.retailer_categories.retailer

object

Show child attributes

variants.retailer_categories.retailer.code

string

required

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

Required string length: 1 - 32

variants.retailer_categories.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variants.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

variants.retailer_categories.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variants.retailer_categories.retailer.id

integer

Retailer ID

variants.retailer_categories.retailer.is_onboarded

boolean

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

variants.retailer_categories.retailer.is_rcn_retailer

boolean

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

variants.retailer_categories.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variants.retailer_categories.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variants.retailer_categories.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variants.retailer_categories.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variants.retailer_categories.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variants.retailer_categories.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variants.retailer_categories.retailer.website

string | null

Website URL

Maximum length: 100

variants.retailer_identifiers

object

Show child attributes

variants.retailer_identifiers.id

integer

Retailer ID

variants.retailer_identifiers.identifier

string | null

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

Maximum length: 256

variants.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

variants.retailer_identifiers.retailer

object

Show child attributes

variants.retailer_identifiers.retailer.code

string

required

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

Required string length: 1 - 32

variants.retailer_identifiers.retailer.name

string

required

Retailer name

Required string length: 1 - 64

variants.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

variants.retailer_identifiers.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

variants.retailer_identifiers.retailer.id

integer

Retailer ID

variants.retailer_identifiers.retailer.is_onboarded

boolean

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

variants.retailer_identifiers.retailer.is_rcn_retailer

boolean

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

variants.retailer_identifiers.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

variants.retailer_identifiers.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

variants.retailer_identifiers.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

variants.retailer_identifiers.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

variants.retailer_identifiers.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

variants.retailer_identifiers.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

variants.retailer_identifiers.retailer.website

string | null

Website URL

Maximum length: 100

variants.ruleset_variant_summary

string

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

variants.ruleset_variants

object[]

Show child attributes

variants.ruleset_variants.created_at

string

Time of creation (UTC format)

variants.ruleset_variants.id

integer

ID of ruleset variant

variants.ruleset_variants.results

string

Response

variants.ruleset_variants.ruleset

object

Show child attributes

variants.ruleset_variants.ruleset.created_at

string

Time of creation (UTC format)

variants.ruleset_variants.ruleset.id

integer

ID of ruleset variant

variants.ruleset_variants.ruleset.results

string

Response

variants.ruleset_variants.ruleset.ruleset

object

Show child attributes

variants.ruleset_variants.ruleset.ruleset.created_at

string

Time of creation (UTC format)

variants.ruleset_variants.ruleset.ruleset.id

integer

ID of ruleset variant

variants.ruleset_variants.ruleset.ruleset.results

string

Response

variants.ruleset_variants.ruleset.ruleset.ruleset

object

Show child attributes

variants.ruleset_variants.ruleset.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

variants.ruleset_variants.ruleset.ruleset.updated_at

string

Time of last update (UTC format)

variants.ruleset_variants.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

variants.ruleset_variants.ruleset.updated_at

string

Time of last update (UTC format)

variants.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

variants.ruleset_variants.updated_at

string

Time of last update (UTC format)

variants.size

string | null

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

Maximum length: 128

variants.style

string | null

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

Maximum length: 128

variants.upc

string

UPC or other GTIN

Maximum length: 64