Update attributes of a variant

Updates the attributes of a variant

Authorizations

Authorization

string

header

required

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

Path Parameters

id

integer

required

Variant ID

retailer_pk

number

required

Retailer ID

Body

application/json

active_permit

object

Show child attributes

active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

active_permit.attributes

object

active_permit.end_at

string | null

Time of permit end (UTC format)

active_permit.pricing

object

active_permit.retailer

object

Show child attributes

active_permit.retailer.code

string

required

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

Required string length: 1 - 32

active_permit.retailer.name

string

required

Retailer name

Required string length: 1 - 64

active_permit.retailer.brand_permit_creation_allowed

boolean

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

active_permit.retailer.is_onboarded

boolean

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

active_permit.retailer.is_rcn_retailer

boolean

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

active_permit.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

active_permit.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

active_permit.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

active_permit.retailer.website

string | null

Website URL

Maximum length: 100

active_permit.retailer_cost

string | null

Retailer cost of variant

active_permit.retailer_price

string | null

Retailer price of the variant

active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

active_permit.start_at

string | null

Time of permit start (UTC format)

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

brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

brand.is_on_rcn

boolean

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

brand.name

string

Vendor name

Required string length: 1 - 64

brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

brand.website

string | null

URL of brand website

Maximum length: 100

color

string | null

Variant color

Maximum length: 128

identifier

string | null

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

Maximum length: 128

inventory

object

Show child attributes

inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

inventory.sellable_updated_at

string

required

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

name

string | null

Variant name

Maximum length: 200

parent_identifier

string | null

Parent identifier of variant

Maximum length: 100

parent_name

string | null

Parent name of variant

Maximum length: 200

proposal_variant

object

Show child attributes

proposal_variant.approve

boolean

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

proposal_variant.approved_at

string | null

Time of approval (UTC format)

proposal_variant.attributes

object[]

Show child attributes

proposal_variant.attributes.retailer

object

Show child attributes

proposal_variant.attributes.retailer.code

string

required

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

Required string length: 1 - 32

proposal_variant.attributes.retailer.name

string

required

Retailer name

Required string length: 1 - 64

proposal_variant.attributes.retailer.brand_permit_creation_allowed

boolean

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

proposal_variant.attributes.retailer.is_onboarded

boolean

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

proposal_variant.attributes.retailer.is_rcn_retailer

boolean

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

proposal_variant.attributes.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

proposal_variant.attributes.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

proposal_variant.attributes.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

proposal_variant.attributes.retailer.website

string | null

Website URL

Maximum length: 100

proposal_variant.attributes.unit

object

Show child attributes

proposal_variant.attributes.unit.symbol

string | null

Unit symbol

Maximum length: 5

proposal_variant.attributes.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

proposal_variant.attributes.updated_at

string

Time of update

proposal_variant.attributes.value

string

Attribute value

proposal_variant.delete

boolean

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

proposal_variant.memos

object[]

Show child attributes

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

proposal_variant.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

proposal_variant.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

proposal_variant.memos.created_by.title

string | null

User title

Maximum length: 64

proposal_variant.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

proposal_variant.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

proposal_variant.memos.notify_people

boolean

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

proposal_variant.memos.text

string

Memo text

proposal_variant.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

proposal_variant.reject

boolean

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

proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

retailer_categories

object

Show child attributes

retailer_categories.category

string

required

Category name

Required string length: 1 - 256

retailer_categories.retailer

object

Show child attributes

retailer_categories.retailer.code

string

required

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

Required string length: 1 - 32

retailer_categories.retailer.name

string

required

Retailer name

Required string length: 1 - 64

retailer_categories.retailer.brand_permit_creation_allowed

boolean

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

retailer_categories.retailer.is_onboarded

boolean

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

retailer_categories.retailer.is_rcn_retailer

boolean

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

retailer_categories.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

retailer_categories.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

retailer_categories.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

retailer_categories.retailer.website

string | null

Website URL

Maximum length: 100

size

string | null

Variant size

Maximum length: 128

style

string | null

Variant style

Maximum length: 128

upc

string

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

Maximum length: 64

Response

200 - application/json

active_permit

object

Show child attributes

active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

active_permit.attributes

object

active_permit.end_at

string | null

Time of permit end (UTC format)

active_permit.id

integer

Permit ID

active_permit.is_acknowledged

boolean

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

active_permit.is_in_effect

boolean

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

active_permit.pricing

object

active_permit.retailer

object

Show child attributes

active_permit.retailer.code

string

required

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

Required string length: 1 - 32

active_permit.retailer.name

string

required

Retailer name

Required string length: 1 - 64

active_permit.retailer.brand_permit_creation_allowed

boolean

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

active_permit.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

active_permit.retailer.id

integer

Retailer ID

active_permit.retailer.is_onboarded

boolean

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

active_permit.retailer.is_rcn_retailer

boolean

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

active_permit.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

active_permit.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

active_permit.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

active_permit.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

active_permit.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

active_permit.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

active_permit.retailer.website

string | null

Website URL

Maximum length: 100

active_permit.retailer_cost

string | null

Retailer cost of variant

active_permit.retailer_price

string | null

Retailer price of the variant

active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

active_permit.start_at

string | null

Time of permit start (UTC format)

attributes

object[]

Show child attributes

attributes.code

string

required

Attribute code

Required string length: 1 - 200

attributes.name

string

required

Attribute name

Required string length: 1 - 200

attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

attributes.description

string | null

Attribute description

attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

attributes.id

integer

Attribute ID

attributes.units

string | null

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

Maximum length: 32

attributes.values

object

Show child attributes

attributes.values.created_at

string

Time of creation

attributes.values.id

integer

Attribute value ID

attributes.values.retailer

object

Show child attributes

attributes.values.retailer.code

string

required

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

Required string length: 1 - 32

attributes.values.retailer.name

string

required

Retailer name

Required string length: 1 - 64

attributes.values.retailer.brand_permit_creation_allowed

boolean

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

attributes.values.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

attributes.values.retailer.id

integer

Retailer ID

attributes.values.retailer.is_onboarded

boolean

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

attributes.values.retailer.is_rcn_retailer

boolean

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

attributes.values.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

attributes.values.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

attributes.values.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

attributes.values.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

attributes.values.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

attributes.values.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

attributes.values.retailer.website

string | null

Website URL

Maximum length: 100

attributes.values.unit

object

Show child attributes

attributes.values.unit.id

integer

Unit ID

attributes.values.unit.name

string

Unit name

Minimum length: 1

attributes.values.unit.standard_unit

string

Standard unit

Minimum length: 1

attributes.values.unit.symbol

string | null

Unit symbol

Maximum length: 5

attributes.values.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

attributes.values.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

attributes.values.updated_at

string

Time of update

attributes.values.value

string

Attribute value

brand

object

Show child attributes

brand.code

string

required

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

Required string length: 1 - 64

brand.cover_url

string

URL of the cover image

Minimum length: 1

brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

brand.id

integer

Vendor (brand) ID

brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

brand.is_on_rcn

boolean

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

brand.is_onboarded

boolean

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

brand.joined_at

string

Time when vendor joined Dropship (UTC format)

brand.logo_url

string

URL of the brand logo

Minimum length: 1

brand.name

string

Vendor name

Required string length: 1 - 64

brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

brand.subscription_is_delinquent

boolean

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

brand.subscription_is_expired

boolean

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

brand.subscription_is_on_grace_period

boolean

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

brand.website

string | null

URL of brand website

Maximum length: 100

brand_identifier

string

Brand identifier

Minimum length: 1

cartons

object[]

Show child attributes

cartons.height

string | null

Carton height

cartons.height_unit

string

Unit of height

cartons.id

integer

Carton ID

cartons.length

string | null

Carton length

cartons.length_unit

string

Unit of length

cartons.number

integer

Carton number

Required range: -2147483648 < x < 2147483647

cartons.package_girth_inches

string

Girth of the package, in inches

cartons.package_size_inches

string

Size of the package, in inches

cartons.weight

string | null

Carton weight

cartons.weight_unit

string

Unit of weight

cartons.width

string | null

Carton width

cartons.width_unit

string

Unit of width

color

string | null

Variant color

Maximum length: 128

id

integer

Variant ID

identifier

string | null

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

Maximum length: 128

inventory

object

Show child attributes

inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

inventory.sellable_updated_at

string

required

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

inventory.discontinued

boolean

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

inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

inventory.inventory

integer

Inventory of variant

inventory.locations

object[]

Show child attributes

inventory.locations.address

object

Show child attributes

inventory.locations.address.city

string

required

City name

Required string length: 1 - 64

inventory.locations.address.country

string

required

Country name

Required string length: 1 - 128

inventory.locations.address.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

inventory.locations.address.postal_code

string

required

Postal code

Required string length: 1 - 32

inventory.locations.address.province

string

required

State name

Required string length: 1 - 32

inventory.locations.address.street1

string

required

Line 1 of the address

Required string length: 1 - 128

inventory.locations.address.email

string | null

Contact email address

Maximum length: 128

inventory.locations.address.fax

string | null

Fax number

Maximum length: 32

inventory.locations.address.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

inventory.locations.address.id

integer

Address ID

inventory.locations.address.name2

string | null

Name of the alternative contact?

Maximum length: 64

inventory.locations.address.phone1

string | null

Primary contact number

Maximum length: 32

inventory.locations.address.phone2

string | null

Alternate contact number

Maximum length: 32

inventory.locations.address.street2

string | null

Line 2 of the address

Maximum length: 128

inventory.locations.address.type

enum<string> | null

Type of address

Available options:

residential,

commercial

inventory.locations.id

integer

Location ID

inventory.locations.inventory

integer

Count of sellable variants

inventory.locations.nickname

string

Nickname of location

inventory.replenishable

boolean

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

inventory.sellable

string

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

inventory_policy

string

Inventory policy

is_compatible

string

true: variant is compatible <br /> false: variant is not compatible

media

object[]

Show child attributes

media.created_at

string

Time of variant image creation (UTC format)

media.height

integer | null

Height of variant image

Required range: -2147483648 < x < 2147483647

media.id

integer

Variant ID

media.media

string

Variant images

media.priority

integer

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

Required range: -2147483648 < x < 2147483647

media.updated_at

string

Time of variant image update (UTC format)

media.url

string

URL of variant image

media.width

integer | null

Width of variant image

Required range: -2147483648 < x < 2147483647

name

string | null

Variant name

Maximum length: 200

parent_identifier

string | null

Parent identifier of variant

Maximum length: 100

parent_name

string | null

Parent name of variant

Maximum length: 200

permits

object[]

Show child attributes

permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

permits.attributes

object

permits.end_at

string | null

Time of permit end (UTC format)

permits.id

integer

Permit ID

permits.is_acknowledged

boolean

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

permits.is_in_effect

boolean

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

permits.pricing

object

permits.retailer

object

Show child attributes

permits.retailer.code

string

required

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

Required string length: 1 - 32

permits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

permits.retailer.brand_permit_creation_allowed

boolean

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

permits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

permits.retailer.id

integer

Retailer ID

permits.retailer.is_onboarded

boolean

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

permits.retailer.is_rcn_retailer

boolean

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

permits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

permits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

permits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

permits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

permits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

permits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

permits.retailer.website

string | null

Website URL

Maximum length: 100

permits.retailer_cost

string | null

Retailer cost of variant

permits.retailer_price

string | null

Retailer price of the variant

permits.revoked_at

string | null

Time when permit got revoked (UTC format)

permits.start_at

string | null

Time of permit start (UTC format)

permits_count

integer

Count of permits

product_id

string

Product ID

proposal_variant

object

Show child attributes

proposal_variant.approve

boolean

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

proposal_variant.approved_at

string | null

Time of approval (UTC format)

proposal_variant.attributes

object[]

Show child attributes

proposal_variant.attributes.created_at

string

Time of creation

proposal_variant.attributes.id

integer

Attribute value ID

proposal_variant.attributes.retailer

object

Show child attributes

proposal_variant.attributes.retailer.code

string

required

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

Required string length: 1 - 32

proposal_variant.attributes.retailer.name

string

required

Retailer name

Required string length: 1 - 64

proposal_variant.attributes.retailer.brand_permit_creation_allowed

boolean

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

proposal_variant.attributes.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

proposal_variant.attributes.retailer.id

integer

Retailer ID

proposal_variant.attributes.retailer.is_onboarded

boolean

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

proposal_variant.attributes.retailer.is_rcn_retailer

boolean

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

proposal_variant.attributes.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

proposal_variant.attributes.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

proposal_variant.attributes.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

proposal_variant.attributes.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

proposal_variant.attributes.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

proposal_variant.attributes.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

proposal_variant.attributes.retailer.website

string | null

Website URL

Maximum length: 100

proposal_variant.attributes.unit

object

Show child attributes

proposal_variant.attributes.unit.id

integer

Unit ID

proposal_variant.attributes.unit.name

string

Unit name

Minimum length: 1

proposal_variant.attributes.unit.standard_unit

string

Standard unit

Minimum length: 1

proposal_variant.attributes.unit.symbol

string | null

Unit symbol

Maximum length: 5

proposal_variant.attributes.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

proposal_variant.attributes.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

proposal_variant.attributes.updated_at

string

Time of update

proposal_variant.attributes.value

string

Attribute value

proposal_variant.created_at

string

Time of creation (UTC format)

proposal_variant.delete

boolean

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

proposal_variant.id

integer

Proposal variant ID

proposal_variant.issues

object[]

Show child attributes

proposal_variant.issues.created_at

string

Time of issue creation

proposal_variant.issues.id

integer

Issue ID

proposal_variant.issues.is_resolved

string

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

proposal_variant.issues.issue_id

integer

Issue ID

proposal_variant.issues.memos

object[]

Show child attributes

proposal_variant.issues.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

proposal_variant.issues.memos.created_at

string

Time of memo creation (UTC format)

proposal_variant.issues.memos.created_by

object

Show child attributes

proposal_variant.issues.memos.created_by.first_name

string | null

First name of user

Maximum length: 64

proposal_variant.issues.memos.created_by.id

integer

User ID who accepted or rejected the invoice

proposal_variant.issues.memos.created_by.is_me

boolean

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

proposal_variant.issues.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

proposal_variant.issues.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

proposal_variant.issues.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

proposal_variant.issues.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

proposal_variant.issues.memos.created_by.title

string | null

User title

Maximum length: 64

proposal_variant.issues.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

proposal_variant.issues.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

proposal_variant.issues.memos.id

integer

Memo ID

proposal_variant.issues.memos.notify_people

boolean

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

proposal_variant.issues.memos.text

string

Memo text

proposal_variant.issues.memos.updated_at

string

Time of memo update (UTC format)

proposal_variant.issues.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

proposal_variant.issues.message

string

Description or note related to issue

Minimum length: 1

proposal_variant.issues.resolved_at

string

Time of issue resolution

proposal_variant.issues.title

string

Issue title

Minimum length: 1

proposal_variant.issues.updated_at

string

Time of issue update

proposal_variant.memos

object[]

Show child attributes

proposal_variant.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

proposal_variant.memos.created_at

string

Time of memo creation (UTC format)

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

proposal_variant.memos.created_by.id

integer

User ID who accepted or rejected the invoice

proposal_variant.memos.created_by.is_me

boolean

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

proposal_variant.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

proposal_variant.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

proposal_variant.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

proposal_variant.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

proposal_variant.memos.created_by.title

string | null

User title

Maximum length: 64

proposal_variant.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

proposal_variant.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

proposal_variant.memos.id

integer

Memo ID

proposal_variant.memos.notify_people

boolean

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

proposal_variant.memos.text

string

Memo text

proposal_variant.memos.updated_at

string

Time of memo update (UTC format)

proposal_variant.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

proposal_variant.pricing

string

Pricing of variant

proposal_variant.reject

boolean

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

proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

proposal_variant.updated_at

string

Time of last update (UTC format)

proposal_variant.variant_id

integer

Variant ID

retailer_categories

object

Show child attributes

retailer_categories.category

string

required

Category name

Required string length: 1 - 256

retailer_categories.id

integer

Retailer category ID

retailer_categories.retailer

object

Show child attributes

retailer_categories.retailer.code

string

required

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

Required string length: 1 - 32

retailer_categories.retailer.name

string

required

Retailer name

Required string length: 1 - 64

retailer_categories.retailer.brand_permit_creation_allowed

boolean

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

retailer_categories.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

retailer_categories.retailer.id

integer

Retailer ID

retailer_categories.retailer.is_onboarded

boolean

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

retailer_categories.retailer.is_rcn_retailer

boolean

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

retailer_categories.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

retailer_categories.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

retailer_categories.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

retailer_categories.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

retailer_categories.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

retailer_categories.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

retailer_categories.retailer.website

string | null

Website URL

Maximum length: 100

retailer_identifiers

object[]

Show child attributes

retailer_identifiers.id

integer

Retailer ID

retailer_identifiers.identifier

string | null

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

Maximum length: 256

retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

retailer_identifiers.retailer

object

Show child attributes

retailer_identifiers.retailer.code

string

required

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

Required string length: 1 - 32

retailer_identifiers.retailer.name

string

required

Retailer name

Required string length: 1 - 64

retailer_identifiers.retailer.brand_permit_creation_allowed

boolean

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

retailer_identifiers.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

retailer_identifiers.retailer.id

integer

Retailer ID

retailer_identifiers.retailer.is_onboarded

boolean

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

retailer_identifiers.retailer.is_rcn_retailer

boolean

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

retailer_identifiers.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

retailer_identifiers.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

retailer_identifiers.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

retailer_identifiers.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

retailer_identifiers.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

retailer_identifiers.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

retailer_identifiers.retailer.website

string | null

Website URL

Maximum length: 100

ruleset_variant_summary

string

Summary of ruleset variant

ruleset_variants

object[]

Show child attributes

ruleset_variants.created_at

string

Time of creation (UTC format)

ruleset_variants.id

integer

ID of ruleset variant

ruleset_variants.results

string

Response

ruleset_variants.ruleset

object

Show child attributes

ruleset_variants.ruleset.created_at

string

Time of creation (UTC format)

ruleset_variants.ruleset.id

integer

ID of ruleset variant

ruleset_variants.ruleset.results

string

Response

ruleset_variants.ruleset.ruleset

object

Show child attributes

ruleset_variants.ruleset.ruleset.created_at

string

Time of creation (UTC format)

ruleset_variants.ruleset.ruleset.id

integer

ID of ruleset variant

ruleset_variants.ruleset.ruleset.results

string

Response

ruleset_variants.ruleset.ruleset.ruleset

object

Show child attributes

ruleset_variants.ruleset.ruleset.ruleset.created_at

string

Time of creation (UTC format)

ruleset_variants.ruleset.ruleset.ruleset.id

integer

ID of ruleset variant

ruleset_variants.ruleset.ruleset.ruleset.results

string

Response

ruleset_variants.ruleset.ruleset.ruleset.ruleset

object

Show child attributes

ruleset_variants.ruleset.ruleset.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

ruleset_variants.ruleset.ruleset.ruleset.updated_at

string

Time of last update (UTC format)

ruleset_variants.ruleset.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

ruleset_variants.ruleset.ruleset.updated_at

string

Time of last update (UTC format)

ruleset_variants.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

ruleset_variants.ruleset.updated_at

string

Time of last update (UTC format)

ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

ruleset_variants.updated_at

string

Time of last update (UTC format)

size

string | null

Variant size

Maximum length: 128

style

string | null

Variant style

Maximum length: 128

upc

string

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

Maximum length: 64