Update variant attributes

Update attributes like retailer SKU for a variant.

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 variant identifier. This ID is automatically generated when a variant is created.

Body

application/json

name · string | null

Variant name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

parent_identifier · string | null

Parent identifier of variant

Maximum length: 100

Example:

"1000-BL"

parent_name · string | null

Parent name of variant

Maximum length: 200

Example:

"T-Shirt, Blue"

brand · object

Show child attributes

brand. code · string · required

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

Required string length: 1 - 64

Example:

"demo-brand"

brand. name · string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

brand. website · string | null

URL of brand website

Maximum length: 100

Example:

null

brand. is_on_rcn · boolean

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

Example:

false

brand. requires_subscription · enum<string>

Indicates whether a subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

brand. subscription_expires_at · string | null

Subscription expiry Time (UTC format)

Example:

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

brand. grace_period_ends_at · string | null

Time of grace period expiration (UTC format)

Example:

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

brand. inventory_policy · enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

brand. status · enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

identifier · string | null

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

Maximum length: 128

Example:

"1000-BL-L"

upc · string

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

Maximum length: 64

Example:

"9119119111"

color · string | null

Variant color

Maximum length: 128

Example:

"Blue"

style · string | null

Variant style

Maximum length: 128

Example:

"print"

size · string | null

Variant size

Maximum length: 128

Example:

"Medium"

active_permit · object

Show child attributes

active_permit. retailer · object

Show child attributes

active_permit.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

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"

active_permit.retailer. is_rcn_retailer · boolean

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

Example:

false

active_permit.retailer. is_onboarded · boolean

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

Example:

false

active_permit.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

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"

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

active_permit.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

active_permit.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

active_permit. retailer_price · string | null

Retailer price of the variant

Example:

"12.99"

active_permit. retailer_cost · string | null

Retailer cost of variant

Example:

"8.99"

active_permit. pricing · object

active_permit. attributes · object

active_permit. start_at · string | null

Time of permit start (UTC format)

Example:

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

active_permit. end_at · string | null

Time of permit end (UTC format)

Example:

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

active_permit. revoked_at · string | null

Time when permit got revoked (UTC format)

Example:

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

active_permit. acknowledged_at · string | null

Time of acknowledgement (UTC format)

Example:

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

inventory · object

Show child attributes

inventory. inventory_updated_at · string · required

Time of inventory update (UTC format)

Example:

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

inventory. inventory_last_submitted_at · string · required

Time of inventory submit (UTC format)

Example:

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

inventory. brand_inventory_updated_at · string · required

Time of vendor inventory update (UTC format)

Example:

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

inventory. sellable_updated_at · string · required

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

Example:

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

inventory. estimated_availability_date · string · required

Estimated delivery date (UTC format)

Minimum length: 1

Example:

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

proposal_variant · object

Show child attributes

proposal_variant. attributes · object[]

Show child attributes

proposal_variant.attributes. value · string

Attribute value

proposal_variant.attributes. unit · object

Show child attributes

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

Unit system

Available options:

metric,

imperial

Example:

"metric"

proposal_variant.attributes.unit. symbol · string | null

Unit symbol

Maximum length: 5

Example:

"USD"

proposal_variant.attributes. retailer · object

Show child attributes

proposal_variant.attributes.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

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"

proposal_variant.attributes.retailer. is_rcn_retailer · boolean

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

Example:

false

proposal_variant.attributes.retailer. is_onboarded · boolean

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

Example:

false

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

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

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"

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

proposal_variant.attributes.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

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

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

proposal_variant.attributes. updated_at · string

Time of update

proposal_variant. memos · object[]

Show child attributes

proposal_variant.memos. text · string

Memo text

Example:

"Immediate requirement"

proposal_variant.memos. visibility · enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

proposal_variant.memos. notify_people · boolean

true: notify stakeholders | false: do not notify

Example:

true

proposal_variant.memos. created_by · object

Show child attributes

proposal_variant.memos.created_by. first_name · string | null

First name of user

Maximum length: 64

Example:

"Sample"

proposal_variant.memos.created_by. last_name · string | null

Last name of user

Maximum length: 64

Example:

"Demo"

proposal_variant.memos.created_by. title · string | null

User title

Maximum length: 64

Example:

"Demo"

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

User status

Available options:

active,

invited,

locked

Example:

"Active"

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

User type

Available options:

standard,

api

Example:

"standard"

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"

proposal_variant. approved_at · string | null

Time of approval (UTC format)

Example:

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

proposal_variant. rejected_at · string | null

Time when the proposal was rejected (UTC format).

Example:

null

proposal_variant. reject_reason · string | null

Rejection reason

Maximum length: 32

Example:

"Incomplete"

proposal_variant. reject · boolean

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

Example:

true

proposal_variant. approve · boolean

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

Example:

false

proposal_variant. delete · boolean

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

Example:

false

retailer_categories · object

Show child attributes

retailer_categories. category · string · required

Category name

Required string length: 1 - 256

Example:

"CategoryANC"

retailer_categories. retailer · object

Show child attributes

retailer_categories.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

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"

retailer_categories.retailer. is_rcn_retailer · boolean

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

Example:

false

retailer_categories.retailer. is_onboarded · boolean

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

Example:

false

retailer_categories.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

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"

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

retailer_categories.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

retailer_categories.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

Response

200 - application/json

OK

id · integer

Variant ID

Example:

100024

name · string | null

Variant name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

brand_identifier · string

Brand identifier

Minimum length: 1

Example:

"1000-BL-L"

parent_identifier · string | null

Parent identifier of variant

Maximum length: 100

Example:

"1000-BL"

parent_name · string | null

Parent name of variant

Maximum length: 200

Example:

"T-Shirt, Blue"

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 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 length: 1

Example:

"Sample unit"

attributes.values.unit. standard_unit · string

Standard unit

Minimum 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 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 · 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

URL of retailer logo

Minimum length: 1

Example:

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

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"

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"

attributes.values.retailer. joined_at · string

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>

Represents whether the retailer requires a 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 | null

Website URL

Maximum 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

Time of update

attributes.values. created_at · string

Time of creation

brand · object

Show child attributes

brand. code · string · required

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

Required string length: 1 - 64

Example:

"demo-brand"

brand. id · integer

Vendor (brand) ID

Example:

500

brand. name · string

Vendor name

Required string length: 1 - 64

Example:

"Marla Cielo"

brand. joined_at · string

Time when vendor joined Dropship (UTC format)

Example:

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

brand. logo_url · string

URL of the brand logo

Minimum length: 1

Example:

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

brand. cover_url · string

URL of the cover image

Minimum length: 1

Example:

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

brand. profile_tile_url · string

URL of the profile image

Minimum length: 1

Example:

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

brand. website · string | null

URL of brand website

Maximum length: 100

Example:

null

brand. is_onboarded · boolean

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

Example:

false

brand. is_on_rcn · boolean

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

Example:

false

brand. requires_subscription · enum<string>

Indicates whether a subscription is required

Available options:

disabled,

enabled,

upcoming

Example:

"enabled"

brand. subscription_expires_at · string | null

Subscription expiry Time (UTC format)

Example:

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

brand. grace_period_ends_at · string | null

Time of grace period expiration (UTC format)

Example:

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

brand. subscription_is_expired · boolean

true: subscription is expired | false: subscription is active

Example:

false

brand. subscription_is_on_grace_period · boolean

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

Example:

false

brand. subscription_is_delinquent · boolean

true: subscription is overdue | false: subscription is paid

Example:

false

brand. inventory_policy · enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

Example:

"managed"

brand. status · enum<string>

Vendor status

Available options:

active,

pending,

inactive

Example:

"active"

identifier · string | null

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

Maximum length: 128

Example:

"1000-BL-L"

product_id · string

Product ID

Example:

"4511"

cartons · object[]

Show child attributes

cartons. id · integer

Carton ID

Example:

48

cartons. number · integer

Carton number

Required range: -2147483648 <= x <= 2147483647

Example:

1

cartons. length · string | null

Carton length

Example:

"1"

cartons. length_unit · string

Unit of length

Example:

"1"

cartons. width · string | null

Carton width

Example:

"1"

cartons. width_unit · string

Unit of width

Example:

"meter"

cartons. height · string | null

Carton height

Example:

"1"

cartons. height_unit · string

Unit of height

Example:

"meter"

cartons. weight · string | null

Carton weight

Example:

"15"

cartons. weight_unit · string

Unit of weight

Example:

"KG"

cartons. package_girth_inches · string

Girth of the package, in inches

Example:

"1"

cartons. package_size_inches · string

Size of the package, in inches

Example:

"1"

upc · string

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

Maximum length: 64

Example:

"9119119111"

color · string | null

Variant color

Maximum length: 128

Example:

"Blue"

style · string | null

Variant style

Maximum length: 128

Example:

"print"

size · string | null

Variant size

Maximum length: 128

Example:

"Medium"

active_permit · object

Show child attributes

active_permit. id · integer

Permit ID

Example:

10104

active_permit. retailer · object

Show child attributes

active_permit.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

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"

active_permit.retailer. id · integer

Retailer ID

Example:

500

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"

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"

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"

active_permit.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

active_permit.retailer. is_rcn_retailer · boolean

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

Example:

false

active_permit.retailer. is_onboarded · boolean

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

Example:

false

active_permit.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

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"

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

active_permit.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

active_permit.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

active_permit. retailer_price · string | null

Retailer price of the variant

Example:

"12.99"

active_permit. retailer_cost · string | null

Retailer cost of variant

Example:

"8.99"

active_permit. pricing · object

active_permit. attributes · object

active_permit. start_at · string | null

Time of permit start (UTC format)

Example:

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

active_permit. end_at · string | null

Time of permit end (UTC format)

Example:

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

active_permit. is_in_effect · boolean

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

Example:

true

active_permit. revoked_at · string | null

Time when permit got revoked (UTC format)

Example:

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

active_permit. is_acknowledged · boolean

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

Example:

true

active_permit. acknowledged_at · string | null

Time of acknowledgement (UTC format)

Example:

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

permits · object[]

Show child attributes

permits. id · integer

Permit ID

Example:

10104

permits. retailer · object

Show child attributes

permits.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

permits.retailer. code · string · required

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

Required string length: 1 - 32

Example:

"demo-retailer"

permits.retailer. id · integer

Retailer ID

Example:

500

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"

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"

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"

permits.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

permits.retailer. is_rcn_retailer · boolean

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

Example:

false

permits.retailer. is_onboarded · boolean

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

Example:

false

permits.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

permits.retailer. requires_subscription · enum<string>

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

Available options:

disabled,

enabled,

upcoming

Example:

"disabled"

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

permits.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

permits.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

permits. retailer_price · string | null

Retailer price of the variant

Example:

"12.99"

permits. retailer_cost · string | null

Retailer cost of variant

Example:

"8.99"

permits. pricing · object

permits. attributes · object

permits. start_at · string | null

Time of permit start (UTC format)

Example:

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

permits. end_at · string | null

Time of permit end (UTC format)

Example:

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

permits. is_in_effect · boolean

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

Example:

true

permits. revoked_at · string | null

Time when permit got revoked (UTC format)

Example:

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

permits. is_acknowledged · boolean

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

Example:

true

permits. acknowledged_at · string | null

Time of acknowledgement (UTC format)

Example:

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

permits_count · integer

Count of permits

Example:

1

inventory_policy · string

Inventory policy

Example:

"Managed"

inventory · object

Show child attributes

inventory. inventory_updated_at · string · required

Time of inventory update (UTC format)

Example:

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

inventory. inventory_last_submitted_at · string · required

Time of inventory submit (UTC format)

Example:

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

inventory. brand_inventory_updated_at · string · required

Time of vendor inventory update (UTC format)

Example:

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

inventory. sellable_updated_at · string · required

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

Example:

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

inventory. estimated_availability_date · string · required

Estimated delivery date (UTC format)

Minimum length: 1

Example:

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

inventory. discontinued · boolean

true: Product is discontinued | false: Product is active

Example:

true

inventory. discontinued_updated_at · string

Time of when product inventory was discontinued (UTC format)

Example:

null

inventory. inventory · integer

Inventory of variant

Example:

0

inventory. sellable · string

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

Example:

"No"

inventory. replenishable · boolean

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

Example:

true

inventory. locations · object[]

Show child attributes

inventory.locations. id · integer

Location ID

Example:

1

inventory.locations. address · object

Show child attributes

inventory.locations.address. name1 · string · required

Name of the primary contact?

Required string length: 1 - 64

Example:

"Demo Brand, Inc"

inventory.locations.address. street1 · string · required

Line 1 of the address

Required string length: 1 - 128

Example:

"1332 Hermosa Ave"

inventory.locations.address. city · string · required

City name

Required string length: 1 - 64

Example:

"Hermosa Beach"

inventory.locations.address. province · string · required

State name

Required string length: 1 - 32

Example:

"CA"

inventory.locations.address. postal_code · string · required

Postal code

Required string length: 1 - 32

Example:

"90254"

inventory.locations.address. country · string · required

Country name

Required string length: 1 - 128

Example:

"US"

inventory.locations.address. id · integer

Address ID

Example:

10

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

Type of address

Available options:

residential,

commercial

Example:

"residential"

inventory.locations.address. name2 · string | null

Name of the alternative contact?

Maximum length: 64

Example:

null

inventory.locations.address. street2 · string | null

Line 2 of the address

Maximum length: 128

Example:

null

inventory.locations.address. phone1 · string | null

Primary contact number

Maximum length: 32

Example:

"3105551212"

inventory.locations.address. phone2 · string | null

Alternate contact number

Maximum length: 32

Example:

"3105551213"

inventory.locations.address. fax · string | null

Fax number

Maximum length: 32

Example:

null

inventory.locations.address. email · string | null

Contact email address

Maximum length: 128

Example:

null

inventory.locations.address. federal_tax_id · string | null

Federal tax ID

Maximum length: 32

Example:

null

inventory.locations. inventory · integer

Count of sellable variants

Example:

0

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

Time of variant image update (UTC format)

Example:

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

media. created_at · string

Time of variant image creation (UTC format)

Example:

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

ruleset_variants · object[]

Show child attributes

ruleset_variants. id · integer

ID of ruleset variant

Example:

1232

ruleset_variants. status · enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

Example:

"processing"

ruleset_variants. results · string

Response

ruleset_variants. created_at · string

Time of creation (UTC format)

Example:

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

ruleset_variants. updated_at · string

Time of last update (UTC format)

Example:

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

ruleset_variant_summary · string

Summary of ruleset variant

is_compatible · string

true: variant is compatible | false: variant is not compatible

Example:

true

proposal_variant · object

Show child attributes

proposal_variant. id · integer

Proposal variant ID

Example:

3456

proposal_variant. pricing · string

Pricing of variant

Example:

"12.00"

proposal_variant. attributes · object[]

Show child attributes

proposal_variant.attributes. id · integer

Attribute value ID

proposal_variant.attributes. value · string

Attribute value

proposal_variant.attributes. unit · object

Show child attributes

proposal_variant.attributes.unit. id · integer

Unit ID

Example:

677

proposal_variant.attributes.unit. name · string

Unit name

Minimum length: 1

Example:

"Sample unit"

proposal_variant.attributes.unit. standard_unit · string

Standard unit

Minimum length: 1

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

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

Example:

"cost"

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

Unit system

Available options:

metric,

imperial

Example:

"metric"

proposal_variant.attributes.unit. symbol · string | null

Unit symbol

Maximum length: 5

Example:

"USD"

proposal_variant.attributes. retailer · object

Show child attributes

proposal_variant.attributes.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

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"

proposal_variant.attributes.retailer. id · integer

Retailer ID

Example:

500

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"

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"

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"

proposal_variant.attributes.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

proposal_variant.attributes.retailer. is_rcn_retailer · boolean

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

Example:

false

proposal_variant.attributes.retailer. is_onboarded · boolean

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

Example:

false

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

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

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"

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

proposal_variant.attributes.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

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

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

proposal_variant.attributes. updated_at · string

Time of update

proposal_variant.attributes. created_at · string

Time of creation

proposal_variant. memos · object[]

Show child attributes

proposal_variant.memos. id · integer

Memo ID

Example:

1234

proposal_variant.memos. text · string

Memo text

Example:

"Immediate requirement"

proposal_variant.memos. visibility · enum<string>

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

proposal_variant.memos. acknowledged_at · string

Time memo acknowledgement (UTC format)

Example:

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

proposal_variant.memos. notify_people · boolean

true: notify stakeholders | false: do not notify

Example:

true

proposal_variant.memos. created_by · object

Show child attributes

proposal_variant.memos.created_by. id · integer

User ID who accepted or rejected the invoice

Example:

542

proposal_variant.memos.created_by. first_name · string | null

First name of user

Maximum length: 64

Example:

"Sample"

proposal_variant.memos.created_by. last_name · string | null

Last name of user

Maximum length: 64

Example:

"Demo"

proposal_variant.memos.created_by. title · string | null

User title

Maximum length: 64

Example:

"Demo"

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

User status

Available options:

active,

invited,

locked

Example:

"Active"

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

User type

Available options:

standard,

api

Example:

"standard"

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"

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"

proposal_variant.memos.created_by. is_me · boolean

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

Example:

true

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"

proposal_variant.memos. created_at · string

Time of memo creation (UTC format)

Example:

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

proposal_variant.memos. updated_at · string

Time of memo update (UTC format)

Example:

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

proposal_variant. issues · object[]

Show child attributes

proposal_variant.issues. id · integer

Issue ID

proposal_variant.issues. memos · object[]

Show child attributes

proposal_variant.issues.memos. id · integer

Memo ID

Example:

1234

proposal_variant.issues.memos. text · string

Memo text

Example:

"Immediate requirement"

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

Memo visibility

Available options:

any,

retailer,

brand

Example:

"any"

proposal_variant.issues.memos. acknowledged_at · string

Time memo acknowledgement (UTC format)

Example:

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

proposal_variant.issues.memos. notify_people · boolean

true: notify stakeholders | false: do not notify

Example:

true

proposal_variant.issues.memos. created_by · object

Show child attributes

proposal_variant.issues.memos.created_by. id · integer

User ID who accepted or rejected the invoice

Example:

542

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

First name of user

Maximum length: 64

Example:

"Sample"

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

Last name of user

Maximum length: 64

Example:

"Demo"

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

User title

Maximum length: 64

Example:

"Demo"

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

User status

Available options:

active,

invited,

locked

Example:

"Active"

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

User type

Available options:

standard,

api

Example:

"standard"

proposal_variant.issues.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"

proposal_variant.issues.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"

proposal_variant.issues.memos.created_by. is_me · boolean

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

Example:

true

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"

proposal_variant.issues.memos. created_at · string

Time of memo creation (UTC format)

Example:

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

proposal_variant.issues.memos. updated_at · string

Time of memo update (UTC format)

Example:

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

proposal_variant.issues. created_at · string

Time of issue creation

proposal_variant.issues. updated_at · string

Time of issue update

proposal_variant.issues. resolved_at · string

Time of issue resolution

proposal_variant.issues. is_resolved · string

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

proposal_variant.issues. issue_id · integer

Issue ID

proposal_variant.issues. message · string

Description or note related to issue

Minimum length: 1

proposal_variant.issues. title · string

Issue title

Minimum length: 1

proposal_variant. variant_id · integer

Variant ID

Example:

249

proposal_variant. approved_at · string | null

Time of approval (UTC format)

Example:

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

proposal_variant. created_at · string

Time of creation (UTC format)

Example:

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

proposal_variant. updated_at · string

Time of last update (UTC format)

Example:

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

proposal_variant. rejected_at · string | null

Time when the proposal was rejected (UTC format).

Example:

null

proposal_variant. reject_reason · string | null

Rejection reason

Maximum length: 32

Example:

"Incomplete"

proposal_variant. reject · boolean

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

Example:

true

proposal_variant. approve · boolean

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

Example:

false

proposal_variant. delete · boolean

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

Example:

false

retailer_identifiers · object[]

Show child attributes

retailer_identifiers. id · integer

Retailer ID

Example:

5642

retailer_identifiers. retailer · object

Show child attributes

retailer_identifiers.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

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"

retailer_identifiers.retailer. id · integer

Retailer ID

Example:

500

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"

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"

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"

retailer_identifiers.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

retailer_identifiers.retailer. is_rcn_retailer · boolean

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

Example:

false

retailer_identifiers.retailer. is_onboarded · boolean

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

Example:

false

retailer_identifiers.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

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"

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

retailer_identifiers.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

retailer_identifiers.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"

retailer_identifiers. identifier · string | null

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

Maximum length: 256

Example:

"SKU976"

retailer_identifiers. name · string | null

Retailer name

Maximum length: 256

Example:

"Retailer Sample"

retailer_categories · object

Show child attributes

retailer_categories. category · string · required

Category name

Required string length: 1 - 256

Example:

"CategoryANC"

retailer_categories. id · integer

Retailer category ID

Example:

453

retailer_categories. retailer · object

Show child attributes

retailer_categories.retailer. name · string · required

Retailer name

Required string length: 1 - 64

Example:

"Demo Retailer"

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"

retailer_categories.retailer. id · integer

Retailer ID

Example:

500

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"

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"

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"

retailer_categories.retailer. joined_at · string

Time of retailer joining Dropship (UTC format)

Example:

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

retailer_categories.retailer. is_rcn_retailer · boolean

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

Example:

false

retailer_categories.retailer. is_onboarded · boolean

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

Example:

false

retailer_categories.retailer. platform · enum<string>

Platform on which retailer is onboarded

Available options:

fabric

Example:

"fabric"

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"

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

retailer_categories.retailer. website · string | null

Website URL

Maximum length: 100

Example:

"https://demoabc.com"

retailer_categories.retailer. status · enum<string>

Retailer status

Available options:

active,

setup,

ghost

Example:

"active"