Skip to content
ShopgateShopgateShopgate Documentation

Update category

POST
/merchants/{merchantCode}/categories/{categoryCode}
curl --request POST \
  --url https://catalog.shopgate.io/v1/merchants/example/categories/example \
  --header 'Content-Type: application/json' \
  --data '{ "image": { "en-us": "string in english", "de-de": "Zeichenkette auf Deutsch" }, "name": { "en-us": "string in english", "de-de": "Zeichenkette auf Deutsch" }, "parentCategoryCode": "ParentCategoryA", "url": { "en-us": "string in english", "de-de": "Zeichenkette auf Deutsch" }, "sequenceId": 1, "description": { "en-us": "string in english", "de-de": "Zeichenkette auf Deutsch" }, "externalUpdateDate": "2018-12-15T00:00:23.114Z", "status": "active" }'

Update category.

Localizations

The following properties are localized:

  • name
  • image
  • url
  • description

see Entity Localization for further information.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
merchantCode
required
string
<= 255 characters
categoryCode
required
string
<= 255 characters

Query Parameters

Section titled “Query Parameters”
catalogCode
string
<= 255 characters

Request Body

Section titled “Request Body”
Media typeapplication/json
object
image

Localization object, see Entity Localization for further information.

object
key
additional properties
string
>= 1 characters <= 255 characters
Example
{
  "en-us": "string in english",
  "de-de": "Zeichenkette auf Deutsch"
}
name

Localization object, see Entity Localization for further information.

object
key
additional properties
string
>= 1 characters <= 255 characters
Example
{
  "en-us": "string in english",
  "de-de": "Zeichenkette auf Deutsch"
}
parentCategoryCode
null | string
>= 1 characters <= 255 characters
Example
ParentCategoryA
url

Url of the category in the desktop shop

object
key
additional properties
string
>= 1 characters <= 255 characters
Example
{
  "en-us": "string in english",
  "de-de": "Zeichenkette auf Deutsch"
}
sequenceId
integer
Example
1
description

Localization object, see Entity Localization for further information.

object
key
additional properties
string
<= 255 characters
Example
{
  "en-us": "string in english",
  "de-de": "Zeichenkette auf Deutsch"
}
externalUpdateDate
null | string format: date-time
Example
2018-12-15T00:00:23.114Z
status
string
Allowed values: active inactive
Example
active

Responses

Section titled “Responses”

204

Section titled “204”

Successfully updated

Media typeapplication/json

400

Section titled “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

Section titled “404”

Merchant or category not found

Media typeapplication/json
object
statusCode
number
code
required
string
message
required
string
Example
{
  "code": "NotFound",
  "message": "Merchant not found"
}

409

Section titled “409”

External update date is earlier than the existing one

Media typeapplication/json
object
statusCode
number
code

Machine readable error code

string
message
required

Human readable error code

string
Examplegenerated
{
  "statusCode": 1,
  "code": "example",
  "message": "example"
}