Products

Get a Product.

get/api/v1/Products/{id}

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/Products/{id}
  • Auth: none declared

Path parameters

idinteger required

Response

OK

idinteger

The unique Cin7 product Id.

status0 | 1 | 2 | 3

Product option status

createdDatestring date-time

Created Date UTC

modifiedDatestring date-time

Modified Date UTC

styleCodestring nullable

The product style code

namestring required

The product name

descriptionstring nullable

The product description

tagsstring nullable

Comma delimited list of custom tags

pdfUploadstring nullable

PDF file

pdfDescriptionstring nullable

PDF description

supplierIdinteger

The unique Cin7 supplier Id

brandstring nullable

The product brand name

categorystring nullable

Category

subCategorystring nullable

Subcategory

categoryIdArrayinteger[] nullable

Category IDs assigned to the product.

channelsstring nullable

Selling Channels

weightnumber double

The product weight

heightnumber double

The product height

widthnumber double

The product width

lengthnumber double

The product length

volumenumber double

The product volume

stockControl0 | 1 | 2 | 3 | 4 | 5
orderTypestring nullable

Order Type: Order, Kit, Limited Stock, Buy To Order, Pre-order, Gift Voucher

productTypestring nullable

Product Type

productSubtypestring nullable

Product Subtype

projectNamestring nullable

Project Name

optionLabel1string nullable

A label for product option name 1 (Example: Color)

optionLabel2string nullable

A label for product option name 2 (Example: Size)

optionLabel3string nullable

A label for product option name 3 (Example: Fabric)

salesAccountstring nullable

Sales account

purchasesAccountstring nullable

Purchase account

importCustomsDutystring nullable

Import Customs duty

sizeRangeIdinteger

Size range id

customFieldsobject nullable

Custom fields.

Changes

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