Get variants - Fabric

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

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

retailers

{retailer_pk}

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)

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 0: Variant is not replenishable

is_discontinued

number

1: Variant is discontinued 0: Variant is not discontinued

is_sellable

number

1: Variant is sellable 0: Variant is not sellable

in_stock

number

1: Variant is in stock 0: Variant is out of stock

has_images

number

1: Variant has images 0: Variant does not have images.

has_shipping

number

1: Variant has shipping 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

count

integer

required

Total number of records

results

object[]

required

results.active_permit

object

results.active_permit.acknowledged_at

string | null

Time of acknowledgement (UTC format)

results.active_permit.attributes

object

results.active_permit.end_at

string | null

Time of permit end (UTC format)

results.active_permit.id

integer

Permit ID

results.active_permit.is_acknowledged

boolean

true: permit is acknowledged false: permit is not acknowledged

results.active_permit.is_in_effect

boolean

true: permit is in effect false: permit is not in effect

results.active_permit.pricing

object

results.active_permit.retailer

object

results.active_permit.retailer_cost

string | null

Retailer cost of variant

results.active_permit.retailer_price

string | null

Retailer price of the variant

results.active_permit.revoked_at

string | null

Time when permit got revoked (UTC format)

results.active_permit.start_at

string | null

Time of permit start (UTC format)

results.attributes

object[]

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

string | null

Attribute description

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

integer

Attribute ID

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

results.attributes.values.created_at

string

Time of creation

results.attributes.values.id

integer

Attribute value ID

results.attributes.values.retailer

object

results.attributes.values.unit

object

results.attributes.values.updated_at

string

Time of update

results.attributes.values.value

string

Attribute value

results.brand

object

results.brand_identifier

string

Brand identifier

Minimum length: 1

results.cartons

object[]

results.color

string | null

Variant color

Maximum length: 128

results.id

integer

Variant ID

results.identifier

string | null

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

Maximum length: 128

results.inventory

object

results.inventory.brand_inventory_updated_at

string

required

Time of vendor inventory update (UTC format)

results.inventory.estimated_availability_date

string

required

Estimated delivery date (UTC format)

Minimum length: 1

results.inventory.inventory_last_submitted_at

string

required

Time of inventory submit (UTC format)

results.inventory.inventory_updated_at

string

required

Time of inventory update (UTC format)

results.inventory.sellable_updated_at

string

required

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

results.inventory.discontinued

boolean

true: Product is discontinued 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.locations

object[]

results.inventory.replenishable

boolean

true: product is replenishable false: product is not replenishable

results.inventory.sellable

string

yes: Variant is sellable No: Variant is not sellable

results.inventory_policy

string

Inventory policy

results.is_compatible

string

true: variant is compatible false: variant is not compatible

results.media

object[]

results.name

string | null

Variant name

Maximum length: 200

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

object[]

results.permits.acknowledged_at

string | null

Time of acknowledgement (UTC format)

results.permits.attributes

object

results.permits.end_at

string | null

Time of permit end (UTC format)

results.permits.id

integer

Permit ID

results.permits.is_acknowledged

boolean

true: permit is acknowledged false: permit is not acknowledged

results.permits.is_in_effect

boolean

true: permit is in effect false: permit is not in effect

results.permits.pricing

object

results.permits.retailer

object

results.permits.retailer_cost

string | null

Retailer cost of variant

results.permits.retailer_price

string | null

Retailer price of the variant

results.permits.revoked_at

string | null

Time when permit got revoked (UTC format)

results.permits.start_at

string | null

Time of permit start (UTC format)

results.permits_count

integer

Count of permits

results.product_id

string

Product ID

results.proposal_variant

object

results.proposal_variant.approve

boolean

true: proposal is approved false: proposal is not approved

results.proposal_variant.approved_at

string | null

Time of approval (UTC format)

results.proposal_variant.attributes

object[]

results.proposal_variant.attributes.created_at

string

Time of creation

results.proposal_variant.attributes.id

integer

Attribute value ID

results.proposal_variant.attributes.retailer

object

results.proposal_variant.attributes.unit

object

results.proposal_variant.attributes.updated_at

string

Time of update

results.proposal_variant.attributes.value

string

Attribute value

results.proposal_variant.created_at

string

Time of creation (UTC format)

results.proposal_variant.delete

boolean

true: proposal is deleted false: proposal is not deleted

results.proposal_variant.id

integer

Proposal variant ID

results.proposal_variant.issues

object[]

results.proposal_variant.memos

object[]

results.proposal_variant.pricing

string

Pricing of variant

results.proposal_variant.reject

boolean

true: proposal is rejected false: proposal is not rejected

results.proposal_variant.reject_reason

string | null

Rejection reason

Maximum length: 32

results.proposal_variant.rejected_at

string | null

Time of proposal rejection (UTC format)

results.proposal_variant.updated_at

string

Time of last update (UTC format)

results.proposal_variant.variant_id

integer

Variant ID

results.retailer_categories

object

results.retailer_identifiers

object[]

results.retailer_identifiers.id

integer

Retailer ID

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_identifiers.retailer

object

results.ruleset_variant_summary

string

Summary of ruleset variant

results.ruleset_variants

object[]

results.size

string | null

Variant size

Maximum length: 128

results.style

string | null

Variant style

Maximum length: 128

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

string | null

Next page (applicable in a paginated response)

string | null

Previous page (applicable in a paginated response)

Was this page helpful?

Update attributes of a variant Acknowledge receipt of a new permit