GET /variants/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- accountingSync string | null Required
  
  Accounting sync
  
  Values are active or disabled. Default value is active.
- automaticallyBackorder string | null Required
  
  Automatically backorder
  
  Values are vendor_default, backorder, or ignore. Default value is vendor_default.
- backorderQuantity integer(int32) | null Required
  
  Backorder quantity
  
  Default value is 0.
- barcode string | null
  
  Barcode
- commissionRate number | null Required
  
  Commission rate
  
  Default value is 0.
- commissionRateRouting string | null Required
  
  Commission rate routing
  
  Values are dropship_provider or variant. Default value is dropship_provider.
- commissionRateType string | null Required
  
  Commission rate type
  
  Values are percentage or fixed. Default value is percentage.
- costPrice number Required
  
  Cost price
  
  Default value is 0.
- countryOfOrigin string | null
  
  Country of origin
- createdAt string(date-time)
  
  Created at
- defaultPurchaseQuantity integer(int32) | null Required
  
  Default purchase quantity
  
  Default value is 1.
- denyThreshold integer(int32) | null Required
  
  Deny threshold
  
  Default value is 0.
- description string | null
  
  Description
- distanceUnit string | null Required
  
  Distance unit
  
  Values are in or cm. Default value is in.
- dropshipProviderAddressId integer(int32) | null
  
  Dropship provider address
- dropshipProviderAddressMapping string | null Required
  
  Dropship provider address mapping
  
  Values are default or manual. Default value is default.
- dropshipProviderId integer(int32) | null
  
  Dropship provider
- dropshipProviderMapping string | null Required
  
  Dropship provider mapping
  
  Values are brand_name or manual. Default value is brand_name.
- dynamicInventoryPolicy boolean | null
  
  Dynamic inventory policy
- fulfillmentPolicy string | null Required
  
  Fulfillment policy
  
  Values are vendor_default, manual, dropship, fulfill, or blended. Default value is vendor_default.
- grams number(float) | null Required
  
  Grams
  
  Default value is 0.
- hsCode string | null
  
  Hs code
- id integer(int32)
  
  Id
- images object | null | array | boolean | integer | number | string Required
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Images
  
  Default value is [] (empty).
  
  Images
  
  Default value is [] (empty).
  
  Images
  
  Default value is [] (empty).
  
  Images
  
  Default value is [] (empty).
  
  Images
  
  Default value is [] (empty).
  
  Images
  
  Default value is [] (empty).
- imagesMapped object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Images mapped
  
  Images mapped
  
  Images mapped
  
  Images mapped
  
  Images mapped
  
  Images mapped
- imagesRaw object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Images raw
  
  Images raw
  
  Images raw
  
  Images raw
  
  Images raw
  
  Images raw
- inventoryAllocated integer(int32) Required
  
  Inventory allocated
  
  Default value is 0.
- inventoryFeeds integer(int32) | null Required
  
  Inventory feeds
  
  Default value is 0.
- inventoryPolicy string Required
  
  Inventory policy
  
  Values are ignore, deny, continue, dropship, or track. Default value is track.
- inventoryQuantity integer(int32) Required
  
  Inventory quantity
  
  Default value is 0.
- inventoryRouting string | null Required
  
  Inventory routing
  
  Values are inventory_feed or manual. Default value is inventory_feed.
- inventorySync string | null Required
  
  Inventory sync
  
  Values are channel or disabled. Default value is channel.
- inventoryType string Required
  
  Inventory type
  
  Values are tracked, serialized, bundle, or service. Default value is tracked.
- leadTime integer(int32) | null
  
  Lead time
- levels object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Levels
  
  Levels
  
  Levels
  
  Levels
  
  Levels
  
  Levels
- lowInventoryQuantity boolean | null
  
  Low inventory quantity
- minInventoryQuantity integer(int32) | null Required
  
  Min inventory quantity
  
  Default value is 0.
- minimumGuidePrice number | null Required
  
  This field allows you to set a recommended price, which will be shown to the vendor in the portal. Vendors can also set up pricing rules based on this price in the vendor portal. For example, set a fixed or percentage amount above or below this price.
  
  Default value is 0.
- mpn string | null
  
  Mpn
- name string Required
  
  Name
- noInventoryPolicy string | null Required
  
  No inventory policy
  
  Values are vendor_default, manual, dropship, or replenish. Default value is replenish.
- notes string | null
  
  Notes
- orderSplitting string | null Required
  
  Order splitting
  
  Values are group, splitQuantity, or default. Default value is default.
- packingDepth number | null Required
  
  Packing depth
  
  Default value is 0.
- packingHeight number | null Required
  
  Packing height
  
  Default value is 0.
- packingWidth number | null Required
  
  Packing width
  
  Default value is 0.
- position number(float) | null Required
  
  Position
  
  Default value is 0.
- productId integer(int32) Required
  
  Product
- productType string | null
  
  Product type
- requiresShipping boolean | null
  
  Requires shipping
- resellerVisibility string | null Required
  
  Reseller visibility
  
  Values are visible, hidden, or selected. Default value is visible.
- serialPrefix string | null
  
  Serial prefix
- serialReference integer(int32) | null Required
  
  Serial reference
  
  Default value is 0.
- serialSuffix string | null
  
  Serial suffix
- sku string Required
  
  Sku
- tags array[string] | null
  
  Tags
- taxable boolean Required
  
  Taxable
  
  Default value is true.
- totalPurchaseItems integer(int32) Required
  
  Total purchase items
  
  Default value is 0.
- totalSaleItems integer(int32) Required
  
  Total sale items
  
  Default value is 0.
- updatedAt string(date-time)
  
  Updated at
- vendorId integer(int32) | null
  
  Vendor
- vendorSku string | null
  
  Vendor sku
  
  Maximum length is 50.

curl \
 -X GET http://api.example.com/v1/variants/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "accountingSync": "active",
  "automaticallyBackorder": "vendor_default",
  "backorderQuantity": 0,
  "barcode": "string",
  "commissionRate": 0,
  "commissionRateRouting": "dropship_provider",
  "commissionRateType": "percentage",
  "costPrice": 0,
  "countryOfOrigin": "string",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "defaultPurchaseQuantity": 1,
  "denyThreshold": 0,
  "description": "string",
  "distanceUnit": "in",
  "dropshipProviderAddressId": 42,
  "dropshipProviderAddressMapping": "default",
  "dropshipProviderId": 42,
  "dropshipProviderMapping": "brand_name",
  "dynamicInventoryPolicy": true,
  "fulfillmentPolicy": "vendor_default",
  "grams": 0,
  "hsCode": "string",
  "id": 42,
  "images": [],
  "imagesMapped": {},
  "imagesRaw": {},
  "inventoryAllocated": 0,
  "inventoryFeeds": 0,
  "inventoryPolicy": "track",
  "inventoryQuantity": 0,
  "inventoryRouting": "inventory_feed",
  "inventorySync": "channel",
  "inventoryType": "tracked",
  "leadTime": 42,
  "levels": {},
  "lowInventoryQuantity": true,
  "minInventoryQuantity": 0,
  "minimumGuidePrice": 0,
  "mpn": "string",
  "name": "string",
  "noInventoryPolicy": "replenish",
  "notes": "string",
  "orderSplitting": "default",
  "packingDepth": 0,
  "packingHeight": 0,
  "packingWidth": 0,
  "position": 0,
  "productId": 42,
  "productType": "string",
  "requiresShipping": true,
  "resellerVisibility": "visible",
  "serialPrefix": "string",
  "serialReference": 0,
  "serialSuffix": "string",
  "sku": "string",
  "tags": [
    "string"
  ],
  "taxable": true,
  "totalPurchaseItems": 0,
  "totalSaleItems": 0,
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "vendorId": 42,
  "vendorSku": "string"
}

GET /variants/{id}.json

Path parameters

Responses

images object | null | array | boolean | integer | number | string Required

imagesMapped object | null | array | boolean | integer | number | string

imagesRaw object | null | array | boolean | integer | number | string

levels object | null | array | boolean | integer | number | string