Get property definitions

GET

/merchants/{merchantCode}/properties

curl --request GET \
  --url 'https://catalog.shopgate.io/v1/merchants/example/properties?limit=1000&offset=0'

Get all property definitions

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

Query Parameters

filters

string format: json

Filter string. Supported filters: code, name, type

sort

string

Sorting of the products (sequenceId only works with filter catalogCode)

limit

integer

default: 1000 >= 1 <= 1000

The limit of entries of one page

offset

integer

0

The offset where to start the page

Responses

200

Property definition information

Media typeapplication/json

object

meta

object

limit

number

offset

number

totalItemCount

number

properties

Array<object>

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

{
  "meta": {
    "limit": 10,
    "offset": 0,
    "totalItemCount": 1
  },
  "properties": [
    {
      "code": "weight",
      "name": "Weight",
      "type": "string",
      "isArray": false,
      "unit": "kg"
    }
  ]
}

400

Validation error

Media typeapplication/json

object

statusCode

number

message

string

code

string

additionalInfo

object

validationErrors

Array<object>

object

code

number

reason

string

entity

string

entityId

string

subentityPath

Array<string | number>

error

object

paramName

The parameter-field, that failed to validate, like “userId”

string

paramValue

The value, that was sent, like “xxx”

null | string | number | array | object

code

Machine readable error code

string

Allowed values: SCHEMA_VALIDATION_FAILED VALIDATION_FAILED ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT INVALID_TYPE UNKNOWN_FORMAT PATTERN

message

required

Human readable error code

string

results

object

errors

Array<object>

object

code

Machine readable error code

string

Allowed values: ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT INVALID_CREDENTIALS INVALID_TYPE UNKNOWN_FORMAT PATTERN

message

Human readable error code

string

description

string

path

Array<string>

warnings

array

Example

{
  "error": {
    "code": "SCHEMA_VALIDATION_FAILED",
    "results": {
      "errors": [
        {
          "code": "MAX_LENGTH",
          "message": "Name too long",
          "description": "Property Name is too long",
          "path": [
            "name"
          ]
        }
      ]
    }
  }
}

404

Merchant not found

Media typeapplication/json

object

statusCode

number

code

required

string

message

required

string

Example

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