GET v1/ProductOptions?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Product Options.

Request Information

URI Parameters

Name	Description	Type	Additional information
fields	A comma-separated list of field names	string	None.
where	A where clause	string	None.
order	An order by clause	string	None.
page	The page number (default: 1)	integer	Default value is 1
rows	Rows per page (default: 50, maximum: 250)	integer	Default value is 50

Body Parameters

None.

Response Information

Resource Description

Collection of ProductOption

Name	Description	Type	Additional information
Id	The unique Cin7 Product Option Id.	integer	None.
CreatedDate	Created Date UTC	date	None.
ModifiedDate	Modifie Date UTC	date	None.
Status	Product Option Status: Primary, Active or Disabled	ProductOptionStatus	None.
ProductId	The unique Cin7 product id	integer	None.
Code	[OBSOLETE] Use ProductOptionCode	string	Max length: 20
Barcode	[OBSOLETE] Use ProductOptionBarcode	string	Max length: 13
ProductOptionCode	The Product Option Code/SKU	string	Max length: 20
ProductOptionSizeCode	The Product Option Size Code/SKU	string	Max length: 20
ProductOptionBarcode	The Product Option Barcode	string	Max length: 13
ProductOptionSizeBarcode	The Product Option Size Barcode	string	Max length: 13
SupplierCode	Supplier code	string	Max length: 20
Option1	Product option 1 (Example: Red)	string	Max length: 50
Option2	Product option 2 (Example: XL)	string	Max length: 50
Option3	Product option 3 (Example: Cotton)	string	Max length: 50
OptionWeight	Product Option Weight	decimal number	None.
Size	Size	string	None.
SizeId	Size Id	integer	None.
RetailPrice	Retail Price	decimal number	Data type: Currency
WholesalePrice	Wholesale Price	decimal number	Data type: Currency
VIPPrice	VIP Price	decimal number	Data type: Currency
SpecialPrice	Special Price	decimal number	Data type: Currency
SpecialsStartDate	Specials Start Date	date	None.
SpecialDays	Number of days Specials last	integer	None.
StockAvailable	Stock Available	decimal number	None.
StockOnHand	Stock On Hand	decimal number	None.
UomOptions	UOM options	Collection of UomOption	None.
Image	A product option image	Image	None.
PriceColumns	Price Columns	Dictionary of string [key] and decimal number [value]	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "createdDate": "2025-11-25T04:06:58.0591621Z",
    "modifiedDate": "2025-11-25T04:06:58.0591621Z",
    "status": "Primary",
    "productId": 1,
    "code": "SKU-RED-T",
    "barcode": "1234567890123",
    "productOptionCode": null,
    "productOptionSizeCode": null,
    "productOptionBarcode": null,
    "productOptionSizeBarcode": null,
    "supplierCode": "SUPPLIER-CODE",
    "option1": "Red",
    "option2": "XXL",
    "option3": "Yes",
    "optionWeight": 0.0,
    "size": null,
    "sizeId": 0,
    "retailPrice": 89.9,
    "wholesalePrice": 25.0,
    "vipPrice": 79.0,
    "specialPrice": 59.0,
    "specialsStartDate": "2025-11-25T04:06:58.0591621Z",
    "specialDays": 7,
    "stockAvailable": 4.0,
    "stockOnHand": 2.0,
    "uomOptions": [],
    "image": {
      "link": "http://cin7.com/.../product-option-image-red.jpg"
    },
    "priceColumns": {
      "priceAUD": 20.0,
      "priceGBP": 119.0,
      "costNZD": 15.0
    }
  },
  {
    "id": 2,
    "createdDate": "2025-11-25T04:06:58.0591621Z",
    "modifiedDate": "2025-11-25T04:06:58.0591621Z",
    "status": "Active",
    "productId": 1,
    "code": "SKU-BLUE-T",
    "barcode": "BARCODE-FOR-BLUE-T",
    "productOptionCode": null,
    "productOptionSizeCode": null,
    "productOptionBarcode": null,
    "productOptionSizeBarcode": null,
    "supplierCode": "SUPPLIER-CODE",
    "option1": "Blue",
    "option2": "M",
    "option3": "Plain",
    "optionWeight": 0.0,
    "size": null,
    "sizeId": 0,
    "retailPrice": 89.9,
    "wholesalePrice": 25.0,
    "vipPrice": 79.0,
    "specialPrice": null,
    "specialsStartDate": null,
    "specialDays": null,
    "stockAvailable": 10.0,
    "stockOnHand": 5.0,
    "uomOptions": [],
    "image": {
      "link": "http://cin7.com/.../product-option-image-blue.jpg"
    },
    "priceColumns": {
      "priceAUD": 20.0,
      "priceGBP": 119.0,
      "costNZD": 15.0
    }
  }
]