Create Option Product

POST 
/clusters/:lookupKey/:lookupValue/products

> The same endpoints for option products are used as the cluster products, with a difference that option id is used in lookupValue variable instead if cluster id

Use this endpoint to create a single product to the option. If a option product is successfully created, the response will include the productid.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

application/json

Body

descriptions

object[]

Array [

language string

value string

]

eanCode string
language string
manufacturer string
minimumQuantity number

names

object[]

Array [

language string

value string

]

notes

object[]

Array [

language string

value string

]

oemCode string
package string

packageDescriptions

object[]

Array [

language string

value string

]

shortDescriptions

object[]

Array [

language string

value string

]

shortName string
sku string
source string
sourceId string
status string
supplier string
supplierCode string
taxCode string
unit number

Responses

201

Create Option Product - 201 / Create Cluster Product - 201

Response Headers

• Alt-Svc

  string

• Content-Length

  string

• Via

  string

• alt-svc

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

descriptions

object[]

Array [

language string

value string

]

eanCode string

id number

language string

manufacturer string

minimumQuantity number

names

object[]

Array [

language string

value string

]

notes

object[]

Array [

language string

value string

]

oemCode string

package string

packageDescriptions

object[]

Array [

language string

value string

]

shortDescriptions

object[]

Array [

language string

value string

]

shortName string

sku string

source string

sourceId string

status string

supplier string

supplierCode string

taxCode string

unit number
messages string[]
total number

Example (from schema)

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "Dell draadloze lasermuis via nano USB ontvanger"
      }
    ],
    "eanCode": "4004675044075",
    "id": 707972,
    "language": "NL",
    "manufacturer": "DELL",
    "minimumQuantity": 1,
    "names": [
      {
        "language": "NL",
        "value": "Dell draadloze lasermuis via nano USB ontvanger"
      }
    ],
    "notes": [
      {
        "language": "NL",
        "value": "option product"
      }
    ],
    "oemCode": "K72334",
    "package": "STK",
    "packageDescriptions": [
      {
        "language": "NL",
        "value": "Stuks"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "Dell draadloze lasermuis via nano USB ontvanger"
      }
    ],
    "shortName": "Dell draadloze lasermuis via nano USB ontvanger",
    "sku": "K72334",
    "source": "REST-API",
    "sourceId": "K72334",
    "status": "A",
    "supplier": "REST-API",
    "supplierCode": "K72334",
    "taxCode": "H",
    "unit": 1
  },
  "messages": [
    "Cluster Product created"
  ],
  "total": 1
}

Create Cluster Product - 201

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."
      }
    ],
    "eanCode": "4004675044075",
    "id": 707966,
    "language": "NL",
    "manufacturer": "SCHNEIDER",
    "minimumQuantity": 1,
    "names": [
      {
        "language": "NL",
        "value": "Balpen Slider XB extra blauw"
      }
    ],
    "notes": [
      {
        "language": "NL",
        "value": "blawn"
      }
    ],
    "oemCode": "151203",
    "package": "STK",
    "packageDescriptions": [
      {
        "language": "NL",
        "value": "Stuks"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "Balpennen met ViscoGlide-technology. Combineert de voordelen van een balpen en een gelpen. Verkrijgbaar in medium (1mm.) en XB (1,4mm.) punt."
      }
    ],
    "shortName": "Balpen Slider XB extra blauw",
    "sku": "151203",
    "source": "REST-API",
    "sourceId": "151203",
    "status": "A",
    "supplier": "REST-API",
    "supplierCode": "151203",
    "taxCode": "H",
    "unit": 1
  },
  "messages": [
    "Cluster Product created"
  ],
  "total": 1
}

Create Option Product - 201

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "Dell draadloze lasermuis via nano USB ontvanger"
      }
    ],
    "id": 707972,
    "language": "NL",
    "manufacturer": "DELL",
    "minimumQuantity": 1,
    "names": [
      {
        "language": "NL",
        "value": "Dell draadloze lasermuis via nano USB ontvanger"
      }
    ],
    "notes": [
      {
        "language": "NL",
        "value": "option product"
      }
    ],
    "oemCode": "K72334",
    "package": "STK",
    "packageDescriptions": [
      {
        "language": "NL",
        "value": "Stuks"
      }
    ],
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "Dell draadloze lasermuis via nano USB ontvanger"
      }
    ],
    "shortName": "Dell draadloze lasermuis via nano USB ontvanger",
    "sku": "K72334",
    "source": "REST-API",
    "sourceId": "K72334",
    "status": "A",
    "supplier": "REST-API",
    "supplierCode": "K72334",
    "taxCode": "H",
    "unit": 1
  },
  "messages": [
    "Cluster Product created"
  ],
  "total": 1
}

404

Create Cluster Product - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 20007,
    "messages": [
      "Parent Cluster with id [213] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentClusterNotFound"
  }
}

Create Cluster Product - 404

{
  "error": {
    "code": 20007,
    "messages": [
      "Parent Cluster with id [213] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentClusterNotFound"
  }
}

Loading...