Get property definition

GET

/merchants/{merchantCode}/properties/{propertyCode}

const url = 'https://catalog.shopgate.io/v1/merchants/example/properties/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://catalog.shopgate.io/v1/merchants/example/properties/example

Get property definition information

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

propertyCode

required

string

<= 255 characters

Responses

200

Property definition information

application/json

object

property

object

code

required

Code of the product property this definition applies to (matches ProductProperties[].code).

string

<= 255 characters /^[^.]*$/

name

required

Name of the property definition.

string

<= 255 characters

type

required

Type of the property. It is immutable once the property definition is created.

string

Allowed values: string number boolean

isArray

required

Whether the property holds an array of values of the given type.

boolean

unit

Unit of the property value, e.g. kg, cm, lbs.

null | string

<= 100 characters

Example

{
  "property": {
    "code": "weight",
    "name": "Weight",
    "type": "string",
    "isArray": false,
    "unit": "kg"
  }
}

404

Merchant or property definition not found

application/json

object

statusCode

number

code

required

string

message

required

string

Example

{
  "code": "NotFound",
  "message": "Merchant not found"
}