ProductOptions

Get a list of Product Options.

get/api/v1/ProductOptions

Request

  • Base URL: https://api.cin7.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cin7.com/api/v1/ProductOptions
  • Auth: none declared

Query parameters

fieldsstring

A comma-separated list of field names

wherestring

A where clause

orderstring

An order by clause

pageinteger

The page number (default: 1)

rowsinteger

Rows per page (default: 50, maximum: 250)

Response

OK

idinteger

The unique Cin7 Product Option Id.

createdDatestring date-time

Created Date UTC

modifiedDatestring date-time

Modifie Date UTC

status0 | 1 | 2

Product option status

productIdinteger

The unique Cin7 product id

codestring nullable

[OBSOLETE] Use ProductOptionCode

barcodestring nullable

[OBSOLETE] Use ProductOptionBarcode

productOptionCodestring nullable

The Product Option Code/SKU

productOptionSizeCodestring nullable

The Product Option Size Code/SKU

productOptionBarcodestring nullable

The Product Option Barcode

productOptionSizeBarcodestring nullable

The Product Option Size Barcode

supplierCodestring nullable

Supplier code

option1string nullable

Product option 1 (Example: Red)

option2string nullable

Product option 2 (Example: XL)

option3string nullable

Product option 3 (Example: Cotton)

optionWeightnumber double

Product Option Weight

sizestring nullable

Size

sizeIdinteger

Size Id

retailPricenumber nullable

Retail Price

wholesalePricenumber nullable

Wholesale Price

vipPricenumber nullable

VIP Price

specialPricenumber nullable

Special Price

specialsStartDatestring date-time nullable

Specials Start Date

specialDaysinteger nullable

Number of days Specials last

stockAvailablenumber double

Stock Available

stockOnHandnumber double

Stock On Hand

priceColumnsobject nullable

Price Columns

Changes

No recorded changes to this operation across all 1 revision of this API.