GET v1/ProductOptions/{id}

Get a Product Option.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of ProductOption
NameDescriptionTypeAdditional 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

Code/SKU

string

Max length: 20

Barcode

Barcode/UPC

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.

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.

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": "2020-10-20T02:20:46.5939481Z",
    "modifiedDate": "2020-10-20T02:20:46.5939481Z",
    "status": "Primary",
    "productId": 1,
    "code": "SKU-RED-T",
    "barcode": "1234567890123",
    "supplierCode": "SUPPLIER-CODE",
    "option1": "Red",
    "option2": "XXL",
    "option3": "Yes",
    "optionWeight": 0.0,
    "size": null,
    "retailPrice": 89.9,
    "wholesalePrice": 25.0,
    "vipPrice": 79.0,
    "specialPrice": 59.0,
    "specialsStartDate": "2020-10-20T02:20:46.5939481Z",
    "specialDays": 7,
    "stockAvailable": 4.0,
    "stockOnHand": 2.0,
    "image": {
      "link": "http://cin7.com/.../product-option-image-red.jpg"
    },
    "priceColumns": {
      "priceAUD": 20.0,
      "priceGBP": 119.0,
      "costNZD": 15.0
    }
  },
  {
    "id": 2,
    "createdDate": "2020-10-20T02:20:46.5939481Z",
    "modifiedDate": "2020-10-20T02:20:46.5939481Z",
    "status": "Active",
    "productId": 1,
    "code": "SKU-BLUE-T",
    "barcode": "BARCODE-FOR-BLUE-T",
    "supplierCode": "SUPPLIER-CODE",
    "option1": "Blue",
    "option2": "M",
    "option3": "Plain",
    "optionWeight": 0.0,
    "size": null,
    "retailPrice": 89.9,
    "wholesalePrice": 25.0,
    "vipPrice": 79.0,
    "specialPrice": null,
    "specialsStartDate": null,
    "specialDays": null,
    "stockAvailable": 10.0,
    "stockOnHand": 5.0,
    "image": {
      "link": "http://cin7.com/.../product-option-image-blue.jpg"
    },
    "priceColumns": {
      "priceAUD": 20.0,
      "priceGBP": 119.0,
      "costNZD": 15.0
    }
  }
]