Get variants

Gets variants

Authorizations

Authorization

string

header

required

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

Path Parameters

retailer_pk

number

required

Query Parameters

inventory_updated_at_lt

number

Inventory updated date is less than specified date (Unix epoch format)

inventory_updated_at_lte

number

Inventory updated date is less than or equal to specified date (Unix epoch format)

inventory_updated_at_gt

number

Inventory updated date is greater than specified date (Unix epoch format)

inventory_updated_at_gte

number

Inventory updated date is greater than or equal to specified date (Unix epoch format)

search

string

Search criteria

search_id

string

Search ID

search_name

string

Search name

search_upc

string

Search by UPC

search_sku

string

Search by SKUs

retailer_sku

string

Retailer SKUs

attribute

string

Product attribute

retailer_id

number

Retailer ID

brand_id

number[]

Vendor Ids. Multiple values may be separated by commas.

brand_code

string[]

Brand codes. Multiple values may be separated by commas.

manufacturer_id

number[]

Manufacturer IDs. Multiple values may be separated by commas.

manufacturer_code

string[]

Manufacturer codes. Multiple values may be separated by commas.

failed_rule_id

string

Failed rule ID

rule_id

number

Rule ID

ruleset_id

string

Ruleset ID

failure_type

string

Failure type

taxonomy_id

string

Taxonomy ID

retailer_category

string[]

Retailer category. Multiple values may be added, separated by commas.

retailer_category_id

number[]

Retailer category IDs

connection_id

number

Connection ID

product_id

number[]

Product IDs. Multiple values may be separated by commas.

parent_identifier

string[]

Parent identifiers. Multiple values may be separated by commas.

is_replenishable

number

1: Variant is replenishable <br /> 0: Variant is not replenishable

is_discontinued

number

1: Variant is discontinued <br /> 0: Variant is not discontinued

is_sellable

number

1: Variant is sellable <br /> 0: Variant is not sellable

in_stock

number

1: Variant is in stock <br /> 0: Variant is out of stock

has_images

number

1: Variant has images <br /> 0: Variant does not have images.

has_shipping

number

1: Variant has shipping <br /> 0: Variant does not have shipping.

order_by

string

Sorting preference

page

integer

Page number within the paginated result set

limit

integer

Number of records per page

Response

200 - application/json

OK

count

integer

required

Total number of records

results

object[]

required

Show child attributes

results.id

integer

Variant ID

results.name

string | null

Variant name

Maximum length: 200

results.brand_identifier

string

Brand identifier

Minimum length: 1

results.parent_identifier

string | null

Parent identifier of variant

Maximum length: 100

results.parent_name

string | null

Parent name of variant

Maximum length: 200

results.attributes

object[]

Show child attributes

results.attributes.code

string

required

Attribute code

Required string length: 1 - 200

results.attributes.name

string

required

Attribute name

Required string length: 1 - 200

results.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

results.attributes.id

integer

Attribute ID

results.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

results.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

results.attributes.description

string | null

Attribute description

results.attributes.units

string | null

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

Maximum length: 32

results.attributes.values

object

Show child attributes

results.attributes.values.id

integer

Attribute value ID

results.attributes.values.value

string

Attribute value

results.attributes.values.unit

object

Show child attributes

results.attributes.values.unit.id

integer

Unit ID

results.attributes.values.unit.name

string

Unit name

Minimum length: 1

results.attributes.values.unit.standard_unit

string

Standard unit

Minimum length: 1

results.attributes.values.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

results.attributes.values.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

results.attributes.values.unit.symbol

string | null

Unit symbol

Maximum length: 5

results.attributes.values.retailer

object

Show child attributes

results.attributes.values.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.attributes.values.retailer.code

string

required

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

Required string length: 1 - 32

results.attributes.values.retailer.id

integer

Retailer ID

results.attributes.values.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.attributes.values.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.attributes.values.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.attributes.values.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.attributes.values.retailer.is_rcn_retailer

boolean

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

results.attributes.values.retailer.is_onboarded

boolean

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

results.attributes.values.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.attributes.values.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

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

results.attributes.values.retailer.website

string | null

Website URL

Maximum length: 100

results.attributes.values.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.attributes.values.updated_at

string

Time of update

results.attributes.values.created_at

string

Time of creation

results.brand

object

Show child attributes

results.brand.code

string

required

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

Required string length: 1 - 64

results.brand.id

integer

Vendor (brand) ID

results.brand.name

string

Vendor name

Required string length: 1 - 64

results.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.brand.website

string | null

URL of brand website

Maximum length: 100

results.brand.is_onboarded

boolean

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

results.brand.is_on_rcn

boolean

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

results.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.brand.subscription_is_expired

boolean

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

results.brand.subscription_is_on_grace_period

boolean

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

results.brand.subscription_is_delinquent

boolean

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

results.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.identifier

string | null

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

Maximum length: 128

results.product_id

string

Product ID

results.cartons

object[]

Show child attributes

results.cartons.id

integer

Carton ID

results.cartons.number

integer

Carton number

Required range: -2147483648 < x < 2147483647

results.cartons.length

string | null

Carton length

results.cartons.length_unit

string

Unit of length

results.cartons.width

string | null

Carton width

results.cartons.width_unit

string

Unit of width

results.cartons.height

string | null

Carton height

results.cartons.height_unit

string

Unit of height

results.cartons.weight

string | null

Carton weight

results.cartons.weight_unit

string

Unit of weight

results.cartons.package_girth_inches

string

Girth of the package, in inches

results.cartons.package_size_inches

string

Size of the package, in inches

results.upc

string

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

Maximum length: 64

results.color

string | null

Variant color

Maximum length: 128

results.style

string | null

Variant style

Maximum length: 128

results.size

string | null

Variant size

Maximum length: 128

results.active_permit

object

Show child attributes

results.active_permit.id

integer

Permit ID

results.active_permit.retailer

object

Show child attributes

results.active_permit.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.active_permit.retailer.code

string

required

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

Required string length: 1 - 32

results.active_permit.retailer.id

integer

Retailer ID

results.active_permit.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.active_permit.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.active_permit.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.active_permit.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.active_permit.retailer.is_rcn_retailer

boolean

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

results.active_permit.retailer.is_onboarded

boolean

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

results.active_permit.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.active_permit.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

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

results.active_permit.retailer.website

string | null

Website URL

Maximum length: 100

results.active_permit.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.active_permit.retailer_price

string | null

Retailer price of the variant

results.active_permit.retailer_cost

string | null

Retailer cost of variant

results.active_permit.pricing

object

results.active_permit.attributes

object

results.active_permit.start_at

string | null

Time of permit start (UTC format)

results.active_permit.end_at

string | null

Time of permit end (UTC format)

results.active_permit.is_in_effect

boolean

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

results.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

results.active_permit.is_acknowledged

boolean

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

results.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

results.permits

object[]

Show child attributes

results.permits.id

integer

Permit ID

results.permits.retailer

object

Show child attributes

results.permits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.permits.retailer.code

string

required

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

Required string length: 1 - 32

results.permits.retailer.id

integer

Retailer ID

results.permits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.permits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.permits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.permits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.permits.retailer.is_rcn_retailer

boolean

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

results.permits.retailer.is_onboarded

boolean

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

results.permits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.permits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.permits.retailer.brand_permit_creation_allowed

boolean

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

results.permits.retailer.website

string | null

Website URL

Maximum length: 100

results.permits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.permits.retailer_price

string | null

Retailer price of the variant

results.permits.retailer_cost

string | null

Retailer cost of variant

results.permits.pricing

object

results.permits.attributes

object

results.permits.start_at

string | null

Time of permit start (UTC format)

results.permits.end_at

string | null

Time of permit end (UTC format)

results.permits.is_in_effect

boolean

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

results.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

results.permits.is_acknowledged

boolean

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

results.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

results.permits_count

integer

Count of permits

results.inventory_policy

string

Inventory policy

results.inventory

object

Show child attributes

results.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

results.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

results.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

results.inventory.sellable_updated_at

string

required

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

results.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

results.inventory.discontinued

boolean

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

results.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

results.inventory.inventory

integer

Inventory of variant

results.inventory.sellable

string

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

results.inventory.replenishable

boolean

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

results.inventory.locations

object[]

Show child attributes

results.inventory.locations.id

integer

Location ID

results.inventory.locations.address

object

Show child attributes

results.inventory.locations.address.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.inventory.locations.address.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.inventory.locations.address.city

string

required

City name

Required string length: 1 - 64

results.inventory.locations.address.province

string

required

State name

Required string length: 1 - 32

results.inventory.locations.address.postal_code

string

required

Postal code

Required string length: 1 - 32

results.inventory.locations.address.country

string

required

Country name

Required string length: 1 - 128

results.inventory.locations.address.id

integer

Address ID

results.inventory.locations.address.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.inventory.locations.address.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.inventory.locations.address.street2

string | null

Line 2 of the address

Maximum length: 128

results.inventory.locations.address.phone1

string | null

Primary contact number

Maximum length: 32

results.inventory.locations.address.phone2

string | null

Alternate contact number

Maximum length: 32

results.inventory.locations.address.fax

string | null

Fax number

Maximum length: 32

results.inventory.locations.address.email

string | null

Contact email address

Maximum length: 128

results.inventory.locations.address.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.inventory.locations.inventory

integer

Count of sellable variants

results.inventory.locations.nickname

string

Nickname of location

results.media

object[]

Show child attributes

results.media.id

integer

Variant ID

results.media.width

integer | null

Width of variant image

Required range: -2147483648 < x < 2147483647

results.media.height

integer | null

Height of variant image

Required range: -2147483648 < x < 2147483647

results.media.media

string

Variant images

results.media.priority

integer

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

Required range: -2147483648 < x < 2147483647

results.media.url

string

URL of variant image

results.media.updated_at

string

Time of variant image update (UTC format)

results.media.created_at

string

Time of variant image creation (UTC format)

results.ruleset_variants

object[]

Show child attributes

results.ruleset_variants.id

integer

ID of ruleset variant

results.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

results.ruleset_variants.ruleset

object

Show child attributes

results.ruleset_variants.ruleset.id

integer

ID of ruleset variant

results.ruleset_variants.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

results.ruleset_variants.ruleset.ruleset

object

Show child attributes

results.ruleset_variants.ruleset.ruleset.id

integer

ID of ruleset variant

results.ruleset_variants.ruleset.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

results.ruleset_variants.ruleset.ruleset.ruleset

object

Show child attributes

results.ruleset_variants.ruleset.ruleset.results

string

Response

results.ruleset_variants.ruleset.ruleset.created_at

string

Time of creation (UTC format)

results.ruleset_variants.ruleset.ruleset.updated_at

string

Time of last update (UTC format)

results.ruleset_variants.ruleset.results

string

Response

results.ruleset_variants.ruleset.created_at

string

Time of creation (UTC format)

results.ruleset_variants.ruleset.updated_at

string

Time of last update (UTC format)

results.ruleset_variants.results

string

Response

results.ruleset_variants.created_at

string

Time of creation (UTC format)

results.ruleset_variants.updated_at

string

Time of last update (UTC format)

results.ruleset_variant_summary

string

Summary of ruleset variant

results.is_compatible

string

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

results.proposal_variant

object

Show child attributes

results.proposal_variant.id

integer

Proposal variant ID

results.proposal_variant.pricing

string

Pricing of variant

results.proposal_variant.attributes

object[]

Show child attributes

results.proposal_variant.attributes.id

integer

Attribute value ID

results.proposal_variant.attributes.value

string

Attribute value

results.proposal_variant.attributes.unit

object

Show child attributes

results.proposal_variant.attributes.unit.id

integer

Unit ID

results.proposal_variant.attributes.unit.name

string

Unit name

Minimum length: 1

results.proposal_variant.attributes.unit.standard_unit

string

Standard unit

Minimum length: 1

results.proposal_variant.attributes.unit.type

enum<string>

Unit type

Available options:

area,

distance,

energy,

speed,

temperature,

time,

volume,

weight,

cost

results.proposal_variant.attributes.unit.system

enum<string> | null

Unit system

Available options:

metric,

imperial

results.proposal_variant.attributes.unit.symbol

string | null

Unit symbol

Maximum length: 5

results.proposal_variant.attributes.retailer

object

Show child attributes

results.proposal_variant.attributes.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.proposal_variant.attributes.retailer.code

string

required

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

Required string length: 1 - 32

results.proposal_variant.attributes.retailer.id

integer

Retailer ID

results.proposal_variant.attributes.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.proposal_variant.attributes.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.proposal_variant.attributes.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.proposal_variant.attributes.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.proposal_variant.attributes.retailer.is_rcn_retailer

boolean

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

results.proposal_variant.attributes.retailer.is_onboarded

boolean

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

results.proposal_variant.attributes.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.proposal_variant.attributes.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

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

results.proposal_variant.attributes.retailer.website

string | null

Website URL

Maximum length: 100

results.proposal_variant.attributes.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.proposal_variant.attributes.updated_at

string

Time of update

results.proposal_variant.attributes.created_at

string

Time of creation

results.proposal_variant.memos

object[]

Show child attributes

results.proposal_variant.memos.id

integer

Memo ID

results.proposal_variant.memos.text

string

Memo text

results.proposal_variant.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

results.proposal_variant.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

results.proposal_variant.memos.notify_people

boolean

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

results.proposal_variant.memos.created_by

object

Show child attributes

results.proposal_variant.memos.created_by.id

integer

User ID who accepted or rejected the invoice

results.proposal_variant.memos.created_by.first_name

string | null

First name of user

Maximum length: 64

results.proposal_variant.memos.created_by.last_name

string | null

Last name of user

Maximum length: 64

results.proposal_variant.memos.created_by.title

string | null

User title

Maximum length: 64

results.proposal_variant.memos.created_by.status

enum<string>

User status

Available options:

active,

invited,

locked

results.proposal_variant.memos.created_by.type

enum<string>

User type

Available options:

standard,

api

results.proposal_variant.memos.created_by.photo_url

string

URL of the user photo

Minimum length: 1

results.proposal_variant.memos.created_by.profile_photo

string

URL of the user's profile photo

Minimum length: 1

results.proposal_variant.memos.created_by.is_me

boolean

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

results.proposal_variant.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

results.proposal_variant.memos.created_at

string

Time of memo creation (UTC format)

results.proposal_variant.memos.updated_at

string

Time of memo update (UTC format)

results.proposal_variant.issues

object[]

Show child attributes

results.proposal_variant.issues.id

integer

Issue ID

results.proposal_variant.issues.memos

object[]

Show child attributes

results.proposal_variant.issues.memos.id

integer

Memo ID

results.proposal_variant.issues.memos.text

string

Memo text

results.proposal_variant.issues.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

results.proposal_variant.issues.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

results.proposal_variant.issues.memos.notify_people

boolean

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

results.proposal_variant.issues.memos.created_by

object

Show child attributes

results.proposal_variant.issues.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

results.proposal_variant.issues.memos.created_at

string

Time of memo creation (UTC format)

results.proposal_variant.issues.memos.updated_at

string

Time of memo update (UTC format)

results.proposal_variant.issues.created_at

string

Time of issue creation

results.proposal_variant.issues.updated_at

string

Time of issue update

results.proposal_variant.issues.resolved_at

string

Time of issue resolution

results.proposal_variant.issues.is_resolved

string

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

results.proposal_variant.issues.issue_id

integer

Issue ID

results.proposal_variant.issues.message

string

Description or note related to issue

Minimum length: 1

results.proposal_variant.issues.title

string

Issue title

Minimum length: 1

results.proposal_variant.variant_id

integer

Variant ID

results.proposal_variant.approved_at

string | null

Time of approval (UTC format)

results.proposal_variant.created_at

string

Time of creation (UTC format)

results.proposal_variant.updated_at

string

Time of last update (UTC format)

results.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

results.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

results.proposal_variant.reject

boolean

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

results.proposal_variant.approve

boolean

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

results.proposal_variant.delete

boolean

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

results.retailer_identifiers

object[]

Show child attributes

results.retailer_identifiers.id

integer

Retailer ID

results.retailer_identifiers.retailer

object

Show child attributes

results.retailer_identifiers.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.retailer_identifiers.retailer.code

string

required

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

Required string length: 1 - 32

results.retailer_identifiers.retailer.id

integer

Retailer ID

results.retailer_identifiers.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.retailer_identifiers.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.retailer_identifiers.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.retailer_identifiers.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.retailer_identifiers.retailer.is_rcn_retailer

boolean

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

results.retailer_identifiers.retailer.is_onboarded

boolean

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

results.retailer_identifiers.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.retailer_identifiers.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

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

results.retailer_identifiers.retailer.website

string | null

Website URL

Maximum length: 100

results.retailer_identifiers.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.retailer_identifiers.identifier

string | null

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

Maximum length: 256

results.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

results.retailer_categories

object

Show child attributes

results.retailer_categories.category

string

required

Category name

Required string length: 1 - 256

results.retailer_categories.id

integer

Retailer category ID

results.retailer_categories.retailer

object

Show child attributes

results.retailer_categories.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.retailer_categories.retailer.code

string

required

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

Required string length: 1 - 32

results.retailer_categories.retailer.id

integer

Retailer ID

results.retailer_categories.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.retailer_categories.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.retailer_categories.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.retailer_categories.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.retailer_categories.retailer.is_rcn_retailer

boolean

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

results.retailer_categories.retailer.is_onboarded

boolean

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

results.retailer_categories.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.retailer_categories.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

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

results.retailer_categories.retailer.website

string | null

Website URL

Maximum length: 100

results.retailer_categories.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

next

string | null

Next page (applicable in a paginated response)

previous

string | null

Previous page (applicable in a paginated response)