Products

Creates a list of Products. Duplicated style codes or product option code in the request will cause the request to be rejected with a 400. If a product with the same style code or product option code already exists, it will be skipped and not created.

post/api/v1/Products

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
  • Auth: none declared

Request body

namestring required

The product name

status0 | 1 | 2 | 3

Product option status

styleCodestring nullable

The Product style code

descriptionstring nullable

The product description

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

Will default to Order if not set. Order Type: Order, Kit, Limited Stock, Buy To Order, Pre-order, Gift Voucher

brandstring nullable

The product brand name. Allow users to assign a brand name based on their preference. This doesn’t need to be part of the existing list of brands present in the backend.

optionLabel1string nullable

A label for the first product option (e.g., Color).

optionLabel2string nullable

A label for the second product option (e.g., Size).

optionLabel3string nullable

A label for the third product option (e.g., Fabric).

salesAccountstring nullable

The sales account associated with the product.

purchasesAccountstring nullable

The purchase account associated with the product.

importCustomsDutystring nullable

The import customs duty applicable to the product.

categoryIdArrayinteger[] nullable

Array of category IDs assigned to the product.

sizeRangeIdinteger

The Id of the Size Range. This can be obtained from the GetSizeRanges Endpoint

Response

OK

successboolean

​True if the record was successfully inserted or updated.

idinteger nullable

The record Id.

codestring nullable

The record code.

errorsstring[] nullable

A list of errors if the insert or update fails.

indexinteger

​The index at which the record was positioned in an insert or update.

Changes

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