Storefront Gateway Business Error Codes

A Storefront Gateway business error code (or just “business code”) is returned in the body of a failed or denied API request. In most cases, the business code is accompanied by a human-readable message that describes the issue. Known status codes are listed below and grouped according to the HTTP status code that the business code accompanies.

400

Most 400 responses are the result of bad user input or improper pagination parameters in the request.

Storefront Gateway Business Code	Description
`application-setting-category-not-writable`	You cannot add an app setting on a “read only” category.
`blacklisted-process`	The specified Storefront Gateway Process is currently blacklisted and cannot be invoked.
`credential-field-not-allowed-to-change`	You cannot update a password using this method. Please use Storefront Gateway’s Update Password Process instead.
`invalid-app-setting-input-error`	App setting value cannot be injected into a (Java) bean.
`invalid-flags`	Permission flags in the request body are invalid.
`invalid-input-error`	General user input error code. Results from an invalid value in a user-supplied field of data.
`invalid-page-offset`	The page offset cannot be a negative value. Check your pagination parameters and try again.
`max-return-page-size`	The total number of results exceeds the maximum page size. Set pagination parameters and try again.
`missing-or-invalid-input-field`	An input field in the request either has missing or invalid data.
`name-field-empty`	The “name” field cannot be empty.
`non-unique-attribute`	More than one entity was found with the specified property or attribute.
`non-unique-result`	More than one entity was found that matches the specified request criteria.
`page-size-error`	The requested page size exceeds the max page size. Check your pagination parameters.

401

Most 401 responses are the result of missing authentication (the system does not know who you are) or verification (a missing or invalid token).

Storefront Gateway Business Code	Description
`authentication-required`	General authentication error. The requesting user/client is not authenticated.
`invalid-act-consumption`	The system failed to consume the supplied action token.
`invalid-token`	General token error. The supplied token is invalid (e.g., the token is expired).
`token-mac-resend-reached`	You have reached the maximum number of retries to send this token.
`user-profile-locked`	The user profile is temporarily locked.

403

Most 403 responses are the response of missing authentication (the system can verify the requesting user, but that user lacks the required permissions or entitlements to the requested resource).

Storefront Gateway Business Code	Description
`ACCESS_FORBIDDEN`	Access is denied. You do not have the required permissions to access this Storefront Gateway resource.
`security-challenge failed`	You are not authorized to access the specified Storefront Gateway entity.

404

Most 404 responses are the result of an incorrect resource identifier or search criteria in the request.

Storefront Gateway Business Code	Description
`entity-not-found`	The specified Storefront Gateway entity was not found.
`account-not-found`	The specified Storefront Gateway Account was not found.
`subscription-not-found`	The specified Storefront Gateway subscription was not found.
`feature-not-found`	The specified Storefront Gateway Feature was not found.
`group-not-found`	The specified Storefront Gateway Group was not found.
`user-not-found`	The specified Storefront Gateway user was not found.
`runtime-not-found`	The specified Storefront Gateway Runtime (entity) was not found.
`resource-not-found`	The requested resource was not found.
`roleGroup-not-found`	The requested RoleGroup, specified by the given ID number, was not found.
`restClientRuntime-not-found`	The specified runtime (device, client browser) was not found.
`partner-not-found`	The specified Storefront Gateway Privacy Partner was not found.
`ulm-process-X-not-registered`	The requested Storefront Gateway process is not registered, where X is the process ID.
`ulm-process-X-not-started`	The requested Storefront Gateway process has not been started, where X is the process ID.

409

Most 409 responses are the result of a data conflict based on user input.

Storefront Gateway Business Code	Description
`already-exist-object`	An object in the PUT/POST request already exists in the Storefront Gateway database.
`conflict-with-the-current-state-of-the-target-resource`	An object’s data in the PUT/POST request conflicts with that object’s data in the Storefront Gateway database.

Field Validation Errors

Many Storefront Gateway business codes are pre-defined for very specific issues that result in a failed or denied API request. However, Storefront Gateway also dynamically generates error codes to respond to input-based field validation errors. The payload for each type of payload will generally look the same, but a field validation error might also include the specified field that causes a failed request.

**Business error sample payload**
{
   "operationError": {
      "code": "security-challenge failed",
      "message": "You lack the authorization level required to perform the desired task on the target resource."
    }
}

**Validation error sample payload**
{ 
   "fieldErrors": [ 
      { 
         "field": "username", 
         "code": "NotEmpty.newUserDto.username", 
         "message": "This field can not be empty" 
      }, 
      { 
         "field": "email", 
         "code": "InvalidFormat.newUserDto.emaile", 
         "message": "This field must have a proper email format" 
      } 
   ] 
}

Parent topic:Status Codes and Errors

Home

Introduction

For Merchants

For Resellers

Partner Ecosystem Management

Commerce Engine

Storefront Experience

APIs

400

401

403

404

409

Field Validation Errors

​400

​401

​403

​404

​409

​Field Validation Errors

400

401

403

404

409

Field Validation Errors