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

Get a list of Products.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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 Product
NameDescriptionTypeAdditional information
Id

The unique Cin7 product Id.

integer

None.

Status

Status: Inactive, Public, ShowInB2B, Internal

ProductStatus

None.

CreatedDate

Created Date UTC

date

None.

ModifiedDate

Modified Date UTC

date

None.

StyleCode

The product style code

string

None.

Name

The product name

string

Required

Max length: 250

Description

The product description

string

None.

Images

A list of images

Collection of Image

None.

PdfUpload

PDF file

string

None.

PdfDescription

PDF description

string

None.

SupplierId

The unique Cin7 supplier Id

integer

None.

Brand

The product brand name

string

None.

Category

Category

string

None.

SubCategory

Subcategory

string

None.

CategoryIdArray

Category IDs assigned to the product.

Collection of integer

None.

Channels

Selling Channels

string

None.

Weight

The product weight

decimal number

Range: inclusive between 0 and 999

Height

The product height

decimal number

Range: inclusive between 0 and 999

Width

The product width

decimal number

Range: inclusive between 0 and 999

Length

The product length

decimal number

Range: inclusive between 0 and 999

Volume

The product volume

decimal number

Range: inclusive between 0 and 999

StockControl

The stock control type

StockControl

None.

OrderType

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

string

None.

ProductType

Product Type

string

None.

ProductSubtype

Product Subtype

string

None.

ProjectName

Project Name

string

None.

OptionLabel1

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

string

None.

OptionLabel2

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

string

None.

OptionLabel3

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

string

None.

CustomFields

Custom fields.

Dictionary of string [key] and Object [value]

None.

ProductOptions

A list of product options

Collection of ProductOption

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "status": "Public",
    "createdDate": "2020-10-20T02:20:46.5939481Z",
    "modifiedDate": "2020-10-20T02:20:46.5939481Z",
    "styleCode": "StyleCode",
    "name": "V-NECK TSHIRT",
    "description": "Product description...",
    "images": [
      {
        "link": "http://cin7.com/.../product-image-1.jpg"
      },
      {
        "link": "http://cin7.com/.../product-image-2.jpg"
      },
      {
        "link": "http://cin7.com/.../product-image-3.jpg"
      }
    ],
    "pdfUpload": null,
    "pdfDescription": null,
    "supplierId": 101,
    "brand": "Brand Name",
    "category": "T-SHIRTS",
    "subCategory": null,
    "categoryIdArray": null,
    "channels": null,
    "weight": 100.0,
    "height": 0.0,
    "width": 0.0,
    "length": 0.0,
    "volume": 0.0,
    "stockControl": 5,
    "orderType": "",
    "productType": "",
    "productSubtype": null,
    "projectName": "",
    "optionLabel1": "Color",
    "optionLabel2": "Size",
    "optionLabel3": "Printed",
    "customFields": {
      "products_1000": "abc123",
      "products_1001": 119,
      "products_1002": false
    },
    "productOptions": [
      {
        "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
        }
      }
    ]
  },
  {
    "id": 0,
    "status": "Inactive",
    "createdDate": "0001-01-01T00:00:00",
    "modifiedDate": "0001-01-01T00:00:00",
    "styleCode": null,
    "name": null,
    "description": null,
    "images": [],
    "pdfUpload": null,
    "pdfDescription": null,
    "supplierId": 0,
    "brand": null,
    "category": null,
    "subCategory": null,
    "categoryIdArray": null,
    "channels": null,
    "weight": 0.0,
    "height": 0.0,
    "width": 0.0,
    "length": 0.0,
    "volume": 0.0,
    "stockControl": 0,
    "orderType": null,
    "productType": null,
    "productSubtype": null,
    "projectName": null,
    "optionLabel1": null,
    "optionLabel2": null,
    "optionLabel3": null,
    "customFields": null,
    "productOptions": []
  }
]