Update catalog

POST

/merchants/{merchantCode}/catalogs/{catalogCode}

curl --request POST \
  --url https://catalog.shopgate.io/v1/merchants/example/catalogs/example \
  --header 'Content-Type: application/json' \
  --data '{ "parentCatalogCode": "someCode", "name": "Catalog 1", "defaultLocaleCode": "en-us", "defaultCurrencyCode": "USD", "externalUpdateDate": "2018-12-15T00:00:23.114Z", "isDefault": false }'

Update catalog

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

catalogCode

required

string

<= 255 characters

Request Body

Media typeapplication/json

object

parentCatalogCode

Human readable code of the entity

string

>= 1 characters <= 255 characters

Example

someCode

name

string

<= 255 characters

Example

Catalog 1

defaultLocaleCode

string

default: en-us <= 5 characters

Example

en-us

defaultCurrencyCode

string

default: USD <= 3 characters

Example

USD

externalUpdateDate

null | string format: date-time

Example

2018-12-15T00:00:23.114Z

isDefault

boolean

Responses

204

Successfully updated catalog

Media typeapplication/json

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"
}

409

One or more properties of catalog cannot be updated

Media typeapplication/json

object

statusCode

number

code

Machine readable error code

string

message

required

Human readable error code

string

additionalInfo

Additional machine readable information about failing entities

object

Example^generated

{
  "statusCode": 1,
  "code": "example",
  "message": "example",
  "additionalInfo": {}
}