Authentication v1
- Identity APIs
- User
- Address
- Auth
User Self Service APIs
- Introduction
- User Self Service APIs
- Authentication APIs
Experiences v2 (XM v2)
- XM
- Pages
- Global Components
- Menu
Experiences v1 (XM v1)
- XM
- Pages
- Global Components
- Menu
Product Catalog
- Product Catalog
- Category
- Product
- Attributes
- Bulk Import
Orders v2 (OMS v2)
- Order Management System
- Order
- Order Attribute
- Developer Guide
- Order Return
- Payment Status
- Package Tracking
- Cross Border
- Order Cancellation
- Appeasement
- Allocation
- Configuration
- Fraud Configuration
- Target Configuration
- Location
- Location Attribute
- Inventory Network
- Inventory
- Inventory Counter
- Inventory Bulk Operation
- Inventory Attribute
- Inventory Upload Log
- Shipment
- Shipping Method
- Webhook
- Notification
- Export
- Invoice
- Fraud
- Backorder Preorder Reservation
- List
Orders v1 (OMS v1)
- Order Management System
- Cart
- Bill To
- Ship To
- Wishlist
- Cart Decoupled
- Warehouse
- Inventory
- Attributes
- List
- Tax/Address Validate
- Shipping
- Payments
- Order
Offers v2
- Offers
- Developer Guide
- Promotion
- Price Kind
- Dynamic Pricing Engine
- Segment
- Coupon
- Coupon Codes
- Product
- Price List
- Attributes
- Item
- Price Guard
- Global Exclusion
- Upload Price CSV
- Pricing
- Redemption
- Exports
Offers v1
- Offers
- Login API
- Promotions
- Pricing
Subscriptions (SMT API)
- Subscriptions API
- Cancellation Reasons
- Subscription Discounts
- Subscriptions
- Subscribers
- Orders
Loyalty (Member)
- Member APIs
- Inquire
- Discounts
- Redeem
- Earn
- Members
Dropship
- Dropship API
- Shipments
- Products
- Invoices
- Connections
- Inventory
- Developer Guide
- Returns
- Orders
Cart API
- Cart
- Order Draft
- Attribute
- Adjustments
- Shipping
- Cart
Checkout API
- Checkout
- Checkout
Customer
- Core Concepts
- Customer Service
- Organization
- User Party
- Organization Group Addresses
- User Internal Party
- Organization Contracts
- Party
- Party Contracts
- Contracts
- User
- Search
- User Trait
- Organization Users
- Address
- User Address
- Trait
- Party Address
- Party Trait
- Organization Group Users
- Internal Party
- Contract Pricelist
- Internal Parties Party
- Account
- Party Account
- Organization Addresses
- Organization Groups
- Individual Addresses
- Users Organization
- Individual
Get variants
Gets variants
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Inventory updated date is less than specified date (Unix epoch format)
Inventory updated date is less than or equal to specified date (Unix epoch format)
Inventory updated date is greater than specified date (Unix epoch format)
Inventory updated date is greater than or equal to specified date (Unix epoch format)
Search criteria
Search ID
Search name
Search by UPC
Search by SKUs
Retailer SKUs
Product attribute
Retailer ID
Vendor Ids. Multiple values may be separated by commas.
Brand codes. Multiple values may be separated by commas.
Manufacturer IDs. Multiple values may be separated by commas.
Manufacturer codes. Multiple values may be separated by commas.
Failed rule ID
Rule ID
Ruleset ID
Failure type
Taxonomy ID
Retailer category. Multiple values may be added, separated by commas.
Retailer category IDs
Connection ID
Product IDs. Multiple values may be separated by commas.
Parent identifiers. Multiple values may be separated by commas.
1: Variant is replenishable <br /> 0: Variant is not replenishable
1: Variant is discontinued <br /> 0: Variant is not discontinued
1: Variant is sellable <br /> 0: Variant is not sellable
1: Variant is in stock <br /> 0: Variant is out of stock
1: Variant has images <br /> 0: Variant does not have images.
1: Variant has shipping <br /> 0: Variant does not have shipping.
Sorting preference
Page number within the paginated result set
Number of records per page
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Inventory updated date is less than specified date (Unix epoch format)
Inventory updated date is less than or equal to specified date (Unix epoch format)
Inventory updated date is greater than specified date (Unix epoch format)
Inventory updated date is greater than or equal to specified date (Unix epoch format)
Search criteria
Search ID
Search name
Search by UPC
Search by SKUs
Retailer SKUs
Product attribute
Retailer ID
Vendor Ids. Multiple values may be separated by commas.
Brand codes. Multiple values may be separated by commas.
Manufacturer IDs. Multiple values may be separated by commas.
Manufacturer codes. Multiple values may be separated by commas.
Failed rule ID
Rule ID
Ruleset ID
Failure type
Taxonomy ID
Retailer category. Multiple values may be added, separated by commas.
Retailer category IDs
Connection ID
Product IDs. Multiple values may be separated by commas.
Parent identifiers. Multiple values may be separated by commas.
1: Variant is replenishable <br /> 0: Variant is not replenishable
1: Variant is discontinued <br /> 0: Variant is not discontinued
1: Variant is sellable <br /> 0: Variant is not sellable
1: Variant is in stock <br /> 0: Variant is out of stock
1: Variant has images <br /> 0: Variant does not have images.
1: Variant has shipping <br /> 0: Variant does not have shipping.
Sorting preference
Page number within the paginated result set
Number of records per page
Response
Total number of records
Variant ID
Variant name
200Brand identifier
1Parent identifier of variant
100Parent name of variant
200Attribute ID
Attribute code
1 - 200Attribute name
1 - 200User permission to edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute description
Attribute type
boolean, date, list, media, money, number, percent, string, text, url Unit of the selected attribute type. If the attribute type is money, the unit is USD.
32Attribute value ID
Attribute value
Unit ID
Unit name
1Standard unit
1Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Unit system
metric, imperial Unit symbol
5Retailer name
1 - 64Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer ID
URL of retailer logo
1URL of retailer cover image
1URL of retailer profile image
1Time of retailer joining Dropship (UTC format)
true: Retailer is in Dropship network; Retailer is not in Dropship network
true: Retailer is onboarded <br /> false: Retailer is not onboarded
Platform on which retailer is onboarded
fabric Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
Website URL
100Retailer status
active, setup, ghost Time of update
Time of creation
Vendor code, which is vendor name in lower case and underscore
1 - 64Vendor (brand) ID
Vendor name
1 - 64Time when vendor joined Dropship (UTC format)
URL of the brand logo
1URL of the cover image
1URL of the profile image
1URL of brand website
100true: Vendor is onboarded <br /> false: Vendor is not onboarded
true: is on Dropship network <br /> false: not on Dropship network
Represents whether subscription is required
disabled, enabled, upcoming Subscription expiry Time (UTC format)
Time of grace period expiration (UTC format)
true: subscription is expired <br /> false: subscription is active
true: subscription is on grace period <br /> false: subscription is not on grace period
true: subscription is overdue <br /> false: subscription is paid
Inventory policy
unmanaged, managed, use_variant_policy Vendor status
active, pending, inactive Stock Keeping Unit (SKU), unique identifier of a product
128Product ID
Carton ID
Carton number
-2147483648 < x < 2147483647Carton length
Unit of length
Carton width
Unit of width
Carton height
Unit of height
Carton weight
Unit of weight
Girth of the package, in inches
Size of the package, in inches
Universal product code (UPC) is a 12-digit combination of numbers assigned to each product in your dropshipping store.
64Variant color
128Variant style
128Variant size
128Permit ID
Retailer name
1 - 64Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer ID
URL of retailer logo
1URL of retailer cover image
1URL of retailer profile image
1Time of retailer joining Dropship (UTC format)
true: Retailer is in Dropship network; Retailer is not in Dropship network
true: Retailer is onboarded <br /> false: Retailer is not onboarded
Platform on which retailer is onboarded
fabric Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
Website URL
100Retailer status
active, setup, ghost Retailer price of the variant
Retailer cost of variant
Time of permit start (UTC format)
Time of permit end (UTC format)
true: permit is in effect <br /> false: permit is not in effect
Time when permit got revoked (UTC format)
true: permit is acknowledged <br /> false: permit is not acknowledged
Time of acknowledgement (UTC format)
Permit ID
Retailer name
1 - 64Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer ID
URL of retailer logo
1URL of retailer cover image
1URL of retailer profile image
1Time of retailer joining Dropship (UTC format)
true: Retailer is in Dropship network; Retailer is not in Dropship network
true: Retailer is onboarded <br /> false: Retailer is not onboarded
Platform on which retailer is onboarded
fabric Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
Website URL
100Retailer status
active, setup, ghost Retailer price of the variant
Retailer cost of variant
Time of permit start (UTC format)
Time of permit end (UTC format)
true: permit is in effect <br /> false: permit is not in effect
Time when permit got revoked (UTC format)
true: permit is acknowledged <br /> false: permit is not acknowledged
Time of acknowledgement (UTC format)
Count of permits
Inventory policy
Time of inventory update (UTC format)
Time of inventory submit (UTC format)
Time of vendor inventory update (UTC format)
Time when product or variant was marked sellable (UTC format)
Estimated delivery date (UTC format)
1true: Product is discontinued <br /> false: Product is active
Time of when product inventory was discontinued (UTC format)
Inventory of variant
yes: Variant is sellable <br /> No: Variant is not sellable
true: product is replenishable <br /> false: product is not replenishable
Location ID
Name of the primary contact?
1 - 64Line 1 of the address
1 - 128City name
1 - 64State name
1 - 32Postal code
1 - 32Country name
1 - 128Address ID
Type of address
residential, commercial Name of the alternative contact?
64Line 2 of the address
128Primary contact number
32Alternate contact number
32Fax number
32Contact email address
128Federal tax ID
32Count of sellable variants
Nickname of location
Variant ID
Width of variant image
-2147483648 < x < 2147483647Height of variant image
-2147483648 < x < 2147483647Variant images
Order in which the vendor prefers the images to be shown image 1 is shown first.
-2147483648 < x < 2147483647URL of variant image
Time of variant image update (UTC format)
Time of variant image creation (UTC format)
ID of ruleset variant
Status of ruleset variant
processing, passed, failed ID of ruleset variant
Status of ruleset variant
processing, passed, failed ID of ruleset variant
Status of ruleset variant
processing, passed, failed Response
Time of creation (UTC format)
Time of last update (UTC format)
Response
Time of creation (UTC format)
Time of last update (UTC format)
Response
Time of creation (UTC format)
Time of last update (UTC format)
Summary of ruleset variant
true: variant is compatible <br /> false: variant is not compatible
Proposal variant ID
Pricing of variant
Attribute value ID
Attribute value
Unit ID
Unit name
1Standard unit
1Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Unit system
metric, imperial Unit symbol
5Retailer name
1 - 64Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer ID
URL of retailer logo
1URL of retailer cover image
1URL of retailer profile image
1Time of retailer joining Dropship (UTC format)
true: Retailer is in Dropship network; Retailer is not in Dropship network
true: Retailer is onboarded <br /> false: Retailer is not onboarded
Platform on which retailer is onboarded
fabric Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
Website URL
100Retailer status
active, setup, ghost Time of update
Time of creation
Memo ID
Memo text
Memo visibility
any, retailer, brand Time memo acknowledgement (UTC format)
true: notify stakeholders <br /> false: do not notify
User ID who accepted or rejected the invoice
First name of user
64Last name of user
64User title
64User status
active, invited, locked User type
standard, api URL of the user photo
1URL of the user's profile photo
1true: user is me: <br /> false: user is not me
Represents whether memo is created by retailer or brand?
retailer, brand Time of memo creation (UTC format)
Time of memo update (UTC format)
Issue ID
Memo ID
Memo text
Memo visibility
any, retailer, brand Time memo acknowledgement (UTC format)
true: notify stakeholders <br /> false: do not notify
Represents whether memo is created by retailer or brand?
retailer, brand Time of memo creation (UTC format)
Time of memo update (UTC format)
Time of issue creation
Time of issue update
Time of issue resolution
true: Issue is resolved <br /> false: Issue is not resolved
Issue ID
Description or note related to issue
1Issue title
1Variant ID
Time of approval (UTC format)
Time of creation (UTC format)
Time of last update (UTC format)
Time of proposal rejection (UTC format)
Rejection reason
32true: proposal is rejected <br /> false: proposal is not rejected
true: proposal is approved <br /> false: proposal is not approved
true: proposal is deleted <br /> false: proposal is not deleted
Retailer ID
Retailer name
1 - 64Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer ID
URL of retailer logo
1URL of retailer cover image
1URL of retailer profile image
1Time of retailer joining Dropship (UTC format)
true: Retailer is in Dropship network; Retailer is not in Dropship network
true: Retailer is onboarded <br /> false: Retailer is not onboarded
Platform on which retailer is onboarded
fabric Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
Website URL
100Retailer status
active, setup, ghost Stock Keeping Unit (SKU), unique identifier of a product
256Retailer name
256Category name
1 - 256Retailer category ID
Retailer name
1 - 64Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer ID
URL of retailer logo
1URL of retailer cover image
1URL of retailer profile image
1Time of retailer joining Dropship (UTC format)
true: Retailer is in Dropship network; Retailer is not in Dropship network
true: Retailer is onboarded <br /> false: Retailer is not onboarded
Platform on which retailer is onboarded
fabric Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
Website URL
100Retailer status
active, setup, ghost Next page (applicable in a paginated response)
Previous page (applicable in a paginated response)
Was this page helpful?