Update Product by Cluster lookup key and Product Id

PATCH 
/clusters/:lookupKey/:lookupValue/products/:productId

Use this endpoint to update single cluster product details by cluster lookup key and product id.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

productId stringrequired

The value of product id

application/json

Body

costPrice number

descriptions

object[]

Array [

language string

value string

]

eanCode 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

]

price number

shortDescriptions

object[]

Array [

language string

value string

]

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

Responses

200

Update Product by Cluster lookup key and Product Id - 200

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

data

object

costPrice number

descriptions

object[]

Array [

language string

value string

]

eanCode string

id number

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

]

price number

shortDescriptions

object[]

Array [

language string

value string

]

shortName string

sku string

source string

sourceId string

status string

suggestedPrice number

supplier string

supplierCode string

taxCode string

unit number
messages string[]
total number

Example (from schema)

{
  "data": {
    "costPrice": 0.99,
    "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,
    "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"
      }
    ],
    "price": 1.49,
    "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",
    "suggestedPrice": 1.49,
    "supplier": "REST-API",
    "supplierCode": "151203",
    "taxCode": "H",
    "unit": 1
  },
  "messages": [
    "Cluster Product updated"
  ],
  "total": 1
}

Update Product by Cluster lookup key and Product Id - 200

{
  "data": {
    "costPrice": 0.99,
    "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,
    "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"
      }
    ],
    "price": 1.49,
    "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",
    "suggestedPrice": 1.49,
    "supplier": "REST-API",
    "supplierCode": "151203",
    "taxCode": "H",
    "unit": 1
  },
  "messages": [
    "Cluster Product updated"
  ],
  "total": 1
}

404

Update Product by Cluster lookup key and Product Id - 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": 20013,
    "messages": [
      "Cluster Product with id [707968] not found for the cluster with id [210]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20013",
    "status": 404,
    "type": "ClusterProductNotFound"
  }
}

Update Product by Cluster lookup key and Product Id - 404

{
  "error": {
    "code": 20013,
    "messages": [
      "Cluster Product with id [707968] not found for the cluster with id [210]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20013",
    "status": 404,
    "type": "ClusterProductNotFound"
  }
}

Loading...