Get a product by ID

Retrieve a single product by ID.

Authorizations

Authorization · string · header · required

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

Path Parameters

retailer_id · integer · required

The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.

Example:

1001

id · integer · required

The unique product ID. This ID is automatically generated when a product is created or imported. To find your Product ID, click Products in the top nav > Products. On the Products page, search or filter for the product and select it. The Product Detail page is displayed. You will find the product number at the end of the HTTP URL.

Example:

7007

Response

200 - application/json

Ok

inventory_updated_at · string · required

Time of inventory update (UTC format)

Example:

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

inventory_last_submitted_at · string · required

Time of inventory submit (UTC format)

Example:

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

brand_inventory_updated_at · string · required

Time of vendor inventory update (UTC format)

Example:

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

sellable_updated_at · string · required

Time variant was marked sellable (UTC format)

Example:

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

estimated_availability_date · string · required

Estimated availability date of variant

Minimum length: 1

Example:

null

variant · object

Show child attributes

variant. id · integer

Variant ID

Example:

100024

variant. name · string | null

Variant Name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

variant. brand · object

Show child attributes

variant.brand. code · string · required

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

Required string length: 1 - 64

Example:

"demo-brand"

variant.brand. id · integer

Vendor (brand) ID

Example:

500

variant.brand. name · string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

variant.brand. joined_at · string

Time when vendor joined Dropship (UTC format)

Example:

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

variant.brand. logo_url · string

URL of the brand logo

Minimum length: 1

Example:

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

variant.brand. cover_url · string

URL of the cover image

Minimum length: 1

Example:

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

variant.brand. profile_tile_url · string

URL of the profile image

Minimum length: 1

Example:

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

variant.brand. website · string | null

URL of brand website

Maximum length: 100

Example:

null

variant.brand. is_onboarded · boolean

true: Vendor is onboarded | false: Vendor is not onboarded

Example:

false

variant.brand. is_on_rcn · boolean

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

Example:

false

variant.brand. requires_subscription · enum<string>

Indicates whether a subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

variant.brand. subscription_expires_at · string | null

Subscription expiry Time (UTC format)

Example:

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

variant.brand. grace_period_ends_at · string | null

Time of grace period expiration (UTC format)

Example:

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

variant.brand. subscription_is_expired · boolean

true: subscription is expired | false: subscription is active

Example:

false

variant.brand. subscription_is_on_grace_period · boolean

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

Example:

false

variant.brand. subscription_is_delinquent · boolean

true: subscription is overdue | false: subscription is paid

Example:

false

variant.brand. inventory_policy · enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

variant.brand. status · enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

variant. brand_identifier · string

Unique SKU assigned by the Brand

Minimum length: 1

Example:

"1000-BL-L"

variant. identifier · string | null

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

Maximum length: 128

Example:

"5000001"

variant. upc · string

UPC or other GTIN

Maximum length: 64

Example:

9119119111

variant. cartons · object[]

Show child attributes

variant.cartons. id · integer

Carton ID

Example:

48

variant.cartons. number · integer

Carton number

Required range: -2147483648 <= x <= 2147483647

Example:

1

variant.cartons. length · string | null

Carton length

Example:

"1"

variant.cartons. length_unit · string

Unit of length

Example:

"1"

variant.cartons. width · string | null

Carton width

Example:

"1"

variant.cartons. width_unit · string

Unit of width

Example:

"meter"

variant.cartons. height · string | null

Carton height

Example:

"1"

variant.cartons. height_unit · string

Unit of height

Example:

"meter"

variant.cartons. weight · string | null

Carton weight

Example:

"15"

variant.cartons. weight_unit · string

Unit of weight

Example:

"KG"

variant.cartons. package_girth_inches · string

Girth of the package, in inches

Example:

"1"

variant.cartons. package_size_inches · string

Size of the package, in inches

Example:

"1"

variant. color · string | null

Color of the item (from attributes.color)

Maximum length: 128

Example:

"Red"

variant. style · string | null

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

Maximum length: 128

Example:

"Print"

variant. size · string | null

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

Maximum length: 128

Example:

"Large"

variant. media · object[]

Show child attributes

variant.media. id · integer

Variant ID

Example:

249

variant.media. width · integer | null

Width of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

variant.media. height · integer | null

Height of variant image

Required range: -2147483648 <= x <= 2147483647

Example:

100

variant.media. media · string

Variant images

Example:

"default"

variant.media. priority · integer

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

Required range: -2147483648 <= x <= 2147483647

Example:

1

variant.media. url · string

URL of variant image

Example:

"192.168.99.100/media/default/original"

variant.media. updated_at · string

Time of variant image update (UTC format)

Example:

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

variant.media. created_at · string

Time of variant image creation (UTC format)

Example:

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

variant. attributes · object[]

Show child attributes

variant.attributes. code · string · required

Attribute code

Required string length: 1 - 200

Example:

"size"

variant.attributes. name · string · required

Attribute name

Required string length: 1 - 200

Example:

"Size"

variant.attributes. type · enum<string> · required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

Example:

"money"

variant.attributes. id · integer

Attribute ID

Example:

44

variant.attributes. editable_by · enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

Example:

"brand"

variant.attributes. grouping · enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

Example:

"general"

variant.attributes. description · string | null

Attribute description

Example:

"demo product description"

variant.attributes. units · string | null

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

Maximum length: 32

Example:

"USD"

variant.attributes. values · object

Show child attributes

variant.attributes.values. id · integer

Attribute value ID

variant.attributes.values. value · string

Attribute value

variant.attributes.values. unit · object

Show child attributes

variant.attributes.values.unit. id · integer

Unit ID

Example:

677

variant.attributes.values.unit. name · string

Unit name

Minimum length: 1

Example:

"Sample unit"

variant.attributes.values.unit. standard_unit · string

Standard unit

Minimum length: 1

variant.attributes.values.unit. type · enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

variant.attributes.values.unit. system · enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

variant.attributes.values.unit. symbol · string | null

Unit symbol

Maximum length: 5

Example:

"USD"

variant.attributes.values. retailer · object

Show child attributes

variant.attributes.values.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variant.attributes.values.retailer. code · string · required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variant.attributes.values.retailer. id · integer

Retailer ID

Example:

500

variant.attributes.values.retailer. logo_url · string

URL of retailer logo

Minimum length: 1

Example:

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

variant.attributes.values.retailer. cover_url · string

URL of retailer cover image

Minimum length: 1

Example:

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

variant.attributes.values.retailer. profile_tile_url · string

URL of retailer profile image

Minimum length: 1

Example:

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

variant.attributes.values.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

variant.attributes.values.retailer. is_rcn_retailer · boolean

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

Example:

false

variant.attributes.values.retailer. is_onboarded · boolean

true: Retailer is onboarded | false: Retailer is not onboarded

Example:

false

variant.attributes.values.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variant.attributes.values.retailer. requires_subscription · enum<string>

Represents whether the retailer requires a subscription to use the platform.

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

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

variant.attributes.values.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

variant.attributes.values.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variant.attributes.values. updated_at · string

Time of update

variant.attributes.values. created_at · string

Time of creation

variant. ruleset_variants · object[]

Show child attributes

variant.ruleset_variants. id · integer

ID of ruleset variant

Example:

1232

variant.ruleset_variants. status · enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

Example:

"processing"

variant.ruleset_variants. results · string

Response

variant.ruleset_variants. created_at · string

Time of creation (UTC format)

Example:

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

variant.ruleset_variants. updated_at · string

Time of last update (UTC format)

Example:

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

variant. ruleset_variant_summary · string

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

Example:

"21"

variant. active_permit · object

Show child attributes

variant.active_permit. id · integer

Permit ID

Example:

10104

variant.active_permit. retailer · object

Show child attributes

variant.active_permit.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variant.active_permit.retailer. code · string · required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variant.active_permit.retailer. id · integer

Retailer ID

Example:

500

variant.active_permit.retailer. logo_url · string

URL of retailer logo

Minimum length: 1

Example:

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

variant.active_permit.retailer. cover_url · string

URL of retailer cover image

Minimum length: 1

Example:

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

variant.active_permit.retailer. profile_tile_url · string

URL of retailer profile image

Minimum length: 1

Example:

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

variant.active_permit.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

variant.active_permit.retailer. is_rcn_retailer · boolean

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

Example:

false

variant.active_permit.retailer. is_onboarded · boolean

true: Retailer is onboarded | false: Retailer is not onboarded

Example:

false

variant.active_permit.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variant.active_permit.retailer. requires_subscription · enum<string>

Represents whether the retailer requires a subscription to use the platform.

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

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

variant.active_permit.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

variant.active_permit.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variant.active_permit. retailer_price · string | null

Retailer price of the variant

Example:

"12.99"

variant.active_permit. retailer_cost · string | null

Retailer cost of variant

Example:

"8.99"

variant.active_permit. pricing · object

variant.active_permit. attributes · object

variant.active_permit. start_at · string | null

Time of permit start (UTC format)

Example:

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

variant.active_permit. end_at · string | null

Time of permit end (UTC format)

Example:

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

variant.active_permit. is_in_effect · boolean

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

Example:

true

variant.active_permit. revoked_at · string | null

Time when permit got revoked (UTC format)

Example:

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

variant.active_permit. is_acknowledged · boolean

true: permit is acknowledged | false: permit is not acknowledged

Example:

true

variant.active_permit. acknowledged_at · string | null

Time of acknowledgement (UTC format)

Example:

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

variant. permits · object[]

Show child attributes

variant.permits. id · integer

Permit ID

Example:

10104

variant.permits. retailer · object

Show child attributes

variant.permits.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variant.permits.retailer. code · string · required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variant.permits.retailer. id · integer

Retailer ID

Example:

500

variant.permits.retailer. logo_url · string

URL of retailer logo

Minimum length: 1

Example:

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

variant.permits.retailer. cover_url · string

URL of retailer cover image

Minimum length: 1

Example:

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

variant.permits.retailer. profile_tile_url · string

URL of retailer profile image

Minimum length: 1

Example:

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

variant.permits.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

variant.permits.retailer. is_rcn_retailer · boolean

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

Example:

false

variant.permits.retailer. is_onboarded · boolean

true: Retailer is onboarded | false: Retailer is not onboarded

Example:

false

variant.permits.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variant.permits.retailer. requires_subscription · enum<string>

Represents whether the retailer requires a subscription to use the platform.

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

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

variant.permits.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

variant.permits.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variant.permits. retailer_price · string | null

Retailer price of the variant

Example:

"12.99"

variant.permits. retailer_cost · string | null

Retailer cost of variant

Example:

"8.99"

variant.permits. pricing · object

variant.permits. attributes · object

variant.permits. start_at · string | null

Time of permit start (UTC format)

Example:

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

variant.permits. end_at · string | null

Time of permit end (UTC format)

Example:

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

variant.permits. is_in_effect · boolean

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

Example:

true

variant.permits. revoked_at · string | null

Time when permit got revoked (UTC format)

Example:

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

variant.permits. is_acknowledged · boolean

true: permit is acknowledged | false: permit is not acknowledged

Example:

true

variant.permits. acknowledged_at · string | null

Time of acknowledgement (UTC format)

Example:

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

variant. is_compatible · boolean

true: variant meets requirement | false: variant doesn't meet requirement

Example:

true

variant. proposal_variant · object

Show child attributes

variant.proposal_variant. id · integer

Proposal variant ID

Example:

3456

variant.proposal_variant. pricing · string

Pricing of variant

Example:

"12.00"

variant.proposal_variant. attributes · object[]

Show child attributes

variant.proposal_variant.attributes. id · integer

Attribute value ID

variant.proposal_variant.attributes. value · string

Attribute value

variant.proposal_variant.attributes. unit · object

Show child attributes

variant.proposal_variant.attributes.unit. id · integer

Unit ID

Example:

677

variant.proposal_variant.attributes.unit. name · string

Unit name

Minimum length: 1

Example:

"Sample unit"

variant.proposal_variant.attributes.unit. standard_unit · string

Standard unit

Minimum length: 1

variant.proposal_variant.attributes.unit. type · enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

variant.proposal_variant.attributes.unit. system · enum<string> | null

Unit system

Available options:

metric,

imperial

Example:

"metric"

variant.proposal_variant.attributes.unit. symbol · string | null

Unit symbol

Maximum length: 5

Example:

"USD"

variant.proposal_variant.attributes. retailer · object

Show child attributes

variant.proposal_variant.attributes.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variant.proposal_variant.attributes.retailer. code · string · required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variant.proposal_variant.attributes.retailer. id · integer

Retailer ID

Example:

500

variant.proposal_variant.attributes.retailer. logo_url · string

URL of retailer logo

Minimum length: 1

Example:

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

variant.proposal_variant.attributes.retailer. cover_url · string

URL of retailer cover image

Minimum length: 1

Example:

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

variant.proposal_variant.attributes.retailer. profile_tile_url · string

URL of retailer profile image

Minimum length: 1

Example:

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

variant.proposal_variant.attributes.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

variant.proposal_variant.attributes.retailer. is_rcn_retailer · boolean

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

Example:

false

variant.proposal_variant.attributes.retailer. is_onboarded · boolean

true: Retailer is onboarded | false: Retailer is not onboarded

Example:

false

variant.proposal_variant.attributes.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variant.proposal_variant.attributes.retailer. requires_subscription · enum<string>

Represents whether the retailer requires a subscription to use the platform.

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

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

variant.proposal_variant.attributes.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

variant.proposal_variant.attributes.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variant.proposal_variant.attributes. updated_at · string

Time of update

variant.proposal_variant.attributes. created_at · string

Time of creation

variant.proposal_variant. memos · object[]

Show child attributes

variant.proposal_variant.memos. id · integer

Memo ID

Example:

1234

variant.proposal_variant.memos. text · string

Memo text

Example:

"Immediate requirement"

variant.proposal_variant.memos. visibility · enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

variant.proposal_variant.memos. acknowledged_at · string

Time memo acknowledgement (UTC format)

Example:

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

variant.proposal_variant.memos. notify_people · boolean

true: notify stakeholders | false: do not notify

Example:

true

variant.proposal_variant.memos. created_by · object

Show child attributes

variant.proposal_variant.memos.created_by. id · integer

User ID who accepted or rejected the invoice

Example:

542

variant.proposal_variant.memos.created_by. first_name · string | null

First name of user

Maximum length: 64

Example:

"Sample"

variant.proposal_variant.memos.created_by. last_name · string | null

Last name of user

Maximum length: 64

Example:

"Demo"

variant.proposal_variant.memos.created_by. title · string | null

User title

Maximum length: 64

Example:

"Demo"

variant.proposal_variant.memos.created_by. status · enum<string>

User status

Available options:

active,

invited,

locked

Example:

"Active"

variant.proposal_variant.memos.created_by. type · enum<string>

User type

Available options:

standard,

api

Example:

"standard"

variant.proposal_variant.memos.created_by. photo_url · string

URL of the user photo

Minimum length: 1

Example:

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

variant.proposal_variant.memos.created_by. profile_photo · string

URL of the user's profile photo

Minimum length: 1

Example:

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

variant.proposal_variant.memos.created_by. is_me · boolean

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

Example:

true

variant.proposal_variant.memos. created_by_context · enum<string> | null

Indicates whether the memo was created by the retailer or brand.

Available options:

retailer,

brand

Example:

"retailer"

variant.proposal_variant.memos. created_at · string

Time of memo creation (UTC format)

Example:

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

variant.proposal_variant.memos. updated_at · string

Time of memo update (UTC format)

Example:

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

variant.proposal_variant. issues · object[]

Show child attributes

variant.proposal_variant.issues. id · integer

Issue ID

variant.proposal_variant.issues. memos · object[]

Show child attributes

variant.proposal_variant.issues.memos. id · integer

Memo ID

Example:

1234

variant.proposal_variant.issues.memos. text · string

Memo text

Example:

"Immediate requirement"

variant.proposal_variant.issues.memos. visibility · enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

variant.proposal_variant.issues.memos. acknowledged_at · string

Time memo acknowledgement (UTC format)

Example:

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

variant.proposal_variant.issues.memos. notify_people · boolean

true: notify stakeholders | false: do not notify

Example:

true

variant.proposal_variant.issues.memos. created_by · object

Show child attributes

variant.proposal_variant.issues.memos. created_by_context · enum<string> | null

Indicates whether the memo was created by the retailer or brand.

Available options:

retailer,

brand

Example:

"retailer"

variant.proposal_variant.issues.memos. created_at · string

Time of memo creation (UTC format)

Example:

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

variant.proposal_variant.issues.memos. updated_at · string

Time of memo update (UTC format)

Example:

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

variant.proposal_variant.issues. created_at · string

Time of issue creation

variant.proposal_variant.issues. updated_at · string

Time of issue update

variant.proposal_variant.issues. resolved_at · string

Time of issue resolution

variant.proposal_variant.issues. is_resolved · string

true: Issue is resolved | false: Issue is not resolved

variant.proposal_variant.issues. issue_id · integer

Issue ID

variant.proposal_variant.issues. message · string

Description or note related to issue

Minimum length: 1

variant.proposal_variant.issues. title · string

Issue title

Minimum length: 1

variant.proposal_variant. variant_id · integer

Variant ID

Example:

249

variant.proposal_variant. approved_at · string | null

Time of approval (UTC format)

Example:

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

variant.proposal_variant. created_at · string

Time of creation (UTC format)

Example:

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

variant.proposal_variant. updated_at · string

Time of last update (UTC format)

Example:

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

variant.proposal_variant. rejected_at · string | null

Time when the proposal was rejected (UTC format).

Example:

null

variant.proposal_variant. reject_reason · string | null

Rejection reason

Maximum length: 32

Example:

"Incomplete"

variant.proposal_variant. reject · boolean

true: proposal is rejected | false: proposal is not rejected

Example:

true

variant.proposal_variant. approve · boolean

true: proposal is approved | false: proposal is not approved

Example:

false

variant.proposal_variant. delete · boolean

true: proposal is deleted | false: proposal is not deleted

Example:

false

variant. retailer_identifiers · object

Show child attributes

variant.retailer_identifiers. id · integer

Retailer ID

Example:

5642

variant.retailer_identifiers. retailer · object

Show child attributes

variant.retailer_identifiers.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variant.retailer_identifiers.retailer. code · string · required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variant.retailer_identifiers.retailer. id · integer

Retailer ID

Example:

500

variant.retailer_identifiers.retailer. logo_url · string

URL of retailer logo

Minimum length: 1

Example:

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

variant.retailer_identifiers.retailer. cover_url · string

URL of retailer cover image

Minimum length: 1

Example:

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

variant.retailer_identifiers.retailer. profile_tile_url · string

URL of retailer profile image

Minimum length: 1

Example:

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

variant.retailer_identifiers.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

variant.retailer_identifiers.retailer. is_rcn_retailer · boolean

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

Example:

false

variant.retailer_identifiers.retailer. is_onboarded · boolean

true: Retailer is onboarded | false: Retailer is not onboarded

Example:

false

variant.retailer_identifiers.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variant.retailer_identifiers.retailer. requires_subscription · enum<string>

Represents whether the retailer requires a subscription to use the platform.

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

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

variant.retailer_identifiers.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

variant.retailer_identifiers.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variant.retailer_identifiers. identifier · string | null

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

Maximum length: 256

Example:

"SKU976"

variant.retailer_identifiers. name · string | null

Retailer name

Maximum length: 256

Example:

"Retailer Sample"

variant. retailer_categories · object

Show child attributes

variant.retailer_categories. category · string · required

Category name

Required string length: 1 - 256

Example:

"CategoryANC"

variant.retailer_categories. id · integer

Retailer category ID

Example:

453

variant.retailer_categories. retailer · object

Show child attributes

variant.retailer_categories.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

variant.retailer_categories.retailer. code · string · required

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

Required string length: 1 - 32

Example:

"demo-retailer"

variant.retailer_categories.retailer. id · integer

Retailer ID

Example:

500

variant.retailer_categories.retailer. logo_url · string

URL of retailer logo

Minimum length: 1

Example:

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

variant.retailer_categories.retailer. cover_url · string

URL of retailer cover image

Minimum length: 1

Example:

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

variant.retailer_categories.retailer. profile_tile_url · string

URL of retailer profile image

Minimum length: 1

Example:

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

variant.retailer_categories.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

variant.retailer_categories.retailer. is_rcn_retailer · boolean

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

Example:

false

variant.retailer_categories.retailer. is_onboarded · boolean

true: Retailer is onboarded | false: Retailer is not onboarded

Example:

false

variant.retailer_categories.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

variant.retailer_categories.retailer. requires_subscription · enum<string>

Represents whether the retailer requires a subscription to use the platform.

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

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

variant.retailer_categories.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

variant.retailer_categories.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

variant. inventory · object

Show child attributes

variant.inventory. inventory_updated_at · string · required

Time of inventory update (UTC format)

Example:

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

variant.inventory. inventory_last_submitted_at · string · required

Time of inventory submit (UTC format)

Example:

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

variant.inventory. brand_inventory_updated_at · string · required

Time of vendor inventory update (UTC format)

Example:

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

variant.inventory. sellable_updated_at · string · required

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

Example:

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

variant.inventory. estimated_availability_date · string · required

Estimated delivery date (UTC format)

Minimum length: 1

Example:

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

variant.inventory. discontinued · boolean

true: Product is discontinued | false: Product is active

Example:

true

variant.inventory. discontinued_updated_at · string

Time of when product inventory was discontinued (UTC format)

Example:

null

variant.inventory. inventory · integer

Inventory of variant

Example:

0

variant.inventory. sellable · string

yes: Variant is sellable | No: Variant is not sellable

Example:

"No"

variant.inventory. replenishable · boolean

true: product is replenishable | false: product is not replenishable

Example:

true

variant.inventory. locations · object[]

Show child attributes

variant.inventory.locations. id · integer

Location ID

Example:

1

variant.inventory.locations. address · object

Show child attributes

variant.inventory.locations.address. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

variant.inventory.locations.address. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

variant.inventory.locations.address. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

variant.inventory.locations.address. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

variant.inventory.locations.address. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

variant.inventory.locations.address. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

variant.inventory.locations.address. id · integer

Address ID

Example:

10

variant.inventory.locations.address. type · enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

variant.inventory.locations.address. name2 · string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

variant.inventory.locations.address. street2 · string | null

Line 2 of the address

Maximum length: 128

Example:

null

variant.inventory.locations.address. phone1 · string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

variant.inventory.locations.address. phone2 · string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

variant.inventory.locations.address. fax · string | null

Fax number

Maximum length: 32

Example:

null

variant.inventory.locations.address. email · string | null

Contact email address

Maximum length: 128

Example:

null

variant.inventory.locations.address. federal_tax_id · string | null

Federal tax ID

Maximum length: 32

Example:

null

variant.inventory.locations. inventory · integer

Count of sellable variants

Example:

0

variant.inventory.locations. nickname · string

Nickname of location

Example:

"LA Warehouse"

inventory_policy · enum<string>

Specifies how inventory is managed for the product.

Available options:

unmanaged,

managed

Example:

"managed"

inventory · integer

Count of variant available for sale

Example:

0

discontinued · boolean

true: Variant is discontinued | false: Variant is active

Example:

false

discontinued_updated_at · string

Time variant marked discontinued (UTC format)

Example:

null

replenishable · boolean

true: Variant is replenishable | false: Variant is not replenishable

Example:

true

sellable · string

true: Variant is sellable | false: Variant is not sellable

Example:

"No"

locations · object[]

Show child attributes

locations. id · integer

Location ID

Example:

1

locations. address · object

Show child attributes

locations.address. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

locations.address. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

locations.address. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

locations.address. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

locations.address. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

locations.address. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

locations.address. id · integer

Address ID

Example:

10

locations.address. type · enum<string> | null

Type of address

Available options:

residential,

commercial

Example:

"residential"

locations.address. name2 · string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

locations.address. street2 · string | null

Line 2 of the address

Maximum length: 128

Example:

null

locations.address. phone1 · string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

locations.address. phone2 · string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

locations.address. fax · string | null

Fax number

Maximum length: 32

Example:

null

locations.address. email · string | null

Contact email address

Maximum length: 128

Example:

null

locations.address. federal_tax_id · string | null

Federal tax ID

Maximum length: 32

Example:

null

locations. inventory · integer

Count of sellable variants

Example:

0

locations. nickname · string

Nickname of location

Example:

"LA Warehouse"