List Product Parameters

Get a list of parameters for a product.

get
Path parameters
productIdstringRequired
Responses
200
OK
application/json
get
GET /public/v1/catalog/products/{productId}/parameters HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        },
        "updated": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "description": "text",
      "group": {
        "id": "text",
        "name": "text"
      },
      "scope": "Agreement",
      "phase": "Configuration",
      "context": "None",
      "externalId": "text",
      "displayOrder": 1,
      "constraints": {
        "hidden": true,
        "readonly": true,
        "required": true
      },
      "product": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "operations": "text",
          "defaultErpItem": "text"
        },
        "icon": "text",
        "status": "text"
      },
      "options": null,
      "type": "SingleLineText",
      "status": "text"
    }
  ]
}

Last updated

Was this helpful?