Get single product details

Authorizations

Authorization

string

header

required

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

Path Parameters

integer

required

Product ID

retailer_pk

number

required

Retailer ID

Response

200 - application/json

integer

product ID

Example:

2863

parent_identifier

string

ID of parent product

Minimum string length: 1

Example:

"1000-BL"

parent_name

string

Parent name

Minimum string length: 1

Example:

"T-Shirt, Blue"

description

string | null

Product description

Example:

null

brand

object

Show child attributes

brand.code

string<slug>

required

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

Required string length: 1 - 64

Example:

"marla-store"

brand.id

integer

Vendor ID

Example:

456

brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Store"

brand_category

string | null

Brand category

Required string length: 1 - 64

Example:

null

brand_name

string | null

Brand name

Required string length: 1 - 64

Example:

null

manufacturer

object

Show child attributes

manufacturer.code

string<slug>

required

Manufacturer code

Required string length: 1 - 32

Example:

"manu_sample_uio"

manufacturer.id

integer

Manufacturer ID

Example:

6775

manufacturer.name

string

Manufacturer name

Required string length: 1 - 64

Example:

"Manu Sample UIO"

manufacturer.logo_url

string<uri>

URL of manufacturer's logo

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

manufacturer.cover_url

string<uri>

URL of manufacturer's cover image

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

manufacturer.profile_tile_url

string<uri>

URL of manufacturer's profile image

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

manufacturer.uuid

string

A universally unique identifier (UUID)

Maximum string length: 36

manufacturer.website

string<uri> | null

URL of manufacturer website

Maximum string length: 100

Example:

"https://assets.demo.com"

num_variants

integer

Number of variants

Example:

1

variants

object

Show child attributes

variants.id

integer

Variant ID

Example:

100024

variants.name

string | null

Variant Name

Maximum string length: 200

Example:

"T-Shirt, Blue, L"

variants.brand

object

Show child attributes

variants.brand.code

string<slug>

required

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

Required string length: 1 - 64

Example:

"demo-brand"

variants.brand.id

integer

Vendor (brand) ID

Example:

500

variants.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

variants.brand.joined_at

string<date-time>

Time when vendor joined Dropship (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.brand.logo_url

string<uri>

URL of the brand logo

Minimum string length: 1

Example:

"https://images.revcascade.com/retailers/defaults/logo-lg.png"

variants.brand.cover_url

string<uri>

URL of the cover image

Minimum string length: 1

Example:

"https://images.revcascade.com/retailers/defaults/cover.png"

variants.brand.profile_tile_url

string<uri>

URL of the profile image

Minimum string length: 1

Example:

"https://images.revcascade.com/retailers/defaults/profile-tile.png"

variants.brand.website

string<uri> | null

URL of brand website

Maximum string length: 100

Example:

null

variants.brand.is_onboarded

boolean

true: Vendor is onboarded
false: Vendor is not onboarded

Example:

false

variants.brand.is_on_rcn

boolean

true: is on Dropship network
false: not on Dropship network

Example:

false

variants.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

variants.brand.subscription_expires_at

string<date-time> | null

Subscription expiry Time (UTC format)

Example:

"2024-09-19T13:32:10Z"

variants.brand.grace_period_ends_at

string<date-time> | null

Time of grace period expiration (UTC format)

Example:

"2024-10-26T13:32:10Z"

variants.brand.subscription_is_expired

boolean

true: subscription is expired
false: subscription is active

Example:

false

variants.brand.subscription_is_on_grace_period

boolean

true: subscription is on grace period
false: subscription is not on grace period

Example:

false

variants.brand.subscription_is_delinquent

boolean

true: subscription is overdue
false: subscription is paid

Example:

false

variants.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

variants.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

variants.brand_identifier

string

Unique SKU assigned by the Brand

Minimum string length: 1

Example:

"1000-BL-L"

variants.identifier

string | null

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

Maximum string length: 128

Example:

"5000001"

variants.upc

string

UPC or other GTIN

Maximum string length: 64

Example:

9119119111

variants.cartons

object[]

Show child attributes

variants.cartons.id

integer

Carton ID

Example:

48

variants.cartons.number

integer

Carton number

Required range: -2147483648 <= x <= 2147483647

Example:

1

variants.cartons.length

string<decimal> | null

Carton length

Example:

"1"

variants.cartons.length_unit

string

Unit of length

Example:

"1"

variants.cartons.width

string<decimal> | null

Carton width

Example:

"1"

variants.cartons.width_unit

string

Unit of width

Example:

"meter"

variants.cartons.height

string<decimal> | null

Carton height

Example:

"1"

variants.cartons.height_unit

string

Unit of height

Example:

"meter"

variants.cartons.weight

string<decimal> | null

Carton weight

Example:

"15"

variants.cartons.weight_unit

string

Unit of weight

Example:

"KG"

variants.cartons.package_girth_inches

string

Girth of the package, in inches

Example:

"1"

variants.cartons.package_size_inches

string

Size of the package, in inches

Example:

"1"

variants.color

string | null

Color of the item (from attributes.color)

Maximum string length: 128

Example:

"Red"

variants.style

string | null

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

Maximum string length: 128

Example:

"Print"

variants.size

string | null

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

Maximum string length: 128

Example:

"Large"

variants.media

object[]

Show child attributes

variants.media.id

integer

Variant ID

Example:

249

variants.media.width

integer | null

Width of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

variants.media.height

integer | null

Height of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

variants.media.media

string

Variant images

Example:

"default"

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

Example:

1

variants.media.url

string

URL of variant image

Example:

"192.168.99.100/media/default/original"

variants.media.updated_at

string<date-time>

Time of variant image update (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.media.created_at

string<date-time>

Time of variant image creation (UTC format)

Example:

"2022-08-10T15:24:56Z"

variants.attributes

object[]

Show child attributes

variants.attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"size"

variants.attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Size"

variants.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"money"

variants.attributes.id

integer

Attribute ID

Example:

44

variants.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

Example:

"brand"

variants.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"general"

variants.attributes.description

string | null

Attribute description

Example:

"demo product description"

variants.attributes.units

string | null

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

Maximum string length: 32

Example:

"USD"

variants.attributes.values

object

Show child attributes

variants.attributes.values.id

integer

Attribute value ID

variants.attributes.values.value

string

Attribute value

variants.attributes.values.unit

object

Show child attributes

variants.attributes.values.unit.id

integer

Unit ID

Example:

677

variants.attributes.values.unit.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

variants.attributes.values.unit.standard_unit

string

Standard unit

Minimum string length: 1

variants.attributes.values.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

variants.attributes.values.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

variants.attributes.values.unit.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

variants.attributes.values.retailer

object

Show child attributes

variants.attributes.values.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variants.attributes.values.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variants.attributes.values.retailer.id

integer

Retailer ID

Example:

500

variants.attributes.values.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png"

variants.attributes.values.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg"

variants.attributes.values.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg"

variants.attributes.values.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

"2021-08-03T17:24:12Z"

variants.attributes.values.retailer.is_rcn_retailer

boolean

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

Example:

false

variants.attributes.values.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

variants.attributes.values.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variants.attributes.values.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

variants.attributes.values.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit
false: Platform doesn't require creation of brand permit

Example:

false

variants.attributes.values.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

variants.attributes.values.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variants.attributes.values.updated_at

string<date-time>

Time of update

variants.attributes.values.created_at

string<date-time>

Time of creation

variants.ruleset_variants

object[]

Show child attributes

variants.ruleset_variants.id

integer

ID of ruleset variant

Example:

1232

variants.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

Example:

"processing"

variants.ruleset_variants.ruleset

any

variants.ruleset_variants.results

string

Response

variants.ruleset_variants.created_at

string<date-time>

Time of creation (UTC format)

Example:

"2022-08-10T15:24:56Z"

variants.ruleset_variants.updated_at

string<date-time>

Time of last update (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.ruleset_variant_summary

string

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

Example:

"21"

variants.active_permit

object

Show child attributes

variants.active_permit.id

integer

Permit ID

Example:

10104

variants.active_permit.retailer

object

Show child attributes

variants.active_permit.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variants.active_permit.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variants.active_permit.retailer.id

integer

Retailer ID

Example:

500

variants.active_permit.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png"

variants.active_permit.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg"

variants.active_permit.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg"

variants.active_permit.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

"2021-08-03T17:24:12Z"

variants.active_permit.retailer.is_rcn_retailer

boolean

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

Example:

false

variants.active_permit.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

variants.active_permit.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variants.active_permit.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

variants.active_permit.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit
false: Platform doesn't require creation of brand permit

Example:

false

variants.active_permit.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

variants.active_permit.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variants.active_permit.retailer_price

string<decimal> | null

Retailer price of the variant

Example:

"12.99"

variants.active_permit.retailer_cost

string<decimal> | null

Retailer cost of variant

Example:

"8.99"

variants.active_permit.pricing

object

variants.active_permit.attributes

object

variants.active_permit.start_at

string<date-time> | null

Time of permit start (UTC format)

Example:

"2021-09-10T15:24:56Z"

variants.active_permit.end_at

string<date-time> | null

Time of permit end (UTC format)

Example:

"2024-09-10T15:24:56Z"

variants.active_permit.is_in_effect

boolean

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

Example:

true

variants.active_permit.revoked_at

string<date-time> | null

Time when permit got revoked (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.active_permit.is_acknowledged

boolean

true: permit is acknowledged
false: permit is not acknowledged

Example:

true

variants.active_permit.acknowledged_at

string<date-time> | null

Time of acknowledgement (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.permits

object[]

Show child attributes

variants.permits.id

integer

Permit ID

Example:

10104

variants.permits.retailer

object

Show child attributes

variants.permits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variants.permits.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variants.permits.retailer.id

integer

Retailer ID

Example:

500

variants.permits.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png"

variants.permits.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg"

variants.permits.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg"

variants.permits.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

"2021-08-03T17:24:12Z"

variants.permits.retailer.is_rcn_retailer

boolean

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

Example:

false

variants.permits.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

variants.permits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variants.permits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

variants.permits.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit
false: Platform doesn't require creation of brand permit

Example:

false

variants.permits.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

variants.permits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variants.permits.retailer_price

string<decimal> | null

Retailer price of the variant

Example:

"12.99"

variants.permits.retailer_cost

string<decimal> | null

Retailer cost of variant

Example:

"8.99"

variants.permits.pricing

object

variants.permits.attributes

object

variants.permits.start_at

string<date-time> | null

Time of permit start (UTC format)

Example:

"2021-09-10T15:24:56Z"

variants.permits.end_at

string<date-time> | null

Time of permit end (UTC format)

Example:

"2024-09-10T15:24:56Z"

variants.permits.is_in_effect

boolean

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

Example:

true

variants.permits.revoked_at

string<date-time> | null

Time when permit got revoked (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.permits.is_acknowledged

boolean

true: permit is acknowledged
false: permit is not acknowledged

Example:

true

variants.permits.acknowledged_at

string<date-time> | null

Time of acknowledgement (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.is_compatible

boolean

true: variant meets requirement
false: variant doesn not meet requirement

Example:

true

variants.proposal_variant

object

Show child attributes

variants.proposal_variant.id

integer

Proposal variant ID

Example:

3456

variants.proposal_variant.pricing

string

Pricing of variant

Example:

"12.00"

variants.proposal_variant.attributes

object[]

Show child attributes

variants.proposal_variant.attributes.id

integer

Attribute value ID

variants.proposal_variant.attributes.value

string

Attribute value

variants.proposal_variant.attributes.unit

object

Show child attributes

variants.proposal_variant.attributes.unit.id

integer

Unit ID

Example:

677

variants.proposal_variant.attributes.unit.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

variants.proposal_variant.attributes.unit.standard_unit

string

Standard unit

Minimum string length: 1

variants.proposal_variant.attributes.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

variants.proposal_variant.attributes.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

variants.proposal_variant.attributes.unit.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

variants.proposal_variant.attributes.retailer

object

Show child attributes

variants.proposal_variant.attributes.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variants.proposal_variant.attributes.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variants.proposal_variant.attributes.retailer.id

integer

Retailer ID

Example:

500

variants.proposal_variant.attributes.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png"

variants.proposal_variant.attributes.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg"

variants.proposal_variant.attributes.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg"

variants.proposal_variant.attributes.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

"2021-08-03T17:24:12Z"

variants.proposal_variant.attributes.retailer.is_rcn_retailer

boolean

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

Example:

false

variants.proposal_variant.attributes.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

variants.proposal_variant.attributes.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variants.proposal_variant.attributes.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

variants.proposal_variant.attributes.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit
false: Platform doesn't require creation of brand permit

Example:

false

variants.proposal_variant.attributes.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

variants.proposal_variant.attributes.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variants.proposal_variant.attributes.updated_at

string<date-time>

Time of update

variants.proposal_variant.attributes.created_at

string<date-time>

Time of creation

variants.proposal_variant.memos

object[]

Show child attributes

variants.proposal_variant.memos.id

integer

Memo ID

Example:

1234

variants.proposal_variant.memos.text

string

Memo text

Example:

"Immediate requirement"

variants.proposal_variant.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

variants.proposal_variant.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

Example:

"2022-01-10T15:24:56Z"

variants.proposal_variant.memos.notify_people

boolean

true: notify stakeholders
false: do not notify

Example:

true

variants.proposal_variant.memos.created_by

object

Show child attributes

variants.proposal_variant.memos.created_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

variants.proposal_variant.memos.created_by.first_name

string | null

First name of user

Maximum string length: 64

Example:

"Sample"

variants.proposal_variant.memos.created_by.last_name

string | null

Last name of user

Maximum string length: 64

Example:

"Demo"

variants.proposal_variant.memos.created_by.title

string | null

User title

Maximum string length: 64

Example:

"Demo"

variants.proposal_variant.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

variants.proposal_variant.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

variants.proposal_variant.memos.created_by.photo_url

string<uri>

URL of the user photo

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

variants.proposal_variant.memos.created_by.profile_photo

string<uri>

URL of the user's profile photo

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

variants.proposal_variant.memos.created_by.is_me

boolean

true: user is me:
false: user is not me

Example:

true

variants.proposal_variant.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

Example:

"retailer"

variants.proposal_variant.memos.created_at

string<date-time>

Time of memo creation (UTC format)

Example:

"2021-09-10T15:24:56Z"

variants.proposal_variant.memos.updated_at

string<date-time>

Time of memo update (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.proposal_variant.issues

object[]

Show child attributes

variants.proposal_variant.issues.id

integer

Issue ID

variants.proposal_variant.issues.memos

object[]

Show child attributes

variants.proposal_variant.issues.memos.id

integer

Memo ID

Example:

1234

variants.proposal_variant.issues.memos.text

string

Memo text

Example:

"Immediate requirement"

variants.proposal_variant.issues.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

variants.proposal_variant.issues.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

Example:

"2022-01-10T15:24:56Z"

variants.proposal_variant.issues.memos.notify_people

boolean

true: notify stakeholders
false: do not notify

Example:

true

variants.proposal_variant.issues.memos.created_by

object

Show child attributes

variants.proposal_variant.issues.memos.created_by.id

integer

User ID who accepted or rejected the invoice

Example:

542

variants.proposal_variant.issues.memos.created_by.first_name

string | null

First name of user

Maximum string length: 64

Example:

"Sample"

variants.proposal_variant.issues.memos.created_by.last_name

string | null

Last name of user

Maximum string length: 64

Example:

"Demo"

variants.proposal_variant.issues.memos.created_by.title

string | null

User title

Maximum string length: 64

Example:

"Demo"

variants.proposal_variant.issues.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

variants.proposal_variant.issues.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

Example:

"standard"

variants.proposal_variant.issues.memos.created_by.photo_url

string<uri>

URL of the user photo

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

variants.proposal_variant.issues.memos.created_by.profile_photo

string<uri>

URL of the user's profile photo

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

variants.proposal_variant.issues.memos.created_by.is_me

boolean

true: user is me:
false: user is not me

Example:

true

variants.proposal_variant.issues.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

Example:

"retailer"

variants.proposal_variant.issues.memos.created_at

string<date-time>

Time of memo creation (UTC format)

Example:

"2021-09-10T15:24:56Z"

variants.proposal_variant.issues.memos.updated_at

string<date-time>

Time of memo update (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.proposal_variant.issues.created_at

string<date-time>

Time of issue creation

variants.proposal_variant.issues.updated_at

string<date-time>

Time of issue update

variants.proposal_variant.issues.resolved_at

string<date-time>

Time of issue resolution

variants.proposal_variant.issues.is_resolved

string

true: Issue is resolved
false: Issue is not resolved

variants.proposal_variant.issues.issue_id

integer

Issue ID

variants.proposal_variant.issues.message

string

Description or note related to issue

Minimum string length: 1

variants.proposal_variant.issues.title

string

Issue title

Minimum string length: 1

variants.proposal_variant.variant_id

integer

Variant ID

Example:

249

variants.proposal_variant.approved_at

string<date-time> | null

Time of approval (UTC format)

Example:

"2022-10-10T15:24:56Z"

variants.proposal_variant.created_at

string<date-time>

Time of creation (UTC format)

Example:

"2022-07-10T15:24:56Z"

variants.proposal_variant.updated_at

string<date-time>

Time of last update (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.proposal_variant.rejected_at

string<date-time> | null

Time of proposal rejection (UTC format)

Example:

null

variants.proposal_variant.reject_reason

string | null

Rejection reason

Maximum string length: 32

Example:

"Incomplete"

variants.proposal_variant.reject

boolean

true: proposal is rejected
false: proposal is not rejected

Example:

true

variants.proposal_variant.approve

boolean

true: proposal is approved
false: proposal is not approved

Example:

false

variants.proposal_variant.delete

boolean

true: proposal is deleted
false: proposal is not deleted

Example:

false

variants.retailer_identifiers

object

Show child attributes

variants.retailer_identifiers.id

integer

Retailer ID

Example:

5642

variants.retailer_identifiers.retailer

object

Show child attributes

variants.retailer_identifiers.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variants.retailer_identifiers.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variants.retailer_identifiers.retailer.id

integer

Retailer ID

Example:

500

variants.retailer_identifiers.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png"

variants.retailer_identifiers.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg"

variants.retailer_identifiers.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg"

variants.retailer_identifiers.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

"2021-08-03T17:24:12Z"

variants.retailer_identifiers.retailer.is_rcn_retailer

boolean

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

Example:

false

variants.retailer_identifiers.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

variants.retailer_identifiers.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variants.retailer_identifiers.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

variants.retailer_identifiers.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit
false: Platform doesn't require creation of brand permit

Example:

false

variants.retailer_identifiers.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

variants.retailer_identifiers.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variants.retailer_identifiers.identifier

string | null

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

Maximum string length: 256

Example:

"SKU976"

variants.retailer_identifiers.name

string | null

Retailer name

Maximum string length: 256

Example:

"Retailer Sample"

variants.retailer_categories

object

Show child attributes

variants.retailer_categories.category

string

required

Category name

Required string length: 1 - 256

Example:

"CategoryANC"

variants.retailer_categories.id

integer

Retailer category ID

Example:

453

variants.retailer_categories.retailer

object

Show child attributes

variants.retailer_categories.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variants.retailer_categories.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variants.retailer_categories.retailer.id

integer

Retailer ID

Example:

500

variants.retailer_categories.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png"

variants.retailer_categories.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg"

variants.retailer_categories.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg"

variants.retailer_categories.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

"2021-08-03T17:24:12Z"

variants.retailer_categories.retailer.is_rcn_retailer

boolean

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

Example:

false

variants.retailer_categories.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

variants.retailer_categories.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variants.retailer_categories.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

variants.retailer_categories.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit
false: Platform doesn't require creation of brand permit

Example:

false

variants.retailer_categories.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

variants.retailer_categories.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variants.inventory

object

Show child attributes

variants.inventory.inventory_updated_at

string<date-time>

required

Time of inventory update (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.inventory.inventory_last_submitted_at

string<date-time>

required

Time of inventory submit (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.inventory.brand_inventory_updated_at

string<date-time>

required

Time of vendor inventory update (UTC format)

Example:

"2022-09-10T15:24:56Z"

variants.inventory.sellable_updated_at

string<date-time>

required

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

Example:

"2022-11-10T15:24:56Z"

variants.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum string length: 1

Example:

"2022-09-10T15:24:56Z"

variants.inventory.discontinued

boolean

true: Product is discontinued
false: Product is active

Example:

true

variants.inventory.discontinued_updated_at

string<date-time>

Time of when product inventory was discontinued (UTC format)

Example:

null

variants.inventory.inventory

integer

Inventory of variant

Example:

0

variants.inventory.sellable

string

yes: Variant is sellable
No: Variant is not sellable

Example:

"No"

variants.inventory.replenishable

boolean

true: product is replenishable
false: product is not replenishable

Example:

true

variants.inventory.locations

object[]

Show child attributes

variants.inventory.locations.id

integer

Location ID

Example:

1

variants.inventory.locations.address

object

Show child attributes

variants.inventory.locations.address.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

variants.inventory.locations.address.street1

string

required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

variants.inventory.locations.address.city

string

required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

variants.inventory.locations.address.province

string

required

State name

Required string length: 1 - 32

Example:

"CA"

variants.inventory.locations.address.postal_code

string

required

Postal code

Required string length: 1 - 32

Example:

"90254"

variants.inventory.locations.address.country

string

required

Country name

Required string length: 1 - 128

Example:

"US"

variants.inventory.locations.address.id

integer

Address ID

Example:

10

variants.inventory.locations.address.type

enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

variants.inventory.locations.address.name2

string | null

Name of the alternative contact?

Maximum string length: 64

Example:

null

variants.inventory.locations.address.street2

string | null

Line 2 of the address

Maximum string length: 128

Example:

null

variants.inventory.locations.address.phone1

string | null

Primary contact number

Maximum string length: 32

Example:

"3105551212"

variants.inventory.locations.address.phone2

string | null

Alternate contact number

Maximum string length: 32

Example:

"3105551213"

variants.inventory.locations.address.fax

string | null

Fax number

Maximum string length: 32

Example:

null

variants.inventory.locations.address.email

string | null

Contact email address

Maximum string length: 128

Example:

null

variants.inventory.locations.address.federal_tax_id

string | null

Federal tax ID

Maximum string length: 32

Example:

null

variants.inventory.locations.inventory

integer

Count of sellable variants

Example:

0

variants.inventory.locations.nickname

string

Nickname of location

Example:

"LA Warehouse"

media

object[]

Show child attributes

media.id

integer

Variant ID

Example:

249

media.width

integer | null

Width of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

media.height

integer | null

Height of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

media.media

string

Variant images

Example:

"default"

media.priority

integer

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

Required range: -2147483648 <= x <= 2147483647

Example:

1

media.url

string

URL of variant image

Example:

"192.168.99.100/media/default/original"

media.updated_at

string<date-time>

Time of variant image update (UTC format)

Example:

"2022-09-10T15:24:56Z"

media.created_at

string<date-time>

Time of variant image creation (UTC format)

Example:

"2022-08-10T15:24:56Z"

rcn_status

enum<string>

Status of product in Dropship network

Available options:

not_published,

pending,

failed,

expired,

published

Example:

"not_published"

primary_media

object

Show child attributes

primary_media.id

integer

Product image ID

Example:

567

primary_media.width

integer | null

Product image width

Required range: -2147483648 <= x <= 2147483647

Example:

1

primary_media.height

integer | null

Product image height

Required range: -2147483648 <= x <= 2147483647

Example:

1

primary_media.media

string

Product image media

primary_media.priority

integer

Image priority

Required range: -2147483648 <= x <= 2147483647

Example:

2

primary_media.url

string

Product image URL

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

primary_media.updated_at

string<date-time>

Time of when product image was last updated

Example:

"2022-09-10T15:24:56Z"

primary_media.created_at

string<date-time>

Time of product image creation

Example:

"2022-08-10T15:24:56Z"

pivot_attributes

object[]

Show child attributes

pivot_attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"sample_code"

pivot_attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Sample Code"

pivot_attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"boolean"

pivot_attributes.id

integer

Attribute ID

Example:

5463

pivot_attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"inventory"

pivot_attributes.priority

integer

Attribute priority

Required range: 0 <= x <= 4294967295

Example:

2

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

Example:

"Brand"

pivot_attributes.units

string | null

Unity based on type

Maximum string length: 32

pivot_attributes.default_unit

object[]

Show child attributes

pivot_attributes.default_unit.id

integer

Unit ID

Example:

677

pivot_attributes.default_unit.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

pivot_attributes.default_unit.standard_unit

string

Standard unit

Minimum string length: 1

pivot_attributes.default_unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

pivot_attributes.default_unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

pivot_attributes.default_unit.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

pivot_attributes.available_units

object[]

Show child attributes

pivot_attributes.available_units.id

integer

Unit ID

Example:

677

pivot_attributes.available_units.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

pivot_attributes.available_units.standard_unit

string

Standard unit

Minimum string length: 1

pivot_attributes.available_units.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

pivot_attributes.available_units.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

pivot_attributes.available_units.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

pivot_attributes.is_bulk_editable

boolean

true: allow bulk edit of attributes
false: bulk edit of attributes are not allowed

Example:

true

taxonomy

object[]

Show child attributes

taxonomy.code

string<slug>

required

Taxonomy code

Required string length: 1 - 32

Example:

"sample_taxonomy"

taxonomy.id

integer

Taxonomy ID

Example:

4564

taxonomy.name

string

Taxonomy name

Required string length: 1 - 64

Example:

"Sample Taxonomy"

taxonomy.thumbnail_url

string<uri>

URL for thumbnail image

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

taxonomy.number_of_children

string

Number of children

Example:

"2"

taxonomy.pivot_attributes

object[]

Show child attributes

taxonomy.pivot_attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"sample_code"

taxonomy.pivot_attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Sample Code"

taxonomy.pivot_attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"boolean"

taxonomy.pivot_attributes.id

integer

Attribute ID

Example:

5463

taxonomy.pivot_attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"inventory"

taxonomy.pivot_attributes.priority

integer

Attribute priority

Required range: 0 <= x <= 4294967295

Example:

2

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

Example:

"Brand"

taxonomy.pivot_attributes.units

string | null

Unity based on type

Maximum string length: 32

taxonomy.pivot_attributes.default_unit

object[]

Show child attributes

taxonomy.pivot_attributes.default_unit.id

integer

Unit ID

Example:

677

taxonomy.pivot_attributes.default_unit.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

taxonomy.pivot_attributes.default_unit.standard_unit

string

Standard unit

Minimum string length: 1

taxonomy.pivot_attributes.default_unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

taxonomy.pivot_attributes.default_unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

taxonomy.pivot_attributes.default_unit.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

taxonomy.pivot_attributes.available_units

object[]

Show child attributes

taxonomy.pivot_attributes.available_units.id

integer

Unit ID

Example:

677

taxonomy.pivot_attributes.available_units.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

taxonomy.pivot_attributes.available_units.standard_unit

string

Standard unit

Minimum string length: 1

taxonomy.pivot_attributes.available_units.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

taxonomy.pivot_attributes.available_units.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

taxonomy.pivot_attributes.available_units.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

taxonomy.pivot_attributes.is_bulk_editable

boolean

true: allow bulk edit of attributes
false: bulk edit of attributes are not allowed

Example:

true

taxonomy.visible_attributes

object[]

Show child attributes

taxonomy.visible_attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"sample_code"

taxonomy.visible_attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Sample Code"

taxonomy.visible_attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"boolean"

taxonomy.visible_attributes.id

integer

Attribute ID

Example:

5463

taxonomy.visible_attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"inventory"

taxonomy.visible_attributes.priority

integer

Attribute priority

Required range: 0 <= x <= 4294967295

Example:

2

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

Example:

"Brand"

taxonomy.visible_attributes.units

string | null

Unity based on type

Maximum string length: 32

taxonomy.visible_attributes.default_unit

object[]

Show child attributes

taxonomy.visible_attributes.default_unit.id

integer

Unit ID

Example:

677

taxonomy.visible_attributes.default_unit.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

taxonomy.visible_attributes.default_unit.standard_unit

string

Standard unit

Minimum string length: 1

taxonomy.visible_attributes.default_unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

taxonomy.visible_attributes.default_unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

taxonomy.visible_attributes.default_unit.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

taxonomy.visible_attributes.available_units

object[]

Show child attributes

taxonomy.visible_attributes.available_units.id

integer

Unit ID

Example:

677

taxonomy.visible_attributes.available_units.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

taxonomy.visible_attributes.available_units.standard_unit

string

Standard unit

Minimum string length: 1

taxonomy.visible_attributes.available_units.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

taxonomy.visible_attributes.available_units.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

taxonomy.visible_attributes.available_units.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

taxonomy.visible_attributes.is_bulk_editable

boolean

true: allow bulk edit of attributes
false: bulk edit of attributes are not allowed

Example:

true

revcascade_taxonomy

object[]

Show child attributes

revcascade_taxonomy.code

string<slug>

required

Taxonomy code

Required string length: 1 - 32

Example:

"sample_taxonomy"

revcascade_taxonomy.id

integer

Taxonomy ID

Example:

4564

revcascade_taxonomy.name

string

Taxonomy name

Required string length: 1 - 64

Example:

"Sample Taxonomy"

revcascade_taxonomy.thumbnail_url

string<uri>

URL for thumbnail image

Minimum string length: 1

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

revcascade_taxonomy.number_of_children

string

Number of children

Example:

"2"

revcascade_taxonomy.pivot_attributes

object[]

Show child attributes

revcascade_taxonomy.pivot_attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"sample_code"

revcascade_taxonomy.pivot_attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Sample Code"

revcascade_taxonomy.pivot_attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"boolean"

revcascade_taxonomy.pivot_attributes.id

integer

Attribute ID

Example:

5463

revcascade_taxonomy.pivot_attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"inventory"

revcascade_taxonomy.pivot_attributes.priority

integer

Attribute priority

Required range: 0 <= x <= 4294967295

Example:

2

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

Example:

"Brand"

revcascade_taxonomy.pivot_attributes.units

string | null

Unity based on type

Maximum string length: 32

revcascade_taxonomy.pivot_attributes.default_unit

object[]

Show child attributes

revcascade_taxonomy.pivot_attributes.default_unit.id

integer

Unit ID

Example:

677

revcascade_taxonomy.pivot_attributes.default_unit.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

revcascade_taxonomy.pivot_attributes.default_unit.standard_unit

string

Standard unit

Minimum string length: 1

revcascade_taxonomy.pivot_attributes.default_unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

revcascade_taxonomy.pivot_attributes.default_unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

revcascade_taxonomy.pivot_attributes.default_unit.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

revcascade_taxonomy.pivot_attributes.available_units

object[]

Show child attributes

revcascade_taxonomy.pivot_attributes.available_units.id

integer

Unit ID

Example:

677

revcascade_taxonomy.pivot_attributes.available_units.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

revcascade_taxonomy.pivot_attributes.available_units.standard_unit

string

Standard unit

Minimum string length: 1

revcascade_taxonomy.pivot_attributes.available_units.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

revcascade_taxonomy.pivot_attributes.available_units.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

revcascade_taxonomy.pivot_attributes.available_units.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

revcascade_taxonomy.pivot_attributes.is_bulk_editable

boolean

true: allow bulk edit of attributes
false: bulk edit of attributes are not allowed

Example:

true

revcascade_taxonomy.visible_attributes

object[]

Show child attributes

revcascade_taxonomy.visible_attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"sample_code"

revcascade_taxonomy.visible_attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Sample Code"

revcascade_taxonomy.visible_attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"boolean"

revcascade_taxonomy.visible_attributes.id

integer

Attribute ID

Example:

5463

revcascade_taxonomy.visible_attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"inventory"

revcascade_taxonomy.visible_attributes.priority

integer

Attribute priority

Required range: 0 <= x <= 4294967295

Example:

2

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

Example:

"Brand"

revcascade_taxonomy.visible_attributes.units

string | null

Unity based on type

Maximum string length: 32

revcascade_taxonomy.visible_attributes.default_unit

object[]

Show child attributes

revcascade_taxonomy.visible_attributes.default_unit.id

integer

Unit ID

Example:

677

revcascade_taxonomy.visible_attributes.default_unit.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

revcascade_taxonomy.visible_attributes.default_unit.standard_unit

string

Standard unit

Minimum string length: 1

revcascade_taxonomy.visible_attributes.default_unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

revcascade_taxonomy.visible_attributes.default_unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

revcascade_taxonomy.visible_attributes.default_unit.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

revcascade_taxonomy.visible_attributes.available_units

object[]

Show child attributes

revcascade_taxonomy.visible_attributes.available_units.id

integer

Unit ID

Example:

677

revcascade_taxonomy.visible_attributes.available_units.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

revcascade_taxonomy.visible_attributes.available_units.standard_unit

string

Standard unit

Minimum string length: 1

revcascade_taxonomy.visible_attributes.available_units.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

revcascade_taxonomy.visible_attributes.available_units.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

revcascade_taxonomy.visible_attributes.available_units.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

revcascade_taxonomy.visible_attributes.is_bulk_editable

boolean

true: allow bulk edit of attributes
false: bulk edit of attributes are not allowed

Example:

true

attributes

object[]

Show child attributes

attributes.code

string

required

Attribute code

Required string length: 1 - 200

Example:

"size"

attributes.name

string

required

Attribute name

Required string length: 1 - 200

Example:

"Size"

attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"money"

attributes.id

integer

Attribute ID

Example:

44

attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

Example:

"brand"

attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"general"

attributes.description

string | null

Attribute description

Example:

"demo product description"

attributes.units

string | null

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

Maximum string length: 32

Example:

"USD"

attributes.values

object

Show child attributes

attributes.values.id

integer

Attribute value ID

attributes.values.value

string

Attribute value

attributes.values.unit

object

Show child attributes

attributes.values.unit.id

integer

Unit ID

Example:

677

attributes.values.unit.name

string

Unit name

Minimum string length: 1

Example:

"Sample unit"

attributes.values.unit.standard_unit

string

Standard unit

Minimum string length: 1

attributes.values.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

attributes.values.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

attributes.values.unit.symbol

string | null

Unit symbol

Maximum string length: 5

Example:

"USD"

attributes.values.retailer

object

Show child attributes

attributes.values.retailer.name

string

required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

attributes.values.retailer.code

string<slug>

required

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

Required string length: 1 - 32

Example:

"demo-retailer"

attributes.values.retailer.id

integer

Retailer ID

Example:

500

attributes.values.retailer.logo_url

string<uri>

URL of retailer logo

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png"

attributes.values.retailer.cover_url

string<uri>

URL of retailer cover image

Minimum string length: 1

Example:

"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg"

attributes.values.retailer.profile_tile_url

string<uri>

URL of retailer profile image

Minimum string length: 1

Example:

"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg"

attributes.values.retailer.joined_at

string<date-time>

Time of retailer joining Dropship (UTC format)

Example:

"2021-08-03T17:24:12Z"

attributes.values.retailer.is_rcn_retailer

boolean

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

Example:

false

attributes.values.retailer.is_onboarded

boolean

true: Retailer is onboarded
false: Retailer is not onboarded

Example:

false

attributes.values.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

attributes.values.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

attributes.values.retailer.brand_permit_creation_allowed

boolean

true: Platform allows creation of brand permit
false: Platform doesn't require creation of brand permit

Example:

false

attributes.values.retailer.website

string<uri> | null

Website URL

Maximum string length: 100

Example:

"https://demoabc.com"

attributes.values.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

attributes.values.updated_at

string<date-time>

Time of update

attributes.values.created_at

string<date-time>

Time of creation

last_published

object

Show child attributes

last_published.id

integer

Product ID

Example:

5677

last_published.platform_account

object

Show child attributes

last_published.platform_account.id

integer

Platform account ID

Example:

678

last_published.platform_account.platform

string

Platform name

Example:

"Sample Platform"

last_published.platform_account.retailer

string

Retailer name

Example:

"Retailer XU"

last_published.platform_account.brand

string

Brand name

Example:

"Brand XU"

last_published.platform_account.credentials

string

Credentials to use account

Example:

"sample1"

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

Example:

"SKU978"

last_published.product.id

integer

Product ID

Example:

5678

last_published.product.name

string | null

Product name

Maximum string length: 200

Example:

"Sample Product AYX"

last_published.product.brand

object

Show child attributes

last_published.product.brand.code

string<slug>

required

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

Required string length: 1 - 64

Example:

"marla-store"

last_published.product.brand.id

integer

Vendor ID

Example:

456

last_published.product.brand.name

string

Vendor name

Required string length: 1 - 64

Example:

"Marla Store"

last_published.product.brand_category

string | null

Brand category

Required string length: 1 - 64

Example:

"Category 78"

last_published.product.brand_name

string | null

Brand name

Required string length: 1 - 64

Example:

"Sample Brand"

last_published.product.parent_identifier

string

Parent identifier

Minimum string length: 1

Example:

"Main-1"

last_published.product.parent_name

string

Parent name

Minimum string length: 1

Example:

"Main Sample"

last_published.product.description

string | null

Product description

Example:

"Sample description of product"

last_published.product.rcn_status

enum<string>

Status of product in Dropship

Available options:

not_published,

pending,

failed,

expired,

published

Example:

"pending"

last_published.product.published_at

string<date-time> | null

Time of when product was first published

Example:

"2022-09-10T15:24:56Z"

last_published.product.expires_at

string<date-time> | null

Time of expiry (UTC format)

Example:

"2022-11-10T15:24:56Z"

last_published.product.primary_media

object

Show child attributes

last_published.product.primary_media.id

integer

Product image ID

Example:

567

last_published.product.primary_media.width

integer | null

Product image width

Required range: -2147483648 <= x <= 2147483647

Example:

1

last_published.product.primary_media.height

integer | null

Product image height

Required range: -2147483648 <= x <= 2147483647

Example:

1

last_published.product.primary_media.media

string

Product image media

last_published.product.primary_media.priority

integer

Image priority

Required range: -2147483648 <= x <= 2147483647

Example:

2

last_published.product.primary_media.url

string

Product image URL

Example:

"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf"

last_published.product.primary_media.updated_at

string<date-time>

Time of when product image was last updated

Example:

"2022-09-10T15:24:56Z"

last_published.product.primary_media.created_at

string<date-time>

Time of product image creation

Example:

"2022-08-10T15:24:56Z"

last_published.product.pricing

string

Product pricing

Example:

"12.00"

last_published.product.num_variants

integer

Number of product variants

Example:

2

last_published.product.created_at

string

Time of product creation in Dropship

Example:

"2022-07-10T15:24:56Z"

last_published.product.updated_at

string<date-time>

Time of when product was last updated in Dropship

Example:

"2022-08-10T15:24:56Z"

last_published.success

boolean

true: product published
false: product is not published

Example:

true

last_published.message

string | null

Message added while publishing, for future reference

Example:

"Sample message as a note"

last_published.created_at

string<date-time>

Time of creation

Example:

"2022-09-10T15:24:56Z"

created_at

string<date-time>

Time of product creation in Dropship

Example:

"2022-08-10T15:24:56Z"

updated_at

string<date-time>

Time of when product was last updated in Dropship

Example:

"2022-09-10T15:24:56Z"

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Get single product details

Authorizations

Path Parameters

Response