Get a list of variant inventory positions

Get variants and their inventory details, including total inventory and inventory based on location.To get items with inventory updated since a Unix epoch Time, pass the updated_at_{operator} as a query paramater, where {operator} is
lt (less than)
lte (less than or equal)
gt (greater than)
gte (greater than or equal).

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

Retailer ID

Query Parameters

identifier

string

Unique identifier assigned to the variant by the brand

brand_id

integer[]

Brand ID. Multiple values may be separated by commas

connection_id

number

Connection ID. Multiple values may be separated by comma.

parent_identifier

string[]

Parent product identifier. Multiple values may be separated by commas

retailer_sku

string

Retailer SKU

in_stock

integer

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

ignore_deleted

integer

1: Ignore deleted variant <br /> 0: Include deleted variant

is_sellable

integer

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

is_discontinued

integer

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

no_ead

integer

1: Variant has no estimated availability date <br /> 0: Variant has estimated delivery date

no_stock_no_ead

number

1: Variant does not have an estimated availability date. <br /> 0: Variant has an estimated availability

inventory_updated_at_lt

number

Inventory update was less than specified Time (Unix epoch format)

inventory_updated_at_lte

number

Inventory update was less than or equal to specified Time (Unix epoch format) Time

inventory_updated_at_gt

number

Inventory update was greater than specified Time (Unix epoch format)

inventory_updated_at_gte

number

Inventory update was greater than or equal to a specified Time (Unix epoch format)

order_by

string

Sorting criteria

page

integer

Page number within the paginated result set

limit

integer

Number of records per page

Response

200 - application/json

count

integer

required

Total number of records

results

object[]

required

Show child attributes

results.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

results.estimated_availability_date

string

required

Estimated availability date of variant

Minimum length: 1

results.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

results.inventory_updated_at

string

required

Time of inventory update (UTC format)

results.sellable_updated_at

string

required

Time variant was marked sellable (UTC format)

results.discontinued

boolean

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

results.discontinued_updated_at

string

Time variant marked discontinued (UTC format)

results.inventory

integer

Count of variant available for sale

results.inventory_policy

enum<string>

Represents whether vendor wants to manage the inventory or not

Available options:

unmanaged,

managed

results.locations

object[]

Show child attributes

results.locations.address

object

Show child attributes

results.locations.address.city

string

required

City name

Required string length: 1 - 64

results.locations.address.country

string

required

Country name

Required string length: 1 - 128

results.locations.address.name1

string

required

Name of the primary contact?

Required string length: 1 - 64

results.locations.address.postal_code

string

required

Postal code

Required string length: 1 - 32

results.locations.address.province

string

required

State name

Required string length: 1 - 32

results.locations.address.street1

string

required

Line 1 of the address

Required string length: 1 - 128

results.locations.address.email

string | null

Contact email address

Maximum length: 128

results.locations.address.fax

string | null

Fax number

Maximum length: 32

results.locations.address.federal_tax_id

string | null

Federal tax ID

Maximum length: 32

results.locations.address.id

integer

Address ID

results.locations.address.name2

string | null

Name of the alternative contact?

Maximum length: 64

results.locations.address.phone1

string | null

Primary contact number

Maximum length: 32

results.locations.address.phone2

string | null

Alternate contact number

Maximum length: 32

results.locations.address.street2

string | null

Line 2 of the address

Maximum length: 128

results.locations.address.type

enum<string> | null

Type of address

Available options:

residential,

commercial

results.locations.id

integer

Location ID

results.locations.inventory

integer

Count of sellable variants

results.locations.nickname

string

Nickname of location

results.replenishable

boolean

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

results.sellable

string

true: Variant is sellable <br /> false: Variant is not sellable

results.variant

object

Show child attributes

results.variant.active_permit

object

Show child attributes

results.variant.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

results.variant.active_permit.attributes

object

results.variant.active_permit.end_at

string | null

Time of permit end (UTC format)

results.variant.active_permit.id

integer

Permit ID

results.variant.active_permit.is_acknowledged

boolean

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

results.variant.active_permit.is_in_effect

boolean

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

results.variant.active_permit.pricing

object

results.variant.active_permit.retailer

object

Show child attributes

results.variant.active_permit.retailer.code

string

required

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

Required string length: 1 - 32

results.variant.active_permit.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.variant.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.variant.active_permit.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.variant.active_permit.retailer.id

integer

Retailer ID

results.variant.active_permit.retailer.is_onboarded

boolean

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

results.variant.active_permit.retailer.is_rcn_retailer

boolean

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

results.variant.active_permit.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.variant.active_permit.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.variant.active_permit.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.variant.active_permit.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.variant.active_permit.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.variant.active_permit.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.variant.active_permit.retailer.website

string | null

Website URL

Maximum length: 100

results.variant.active_permit.retailer_cost

string | null

Retailer cost of variant

results.variant.active_permit.retailer_price

string | null

Retailer price of the variant

results.variant.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

results.variant.active_permit.start_at

string | null

Time of permit start (UTC format)

results.variant.attributes

object[]

Show child attributes

results.variant.attributes.code

string

required

Attribute code

Required string length: 1 - 200

results.variant.attributes.name

string

required

Attribute name

Required string length: 1 - 200

results.variant.attributes.type

enum<string>

required

Attribute type

Available options:

boolean,

date,

list,

media,

money,

number,

percent,

string,

text,

url

results.variant.attributes.description

string | null

Attribute description

results.variant.attributes.editable_by

enum<string> | null

User permission to edit attribute

Available options:

retailer,

brand,

any,

none

results.variant.attributes.grouping

enum<string> | null

Criteria to group attribute

Available options:

description,

general,

images,

inventory,

misc,

retailer,

shipping,

identifiers,

pricing

results.variant.attributes.id

integer

Attribute ID

results.variant.attributes.units

string | null

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

Maximum length: 32

results.variant.attributes.values

object

Show child attributes

results.variant.attributes.values.created_at

string

Time of creation

results.variant.attributes.values.id

integer

Attribute value ID

results.variant.attributes.values.retailer

object

Show child attributes

results.variant.attributes.values.unit

object

Show child attributes

results.variant.attributes.values.updated_at

string

Time of update

results.variant.attributes.values.value

string

Attribute value

results.variant.brand

object

Show child attributes

results.variant.brand.code

string

required

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

Required string length: 1 - 64

results.variant.brand.cover_url

string

URL of the cover image

Minimum length: 1

results.variant.brand.grace_period_ends_at

string | null

Time of grace period expiration (UTC format)

results.variant.brand.id

integer

Vendor (brand) ID

results.variant.brand.inventory_policy

enum<string>

Inventory policy

Available options:

unmanaged,

managed,

use_variant_policy

results.variant.brand.is_on_rcn

boolean

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

results.variant.brand.is_onboarded

boolean

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

results.variant.brand.joined_at

string

Time when vendor joined Dropship (UTC format)

results.variant.brand.logo_url

string

URL of the brand logo

Minimum length: 1

results.variant.brand.name

string

Vendor name

Required string length: 1 - 64

results.variant.brand.profile_tile_url

string

URL of the profile image

Minimum length: 1

results.variant.brand.requires_subscription

enum<string>

Represents whether subscription is required

Available options:

disabled,

enabled,

upcoming

results.variant.brand.status

enum<string>

Vendor status

Available options:

active,

pending,

inactive

results.variant.brand.subscription_expires_at

string | null

Subscription expiry Time (UTC format)

results.variant.brand.subscription_is_delinquent

boolean

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

results.variant.brand.subscription_is_expired

boolean

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

results.variant.brand.subscription_is_on_grace_period

boolean

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

results.variant.brand.website

string | null

URL of brand website

Maximum length: 100

results.variant.brand_identifier

string

Unique SKU assigned by the Brand

Minimum length: 1

results.variant.cartons

object[]

Show child attributes

results.variant.cartons.height

string | null

Carton height

results.variant.cartons.height_unit

string

Unit of height

results.variant.cartons.id

integer

Carton ID

results.variant.cartons.length

string | null

Carton length

results.variant.cartons.length_unit

string

Unit of length

results.variant.cartons.number

integer

Carton number

Required range: -2147483648 < x < 2147483647

results.variant.cartons.package_girth_inches

string

Girth of the package, in inches

results.variant.cartons.package_size_inches

string

Size of the package, in inches

results.variant.cartons.weight

string | null

Carton weight

results.variant.cartons.weight_unit

string

Unit of weight

results.variant.cartons.width

string | null

Carton width

results.variant.cartons.width_unit

string

Unit of width

results.variant.color

string | null

Color of the item (from attributes.color)

Maximum length: 128

results.variant.id

integer

Variant ID

results.variant.identifier

string | null

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

Maximum length: 128

results.variant.inventory

object

Show child attributes

results.variant.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

results.variant.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

results.variant.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

results.variant.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

results.variant.inventory.sellable_updated_at

string

required

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

results.variant.inventory.discontinued

boolean

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

results.variant.inventory.discontinued_updated_at

string

Time of when product inventory was discontinued (UTC format)

results.variant.inventory.inventory

integer

Inventory of variant

results.variant.inventory.locations

object[]

Show child attributes

results.variant.inventory.locations.address

object

Show child attributes

results.variant.inventory.locations.id

integer

Location ID

results.variant.inventory.locations.inventory

integer

Count of sellable variants

results.variant.inventory.locations.nickname

string

Nickname of location

results.variant.inventory.replenishable

boolean

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

results.variant.inventory.sellable

string

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

results.variant.is_compatible

boolean

true: variant meets requirement <br /> false: variant doesn not meet requirement

results.variant.media

object[]

Show child attributes

results.variant.media.created_at

string

Time of variant image creation (UTC format)

results.variant.media.height

integer | null

Height of variant image

Required range: -2147483648 < x < 2147483647

results.variant.media.id

integer

Variant ID

results.variant.media.media

string

Variant images

results.variant.media.priority

integer

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

Required range: -2147483648 < x < 2147483647

results.variant.media.updated_at

string

Time of variant image update (UTC format)

results.variant.media.url

string

URL of variant image

results.variant.media.width

integer | null

Width of variant image

Required range: -2147483648 < x < 2147483647

results.variant.name

string | null

Variant Name

Maximum length: 200

results.variant.permits

object[]

Show child attributes

results.variant.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

results.variant.permits.attributes

object

results.variant.permits.end_at

string | null

Time of permit end (UTC format)

results.variant.permits.id

integer

Permit ID

results.variant.permits.is_acknowledged

boolean

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

results.variant.permits.is_in_effect

boolean

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

results.variant.permits.pricing

object

results.variant.permits.retailer

object

Show child attributes

results.variant.permits.retailer.code

string

required

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

Required string length: 1 - 32

results.variant.permits.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.variant.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.variant.permits.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.variant.permits.retailer.id

integer

Retailer ID

results.variant.permits.retailer.is_onboarded

boolean

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

results.variant.permits.retailer.is_rcn_retailer

boolean

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

results.variant.permits.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.variant.permits.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.variant.permits.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.variant.permits.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.variant.permits.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.variant.permits.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.variant.permits.retailer.website

string | null

Website URL

Maximum length: 100

results.variant.permits.retailer_cost

string | null

Retailer cost of variant

results.variant.permits.retailer_price

string | null

Retailer price of the variant

results.variant.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

results.variant.permits.start_at

string | null

Time of permit start (UTC format)

results.variant.proposal_variant

object

Show child attributes

results.variant.proposal_variant.approve

boolean

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

results.variant.proposal_variant.approved_at

string | null

Time of approval (UTC format)

results.variant.proposal_variant.attributes

object[]

Show child attributes

results.variant.proposal_variant.attributes.created_at

string

Time of creation

results.variant.proposal_variant.attributes.id

integer

Attribute value ID

results.variant.proposal_variant.attributes.retailer

object

Show child attributes

results.variant.proposal_variant.attributes.unit

object

Show child attributes

results.variant.proposal_variant.attributes.updated_at

string

Time of update

results.variant.proposal_variant.attributes.value

string

Attribute value

results.variant.proposal_variant.created_at

string

Time of creation (UTC format)

results.variant.proposal_variant.delete

boolean

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

results.variant.proposal_variant.id

integer

Proposal variant ID

results.variant.proposal_variant.issues

object[]

Show child attributes

results.variant.proposal_variant.issues.created_at

string

Time of issue creation

results.variant.proposal_variant.issues.id

integer

Issue ID

results.variant.proposal_variant.issues.is_resolved

string

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

results.variant.proposal_variant.issues.issue_id

integer

Issue ID

results.variant.proposal_variant.issues.memos

object[]

Show child attributes

results.variant.proposal_variant.issues.message

string

Description or note related to issue

Minimum length: 1

results.variant.proposal_variant.issues.resolved_at

string

Time of issue resolution

results.variant.proposal_variant.issues.title

string

Issue title

Minimum length: 1

results.variant.proposal_variant.issues.updated_at

string

Time of issue update

results.variant.proposal_variant.memos

object[]

Show child attributes

results.variant.proposal_variant.memos.acknowledged_at

string

Time memo acknowledgement (UTC format)

results.variant.proposal_variant.memos.created_at

string

Time of memo creation (UTC format)

results.variant.proposal_variant.memos.created_by

object

Show child attributes

results.variant.proposal_variant.memos.created_by_context

enum<string> | null

Represents whether memo is created by retailer or brand?

Available options:

retailer,

brand

results.variant.proposal_variant.memos.id

integer

Memo ID

results.variant.proposal_variant.memos.notify_people

boolean

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

results.variant.proposal_variant.memos.text

string

Memo text

results.variant.proposal_variant.memos.updated_at

string

Time of memo update (UTC format)

results.variant.proposal_variant.memos.visibility

enum<string>

Memo visibility

Available options:

any,

retailer,

brand

results.variant.proposal_variant.pricing

string

Pricing of variant

results.variant.proposal_variant.reject

boolean

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

results.variant.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

results.variant.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

results.variant.proposal_variant.updated_at

string

Time of last update (UTC format)

results.variant.proposal_variant.variant_id

integer

Variant ID

results.variant.retailer_categories

object

Show child attributes

results.variant.retailer_categories.category

string

required

Category name

Required string length: 1 - 256

results.variant.retailer_categories.id

integer

Retailer category ID

results.variant.retailer_categories.retailer

object

Show child attributes

results.variant.retailer_categories.retailer.code

string

required

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

Required string length: 1 - 32

results.variant.retailer_categories.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.variant.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.variant.retailer_categories.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.variant.retailer_categories.retailer.id

integer

Retailer ID

results.variant.retailer_categories.retailer.is_onboarded

boolean

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

results.variant.retailer_categories.retailer.is_rcn_retailer

boolean

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

results.variant.retailer_categories.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.variant.retailer_categories.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.variant.retailer_categories.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.variant.retailer_categories.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.variant.retailer_categories.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.variant.retailer_categories.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.variant.retailer_categories.retailer.website

string | null

Website URL

Maximum length: 100

results.variant.retailer_identifiers

object

Show child attributes

results.variant.retailer_identifiers.id

integer

Retailer ID

results.variant.retailer_identifiers.identifier

string | null

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

Maximum length: 256

results.variant.retailer_identifiers.name

string | null

Retailer name

Maximum length: 256

results.variant.retailer_identifiers.retailer

object

Show child attributes

results.variant.retailer_identifiers.retailer.code

string

required

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

Required string length: 1 - 32

results.variant.retailer_identifiers.retailer.name

string

required

Retailer name

Required string length: 1 - 64

results.variant.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.variant.retailer_identifiers.retailer.cover_url

string

URL of retailer cover image

Minimum length: 1

results.variant.retailer_identifiers.retailer.id

integer

Retailer ID

results.variant.retailer_identifiers.retailer.is_onboarded

boolean

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

results.variant.retailer_identifiers.retailer.is_rcn_retailer

boolean

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

results.variant.retailer_identifiers.retailer.joined_at

string

Time of retailer joining Dropship (UTC format)

results.variant.retailer_identifiers.retailer.logo_url

string

URL of retailer logo

Minimum length: 1

results.variant.retailer_identifiers.retailer.platform

enum<string>

Platform on which retailer is onboarded

Available options:

fabric

results.variant.retailer_identifiers.retailer.profile_tile_url

string

URL of retailer profile image

Minimum length: 1

results.variant.retailer_identifiers.retailer.requires_subscription

enum<string>

Represent whether retailer requires subscription to use the platform

Available options:

disabled,

enabled,

upcoming

results.variant.retailer_identifiers.retailer.status

enum<string>

Retailer status

Available options:

active,

setup,

ghost

results.variant.retailer_identifiers.retailer.website

string | null

Website URL

Maximum length: 100

results.variant.ruleset_variant_summary

string

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

results.variant.ruleset_variants

object[]

Show child attributes

results.variant.ruleset_variants.created_at

string

Time of creation (UTC format)

results.variant.ruleset_variants.id

integer

ID of ruleset variant

results.variant.ruleset_variants.results

string

Response

results.variant.ruleset_variants.ruleset

object

Show child attributes

results.variant.ruleset_variants.ruleset.created_at

string

Time of creation (UTC format)

results.variant.ruleset_variants.ruleset.id

integer

ID of ruleset variant

results.variant.ruleset_variants.ruleset.results

string

Response

results.variant.ruleset_variants.ruleset.ruleset

object

Show child attributes

results.variant.ruleset_variants.ruleset.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

results.variant.ruleset_variants.ruleset.updated_at

string

Time of last update (UTC format)

results.variant.ruleset_variants.status

enum<string>

Status of ruleset variant

Available options:

processing,

passed,

failed

results.variant.ruleset_variants.updated_at

string

Time of last update (UTC format)

results.variant.size

string | null

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

Maximum length: 128

results.variant.style

string | null

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

Maximum length: 128

results.variant.upc

string

UPC or other GTIN

Maximum length: 64

next

string | null

Next page (applicable in a paginated response)

previous

string | null

Previous page (applicable in a paginated response)