Get details of a single variant

{ "id": 100024, "name": "T-Shirt, Blue, L", "brand_identifier": "1000-BL-L", "parent_identifier": "1000-BL", "parent_name": "T-Shirt, Blue", "attributes": [ { "id": 44, "code": "size", "name": "Size", "editable_by": "brand", "grouping": "general", "description": "demo product description", "type": "money", "units": "USD", "values": { "id": 123, "value": "<string>", "unit": { "id": 677, "name": "Sample unit", "standard_unit": "<string>", "type": "cost", "system": "metric", "symbol": "USD" }, "retailer": { "id": 500, "name": "Demo Retailer", "code": "demo-retailer", "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png", "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg", "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg", "joined_at": "2021-08-03T17:24:12Z", "is_rcn_retailer": false, "is_onboarded": false, "platform": "fabric", "requires_subscription": "disabled", "brand_permit_creation_allowed": false, "website": "https://demoabc.com", "status": "active" }, "updated_at": "2023-11-07T05:31:56Z", "created_at": "2023-11-07T05:31:56Z" } } ], "brand": { "id": 500, "name": "Marla Cielo", "code": "demo-brand", "joined_at": "2022-09-10T15:24:56Z", "logo_url": "https://images.revcascade.com/retailers/defaults/logo-lg.png", "cover_url": "https://images.revcascade.com/retailers/defaults/cover.png", "profile_tile_url": "https://images.revcascade.com/retailers/defaults/profile-tile.png", "website": null, "is_onboarded": false, "is_on_rcn": false, "requires_subscription": "enabled", "subscription_expires_at": "2024-09-19T13:32:10Z", "grace_period_ends_at": "2024-10-26T13:32:10Z", "subscription_is_expired": false, "subscription_is_on_grace_period": false, "subscription_is_delinquent": false, "inventory_policy": "managed", "status": "active" }, "identifier": "1000-BL-L", "product_id": "4511", "cartons": [ { "id": 48, "number": 1, "length": "1", "length_unit": "1", "width": "1", "width_unit": "meter", "height": "1", "height_unit": "meter", "weight": "15", "weight_unit": "KG", "package_girth_inches": "1", "package_size_inches": "1" } ], "upc": "9119119111", "color": "Blue", "style": "print", "size": "Medium", "active_permit": { "id": 10104, "retailer": { "id": 500, "name": "Demo Retailer", "code": "demo-retailer", "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png", "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg", "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg", "joined_at": "2021-08-03T17:24:12Z", "is_rcn_retailer": false, "is_onboarded": false, "platform": "fabric", "requires_subscription": "disabled", "brand_permit_creation_allowed": false, "website": "https://demoabc.com", "status": "active" }, "retailer_price": "12.99", "retailer_cost": "8.99", "pricing": {}, "attributes": {}, "start_at": "2021-09-10T15:24:56Z", "end_at": "2024-09-10T15:24:56Z", "is_in_effect": true, "revoked_at": "2022-09-10T15:24:56Z", "is_acknowledged": true, "acknowledged_at": "2022-09-10T15:24:56Z" }, "permits": [ { "id": 10104, "retailer": { "id": 500, "name": "Demo Retailer", "code": "demo-retailer", "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png", "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg", "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg", "joined_at": "2021-08-03T17:24:12Z", "is_rcn_retailer": false, "is_onboarded": false, "platform": "fabric", "requires_subscription": "disabled", "brand_permit_creation_allowed": false, "website": "https://demoabc.com", "status": "active" }, "retailer_price": "12.99", "retailer_cost": "8.99", "pricing": {}, "attributes": {}, "start_at": "2021-09-10T15:24:56Z", "end_at": "2024-09-10T15:24:56Z", "is_in_effect": true, "revoked_at": "2022-09-10T15:24:56Z", "is_acknowledged": true, "acknowledged_at": "2022-09-10T15:24:56Z" } ], "permits_count": 1, "inventory_policy": "Managed", "inventory": { "discontinued": true, "discontinued_updated_at": null, "inventory": 0, "inventory_updated_at": "2022-09-10T15:24:56Z", "inventory_last_submitted_at": "2022-09-10T15:24:56Z", "brand_inventory_updated_at": "2022-09-10T15:24:56Z", "sellable": "No", "sellable_updated_at": "2022-11-10T15:24:56Z", "replenishable": true, "estimated_availability_date": "2022-09-10T15:24:56Z", "locations": [ { "id": 1, "address": { "id": 10, "type": "residential", "name1": "Demo Brand, Inc", "name2": null, "street1": "1332 Hermosa Ave", "street2": null, "city": "Hermosa Beach", "province": "CA", "postal_code": "90254", "country": "US", "phone1": "3105551212", "phone2": "3105551213", "fax": null, "email": null, "federal_tax_id": null }, "inventory": 0, "nickname": "LA Warehouse" } ] }, "media": [ { "id": 249, "width": 100, "height": 100, "media": "default", "priority": 1, "url": "192.168.99.100/media/default/original", "updated_at": "2022-09-10T15:24:56Z", "created_at": "2022-08-10T15:24:56Z" } ], "ruleset_variants": [ { "id": 1232, "status": "processing", "ruleset": {}, "results": "<string>", "created_at": "2022-08-10T15:24:56Z", "updated_at": "2022-09-10T15:24:56Z" } ], "ruleset_variant_summary": "<string>", "is_compatible": true, "proposal_variant": { "id": 3456, "pricing": "12.00", "attributes": [ { "id": 123, "value": "<string>", "unit": { "id": 677, "name": "Sample unit", "standard_unit": "<string>", "type": "cost", "system": "metric", "symbol": "USD" }, "retailer": { "id": 500, "name": "Demo Retailer", "code": "demo-retailer", "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png", "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg", "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg", "joined_at": "2021-08-03T17:24:12Z", "is_rcn_retailer": false, "is_onboarded": false, "platform": "fabric", "requires_subscription": "disabled", "brand_permit_creation_allowed": false, "website": "https://demoabc.com", "status": "active" }, "updated_at": "2023-11-07T05:31:56Z", "created_at": "2023-11-07T05:31:56Z" } ], "memos": [ { "id": 1234, "text": "Immediate requirement", "visibility": "any", "acknowledged_at": "2022-01-10T15:24:56Z", "notify_people": true, "created_by": { "id": 542, "first_name": "Sample", "last_name": "Demo", "title": "Demo", "status": "Active", "type": "standard", "photo_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf", "profile_photo": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf", "is_me": true }, "created_by_context": "retailer", "created_at": "2021-09-10T15:24:56Z", "updated_at": "2022-09-10T15:24:56Z" } ], "issues": [ { "id": 123, "memos": [ { "id": 1234, "text": "Immediate requirement", "visibility": "any", "acknowledged_at": "2022-01-10T15:24:56Z", "notify_people": true, "created_by": { "id": 542, "first_name": "Sample", "last_name": "Demo", "title": "Demo", "status": "Active", "type": "standard", "photo_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf", "profile_photo": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf", "is_me": true }, "created_by_context": "retailer", "created_at": "2021-09-10T15:24:56Z", "updated_at": "2022-09-10T15:24:56Z" } ], "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "resolved_at": "2023-11-07T05:31:56Z", "is_resolved": "<string>", "issue_id": 123, "message": "<string>", "title": "<string>" } ], "variant_id": 249, "approved_at": "2022-10-10T15:24:56Z", "created_at": "2022-07-10T15:24:56Z", "updated_at": "2022-09-10T15:24:56Z", "rejected_at": null, "reject_reason": "Incomplete", "reject": true, "approve": false, "delete": false }, "retailer_identifiers": [ { "id": 5642, "retailer": { "id": 500, "name": "Demo Retailer", "code": "demo-retailer", "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png", "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg", "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg", "joined_at": "2021-08-03T17:24:12Z", "is_rcn_retailer": false, "is_onboarded": false, "platform": "fabric", "requires_subscription": "disabled", "brand_permit_creation_allowed": false, "website": "https://demoabc.com", "status": "active" }, "identifier": "SKU976", "name": "Retailer Sample" } ], "retailer_categories": { "id": 453, "retailer": { "id": 500, "name": "Demo Retailer", "code": "demo-retailer", "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png", "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg", "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg", "joined_at": "2021-08-03T17:24:12Z", "is_rcn_retailer": false, "is_onboarded": false, "platform": "fabric", "requires_subscription": "disabled", "brand_permit_creation_allowed": false, "website": "https://demoabc.com", "status": "active" }, "category": "CategoryANC" } }

Authorizations

Authorization

string

header

required

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

Path Parameters

integer

required

Variant ID

retailer_pk

number

required

Retailer ID

Response

200 - application/json

integer

Variant ID

Example:

100024

name

string | null

Variant name

Maximum length: 200

Example:

"T-Shirt, Blue, L"

brand_identifier

string

Brand identifier

Minimum length: 1

Example:

"1000-BL-L"

parent_identifier

string | null

Parent identifier of variant

Maximum length: 100

Example:

"1000-BL"

parent_name

string | null

Parent name of variant

Maximum length: 200

Example:

"T-Shirt, Blue"

attributes

object[]

Show child attributes

brand

object

Show child attributes

identifier

string | null

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

Maximum length: 128

Example:

"1000-BL-L"

product_id

string

Product ID

Example:

"4511"

cartons

object[]

Show child attributes

upc

string

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

Maximum length: 64

Example:

"9119119111"

color

string | null

Variant color

Maximum length: 128

Example:

"Blue"

style

string | null

Variant style

Maximum length: 128

Example:

"print"

size

string | null

Variant size

Maximum length: 128

Example:

"Medium"

active_permit

object

Show child attributes

permits

object[]

Show child attributes

permits_count

integer

Count of permits

Example:

1

inventory_policy

string

Inventory policy

Example:

"Managed"

inventory

object

Show child attributes

media

object[]

Show child attributes

ruleset_variants

object[]

Show child attributes

ruleset_variant_summary

string

Summary of ruleset variant

is_compatible

string

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

Example:

true

proposal_variant

object

Show child attributes

retailer_identifiers

object[]

Show child attributes

retailer_categories

object

Show child attributes

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Get details of a single variant

Authorizations

Path Parameters

Response