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 single product details
Gets the details for a specified product.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Attribute code
1 - 200Attribute name
1 - 200Attribute type
boolean, date, list, media, money, number, percent, string, text, url Attribute description
User permission to edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute ID
Unit of the selected attribute type. If the attribute type is money, the unit is USD.
32Time of creation
Attribute value ID
Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer name
1 - 64true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
URL of retailer cover image
1Retailer ID
true: Retailer is onboarded <br /> false: Retailer is not onboarded
true: Retailer is in Dropship network; Retailer is not in Dropship network
Time of retailer joining Dropship (UTC format)
URL of retailer logo
1Platform on which retailer is onboarded
fabric URL of retailer profile image
1Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming Retailer status
active, setup, ghost Website URL
100Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Time of update
Attribute value
Brand category
1 - 64Brand name
1 - 64Time of product creation in Dropship
Product description
product ID
Time of creation
Product ID
Message added while publishing, for future reference
Brand name
Credentials to use account
Platform account ID
Platform name
Retailer name
Stock Keeping Unit (SKU), unique identifier of a product
1 - 128Brand category
1 - 64Brand name
1 - 64Time of product creation in Dropship
Product description
Time of expiry (UTC format)
Product ID
Product name
200Number of product variants
Parent identifier
1Parent name
1Product pricing
Time of product image creation
Product image height
-2147483648 < x < 2147483647Product image ID
Product image media
Image priority
-2147483648 < x < 2147483647Time of when product image was last updated
Product image URL
Product image width
-2147483648 < x < 2147483647Time of when product was first published
Status of product in Dropship
not_published, pending, failed, expired, published Time of when product was last updated in Dropship
true: product published <br /> false: product is not published
Manufacturer code
1 - 32URL of manufacturer's cover image
1Manufacturer ID
URL of manufacturer's logo
1Manufacturer name
1 - 64URL of manufacturer's profile image
1A universally unique identifier (UUID)
36URL of manufacturer website
100Time of variant image creation (UTC format)
Height of variant image
-2147483648 < x < 2147483647Variant ID
Variant images
Order in which the vendor prefers the images to be shown image 1 is shown first.
-2147483648 < x < 2147483647Time of variant image update (UTC format)
URL of variant image
Width of variant image
-2147483648 < x < 2147483647Number of variants
ID of parent product
1Parent name
1Attribute code
1 - 200Attribute name
1 - 200Attribute type
boolean, date, list, media, money, number, percent, string, text, url Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Attribute description
User who can edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute ID
true: allow bulk edit of attributes <br /> false: bulk edit of attributes are not allowed
Attribute priority
0 < x < 4294967295Unity based on type
32Time of product image creation
Product image height
-2147483648 < x < 2147483647Product image ID
Product image media
Image priority
-2147483648 < x < 2147483647Time of when product image was last updated
Product image URL
Product image width
-2147483648 < x < 2147483647Status of product in Dropship network
not_published, pending, failed, expired, published Taxonomy code
1 - 32Taxonomy ID
Taxonomy name
1 - 64Number of children
Attribute code
1 - 200Attribute name
1 - 200Attribute type
boolean, date, list, media, money, number, percent, string, text, url Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Attribute description
User who can edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute ID
true: allow bulk edit of attributes <br /> false: bulk edit of attributes are not allowed
Attribute priority
0 < x < 4294967295Unity based on type
32URL for thumbnail image
1Attribute code
1 - 200Attribute name
1 - 200Attribute type
boolean, date, list, media, money, number, percent, string, text, url Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Attribute description
User who can edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute ID
true: allow bulk edit of attributes <br /> false: bulk edit of attributes are not allowed
Attribute priority
0 < x < 4294967295Unity based on type
32Taxonomy code
1 - 32Taxonomy ID
Taxonomy name
1 - 64Number of children
Attribute code
1 - 200Attribute name
1 - 200Attribute type
boolean, date, list, media, money, number, percent, string, text, url Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Attribute description
User who can edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute ID
true: allow bulk edit of attributes <br /> false: bulk edit of attributes are not allowed
Attribute priority
0 < x < 4294967295Unity based on type
32URL for thumbnail image
1Attribute code
1 - 200Attribute name
1 - 200Attribute type
boolean, date, list, media, money, number, percent, string, text, url Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Attribute description
User who can edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute ID
true: allow bulk edit of attributes <br /> false: bulk edit of attributes are not allowed
Attribute priority
0 < x < 4294967295Unity based on type
32Time of when product was last updated in Dropship
Time of acknowledgement (UTC format)
Time of permit end (UTC format)
Permit ID
true: permit is acknowledged <br /> false: permit is not acknowledged
true: permit is in effect <br /> false: permit is not in effect
Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer name
1 - 64true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
URL of retailer cover image
1Retailer ID
true: Retailer is onboarded <br /> false: Retailer is not onboarded
true: Retailer is in Dropship network; Retailer is not in Dropship network
Time of retailer joining Dropship (UTC format)
URL of retailer logo
1Platform on which retailer is onboarded
fabric URL of retailer profile image
1Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming Retailer status
active, setup, ghost Website URL
100Retailer cost of variant
Retailer price of the variant
Time when permit got revoked (UTC format)
Time of permit start (UTC format)
Attribute code
1 - 200Attribute name
1 - 200Attribute type
boolean, date, list, media, money, number, percent, string, text, url Attribute description
User permission to edit attribute
retailer, brand, any, none Criteria to group attribute
description, general, images, inventory, misc, retailer, shipping, identifiers, pricing Attribute ID
Unit of the selected attribute type. If the attribute type is money, the unit is USD.
32Time of creation
Attribute value ID
Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer name
1 - 64true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
URL of retailer cover image
1Retailer ID
true: Retailer is onboarded <br /> false: Retailer is not onboarded
true: Retailer is in Dropship network; Retailer is not in Dropship network
Time of retailer joining Dropship (UTC format)
URL of retailer logo
1Platform on which retailer is onboarded
fabric URL of retailer profile image
1Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming Retailer status
active, setup, ghost Website URL
100Unit ID
Unit name
1Standard unit
1Unit symbol
5Unit system
metric, imperial Unit type
area, distance, energy, speed, temperature, time, volume, weight, cost Time of update
Attribute value
Vendor code, which is vendor name in lower case and underscore
1 - 64URL of the cover image
1Time of grace period expiration (UTC format)
Vendor (brand) ID
Inventory policy
unmanaged, managed, use_variant_policy true: is on Dropship network <br /> false: not on Dropship network
true: Vendor is onboarded <br /> false: Vendor is not onboarded
Time when vendor joined Dropship (UTC format)
URL of the brand logo
1Vendor name
1 - 64URL of the profile image
1Represents whether subscription is required
disabled, enabled, upcoming Vendor status
active, pending, inactive Subscription expiry Time (UTC format)
true: subscription is overdue <br /> false: subscription is paid
true: subscription is expired <br /> false: subscription is active
true: subscription is on grace period <br /> false: subscription is not on grace period
URL of brand website
100Unique SKU assigned by the Brand
1Carton height
Unit of height
Carton ID
Carton length
Unit of length
Carton number
-2147483648 < x < 2147483647Girth of the package, in inches
Size of the package, in inches
Carton weight
Unit of weight
Carton width
Unit of width
Color of the item (from attributes.color)
128Variant ID
Identifier assigned by the retailer (if set). Otherwise, returns the unique SKU assigned by the Brand.
128Time of vendor inventory update (UTC format)
Estimated delivery date (UTC format)
1Time of inventory submit (UTC format)
Time of inventory update (UTC format)
Time when product or variant was marked sellable (UTC format)
true: Product is discontinued <br /> false: Product is active
Time of when product inventory was discontinued (UTC format)
Inventory of variant
City name
1 - 64Country name
1 - 128Name of the primary contact?
1 - 64Postal code
1 - 32State name
1 - 32Line 1 of the address
1 - 128Contact email address
128Fax number
32Federal tax ID
32Address ID
Name of the alternative contact?
64Primary contact number
32Alternate contact number
32Line 2 of the address
128Type of address
residential, commercial Location ID
Count of sellable variants
Nickname of location
true: product is replenishable <br /> false: product is not replenishable
yes: Variant is sellable <br /> No: Variant is not sellable
true: variant meets requirement <br /> false: variant doesn not meet requirement
Time of variant image creation (UTC format)
Height of variant image
-2147483648 < x < 2147483647Variant ID
Variant images
Order in which the vendor prefers the images to be shown image 1 is shown first.
-2147483648 < x < 2147483647Time of variant image update (UTC format)
URL of variant image
Width of variant image
-2147483648 < x < 2147483647Variant Name
200Time of acknowledgement (UTC format)
Time of permit end (UTC format)
Permit ID
true: permit is acknowledged <br /> false: permit is not acknowledged
true: permit is in effect <br /> false: permit is not in effect
Retailer code, which is retailer name in lower case and hyphenated
1 - 32Retailer name
1 - 64true: Platform allows creation of brand permit <br /> false: Platform doesn't require creation of brand permit
URL of retailer cover image
1Retailer ID
true: Retailer is onboarded <br /> false: Retailer is not onboarded
true: Retailer is in Dropship network; Retailer is not in Dropship network
Time of retailer joining Dropship (UTC format)
URL of retailer logo
1Platform on which retailer is onboarded
fabric URL of retailer profile image
1Represent whether retailer requires subscription to use the platform
disabled, enabled, upcoming Retailer status
active, setup, ghost Website URL
100Retailer cost of variant
Retailer price of the variant
Time when permit got revoked (UTC format)
Time of permit start (UTC format)
true: proposal is approved <br /> false: proposal is not approved
Time of approval (UTC format)