SAP Commerce Cloud OCC Reference

https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/
Admin
OCC (Omni Commerce Connect) is an API that exposes commerce and data services, enabling integration...
Tokens:12,127
Snippets:122
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Payment Information Request Body

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Example request body for adding payment information to a cart.

```json
{
	“accountHolderName”: “John Doe”,
	“cardNumber”: “4111111111111111”,
	“cardType”: “visa”,
	“expiryMonth”: “01”,
	“expiryYear”: “2017”,
	“saved”: “true”,
	“defaultPaymentInfo”: “true”,
	“billingAddress”:
	{
		“titleCode”: “mr”,
		“firstName”: “John”,
		“lastName”: “Doe”,
		“line1”: “Toyosaki”,
		“line2”: “3-16-19",
		“postalCode”: “531-0072",
		“town”: “Osaka”,
		“country”:
		{
			“isocode”: “JP”
		}
		“region”:
		{
			“isocode”: “JP-27"
		}
	}
}
```

--------------------------------

### Add Address Request and Validation Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Example of an address creation request and the corresponding validation error response for missing required fields.

```json
{
  "line1": "Toyosaki",
  "line2": "3-16-19",
  "town": "Osaka",
  "postalCode": "531-0072",
  "country": {
    "isocode": "JP"
  }
}
```

```json
{

    "errors": [

        {

            "message": "This field is required and must to be between 1 and 255 characters long.",

            "reason": "missing",

            "subject": "firstName",

            "subjectType": "parameter",

            "type": "ValidationError"

        },

        {

            "message": "This field is required and must to be between 1 and 255 characters long.",

            "reason": "missing",

            "subject": "lastName",

            "subjectType": "parameter",

            "type": "ValidationError"

        },

        {

            "message": "This field is required and must to be between 1 and 7 characters long.",

            "reason": "missing",

            "subject": "region.isocode",

            "subjectType": "parameter",

            "type": "ValidationError"

        }

    ]

}
```

--------------------------------

### Invalid Country Code Request

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Example request body containing an invalid country isocode.

```json
{
  "firstName": "John",
  "lastName": "Doe",
  "titleCode": "mr",
  "line1": "Toyosaki",
  "line2": "3-16-19",
  "town": "Osaka",
  "postalCode": "531-0072",
  "country": {
    "isocode": "tt"
  }
}
```

--------------------------------

### Add Payment Information Request and Validation Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Example of a payment information request and the resulting validation error response for missing card details.

```json
{
  "accountHolderName": "John Doe",
  "cardNumber": "4111111111111111",
  "expiryMonth": "01",
  "billingAddress": {
    "titleCode": "mr",
    "firstName": "John",
    "lastName": "Doe",
    "line1": "Toyosaki",
    "line2": "3-16-19",
    "town": "Osaka",
    "region": {
      "isocode": "JP-27"
    },
    "postalCode": "531-0072",
    "country": {
      "isocode": "JP"
    }
  }
}
```

```json
{

    "errors": [

        {

            "message": "This field is required.",

            "reason": "missing",

            "subject": "cardType.code",

            "subjectType": "parameter",

            "type": "ValidationError"

        },

        {

            "message": "This field is required.",

            "reason": "missing",

            "subject": "expiryYear",

            "subjectType": "parameter",

            "type": "ValidationError"

        }

    ]

}
```

--------------------------------

### Getting All Billing Countries

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/16cf9e658550452d8c58dcf85ac3dddb.html

Retrieves a list of all countries that are defined for billing purposes. This is useful for populating address forms where billing is permitted.

```APIDOC
## GET /countries?type=billing

### Description
Retrieves a list of all countries defined for billing.

### Method
GET

### Endpoint
https://{HOST}:9002/occ/v2/{baseSiteId}/countries?type=billing

### Query Parameters
- **type** (string) - Required - Specifies to retrieve billing countries. Use 'billing'.

### Response
#### Success Response (200)
- **countries** (array) - A list of country objects, each containing 'isocode' and 'name'.

### Response Example
```json
{
    "countries": [
        {
            "isocode": "AL",
            "name": "Albania"
        },
        {
            "isocode": "AD",
            "name": "Andorra"
        },
        {
            "isocode": "AT",
            "name": "Austria"
        }
    ]
}
```
```

--------------------------------

### Getting All Countries

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/16cf9e658550452d8c58dcf85ac3dddb.html

Retrieves a list of all countries defined in SAP Commerce Cloud, without specifying a type. This provides a comprehensive list of all available countries.

```APIDOC
## GET /countries

### Description
Retrieves a list of all countries defined in SAP Commerce Cloud.

### Method
GET

### Endpoint
https://{HOST}:9002/occ/v2/{baseSiteId}/countries

### Response
#### Success Response (200)
- **countries** (array) - A list of country objects, each containing 'isocode' and 'name'.

### Response Example
```json
{
    "countries": [
        {
            "isocode": "AL",
            "name": "Albania"
        },
        {
            "isocode": "AD",
            "name": "Andorra"
        },
        {
            "isocode": "AT",
            "name": "Austria"
        }
    ]
}
```
```

--------------------------------

### Response for Billing Countries REST API

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/16cf9e658550452d8c58dcf85ac3dddb.html

This is an example of the JSON response generated when requesting billing countries. It includes the country's ISO code and name.

```JSON
{
    "countries": [
        {
            "isocode": "AL",
            "name": "Albania"
        },
        {
            "isocode": "AD",
            "name": "Andorra"
        },
        {
            "isocode": "AT",
            "name": "Austria"
        },
        ...
}
```

--------------------------------

### Getting All Delivery Countries

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/16cf9e658550452d8c58dcf85ac3dddb.html

Retrieves a list of all countries that are defined for delivery. This is useful for ensuring that shipments are only sent to valid delivery locations.

```APIDOC
## GET /countries?type=shipping

### Description
Retrieves a list of all countries defined for delivery.

### Method
GET

### Endpoint
https://{HOST}:9002/occ/v2/{baseSiteId}/countries?type=shipping

### Query Parameters
- **type** (string) - Required - Specifies to retrieve delivery countries. Use 'shipping'.

### Response
#### Success Response (200)
- **countries** (array) - A list of country objects, each containing 'isocode' and 'name'.

### Response Example
```json
{
    "countries": [
        {
            "isocode": "AL",
            "name": "Albania"
        },
        {
            "isocode": "AD",
            "name": "Andorra"
        },
        {
            "isocode": "AT",
            "name": "Austria"
        }
    ]
}
```
```

--------------------------------

### GET /occ/v2/{baseSiteId}/customergroups/{groupId}

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Retrieves information about a customer group. Returns an InvalidCustomerGroupError if the requested group is not a sub-group of the customergroup.

```APIDOC
## GET /occ/v2/{baseSiteId}/customergroups/{groupId}

### Description
Retrieves details for a specific customer group. If the requested group is not a sub-group of the customergroup, an error is returned.

### Method
GET

### Endpoint
/occ/v2/{baseSiteId}/customergroups/{groupId}

### Response
#### Error Response (400)
- **errors** (array) - A list of error objects.
- **message** (string) - The error message.
- **type** (string) - The error type, specifically 'InvalidCustomerGroupError'.

#### Response Example
{
    "errors": [
        {
            "message": "The application has encountered an error",
            "type": "InvalidCustomerGroupError"
        }
    ]
}
```

--------------------------------

### Get All Delivery Countries REST API Call

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/16cf9e658550452d8c58dcf85ac3dddb.html

Retrieve a list of all countries defined for delivery by specifying type=shipping in the request.

```HTTP
https://{HOST}:9002/occ/v2/{baseSiteId}/countries?type=shipping
```

--------------------------------

### Get All Countries REST API Call

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/16cf9e658550452d8c58dcf85ac3dddb.html

Fetch a list of all countries defined in SAP Commerce Cloud by omitting the type parameter.

```HTTP
https://{HOST}:9002/occ/v2/{baseSiteId}/countries
```

--------------------------------

### Retrieve Return Requests - OCC API

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/48d55e5c0c834b5d83876d57ab5a5a3a.html

This GET request retrieves all return requests associated with the current user. Useful for checking the status of existing returns.

```http
GET https://localhost:9002/occ/v2/electornics/users/current/orderReturns?fields=DEFAULT
```

--------------------------------

### Retrieve Order Details - OCC API

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/48d55e5c0c834b5d83876d57ab5a5a3a.html

Use this GET request to retrieve the details of a specific order. The response includes flags like 'cancellable' or 'returnable' if applicable.

```http
GET https://localhost:9002/occ/v2/electornics/users/current/orders/00000001?fields=DEFAULT
```

--------------------------------

### Get All Billing Countries REST API Call

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/16cf9e658550452d8c58dcf85ac3dddb.html

Use this endpoint to retrieve a list of all countries defined for billing. This is useful for populating address forms.

```HTTP
https://{HOST}:9002/occ/v2/{baseSiteId}/countries?type=billing
```

--------------------------------

### GET v2/{site}/feeds/orders/statusfeed

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/e6211f3f15db41af9fcb7289d1bec1ca.html

Retrieves order status updates for a specified base site that have been updated after the provided timestamp. This endpoint requires the TRUSTED_CLIENT role.

```APIDOC
## GET v2/{site}/feeds/orders/statusfeed

### Description
Retrieves order status updates for a specified base site that have been updated after the provided timestamp. This endpoint is restricted to the TRUSTED_CLIENT role.

### Method
GET

### Endpoint
v2/{site}/feeds/orders/statusfeed

### Parameters
#### Path Parameters
- **site** (string) - Required - The identifier of the base site.

#### Query Parameters
- **timestamp** (string) - Required - The ISO 8601 formatted timestamp (e.g., 2013-12-12T12:00:00Z) to filter updates.
```

--------------------------------

### Run OCC AddOn Converter as a JAR File

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/f7b37faa192d4110bffa10530f1c9e36.html

Execute the converter using the packaged JAR file after building it with Gradle.

```batch
gradlew.bat jar;

java -jar build\libs\occ-addon-converter.jar ^
--addondir "C:\Projects\xyoccaddon" ^
--extdir "C:\Projects\xyzocc" ^
--stepsdir "C:\Projects\customSteps" & :: stepsdir is optional
```

```bash
./gradlew jar;

java -jar build/libs/occ-addon-converter.jar \
--addondir "/Projects/xyoccaddon" \
--extdir "/Projects/xyzocc" \
--stepsdir "/Projects/customSteps" # stepsdir is optional
```

--------------------------------

### Run OCC AddOn Converter from Source Code

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/f7b37faa192d4110bffa10530f1c9e36.html

Execute the converter directly from the source code using the Gradle run task.

```batch
gradlew.bat run --args="--addondir ""C:\Projects\xyoccaddon"" --extdir ""C:\Projects\xyzocc"" --stepsdir ""C:\Projects\customSteps"""
```

```bash
./gradlew run --args="--addondir \"/Projects/xyoccaddon\" --extdir \"/Projects/xyzocc\" --stepsdir \"/Projects/customSteps\""
```

--------------------------------

### Unknown Resource Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Returned when the requested path does not correspond to an existing resource.

```json
{

    "errors": [

        {

            "message": "There is no resource for path /occ/v2/electronics/methodDoesNotExist",

            "type": "UnknownResourceError"

        }

    ]

}
```

--------------------------------

### Register OAuth Clients for Basic Permissions

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/0f587775a7ea4de29c30ac552eadbfdf.html

Use this ImpEx to define OAuth clients with basic scopes for standard interactive documentation access.

```ImpEx
INSERT_UPDATE OAuthClientDetails;clientId[unique=true]    ;resourceIds       ;scope        ;authorizedGrantTypes                                            ;authorities             ;clientSecret    ;registeredRedirectUri
                                ;<oAuthClientId1>              ;hybris            ;basic        ;implicit,client_credentials                                     ;ROLE_CLIENT             ;<oAuthClientSecret>          ;http://localhost:9001/authorizationserver/oauth2_implicit_callback;
                                ;<oAuthClientId2>           ;hybris            ;basic        ;authorization_code,refresh_token,password,client_credentials    ;ROLE_CLIENT             ;<oAuthClientSecret>          ;http://localhost:9001/authorizationserver/oauth2_callback; 
```

--------------------------------

### Product Not Found Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Response when a product with the specified code cannot be found.

```json
{

    "errors": [ 

        { 

            "message": "Product with code '13820867876' not found!", 

            "type": "UnknownIdentifierError" 

        } 

    ] 

}
```

--------------------------------

### Return an Order

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/48d55e5c0c834b5d83876d57ab5a5a3a.html

Endpoints for initiating and managing order returns.

```APIDOC
## GET /occ/v2/electornics/users/current/orders/{orderId}

### Description
Returns the details of the order with the specified code. The flag `returnable` indicates if the order can be returned.

### Method
GET

### Endpoint
https://localhost:9002/occ/v2/electornics/users/current/orders/00000001

### Query Parameters
- **fields** (string) - Optional - `DEFAULT`

### Authorization
User OAuth token

### Response
#### Success Response (200)
- **returnable** (boolean) - Indicates if the order is returnable.
```

```APIDOC
## POST /occ/v2/electornics/users/current/orderReturns

### Description
Creates a return request for specified order entries of an order.

### Method
POST

### Endpoint
https://localhost:9002/occ/v2/electornics/users/current/orderReturns

### Request Body
- **orderCode** (string) - Required - The code of the order for which to create a return request.
- **returnRequestEntryInputs** (array) - Required - An array of objects, each specifying the order entry number and the quantity to return.
  - **orderEntryNumber** (integer) - Required - The number of the order entry to return.
  - **quantity** (integer) - Required - The quantity to return for the specified order entry.

### Request Example
```json
{
    "orderCode": "00000001",
    "returnRequestEntryInputs": [
        {
            "orderEntryNumber": 0,
            "quantity": 1
        },
        {
            "orderEntryNumber": 1,
            "quantity": 1
        }
    ]
}
```

### Authorization
User OAuth token
```

--------------------------------

### Invalid Grant Credentials Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Returned when customer credentials are missing or incorrect.

```json
<message>Bad { 

    "error": "invalid_grant", 

    "error_description": "Bad credentials" 

} 
```

--------------------------------

### Unsupported Promotion Type Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Response when an unsupported promotion type parameter is provided.

```json
{

    "errors": [ 

        { 

            "message": "Parameter type=unknownType is not supported. Permitted values for this parameter are : 'order', 'product' or 'all'", 

            "reason": "invalid", 

            "subject": "type", 

            "subjectType": "parameter", 

            "type": "ValidationError" 

        } 

    ] 

}
```

--------------------------------

### Store Not Found Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Response when a store with the specified ID does not exist.

```json
{

    "errors": [ 

        { 

            "message": "No PointOfService with name WRONG_ID, type STORE found in baseStore electronics", 

            "type": "UnknownIdentifierError" 

        } 

    ] 

}
```

--------------------------------

### Non-existent Base Site Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Response when the requested base site ID does not exist.

```json
{

    "errors": [ 

        { 

            "message": "Base site wrongBaseSite doesn't exist", 

            "type": "InvalidResourceError" 

        } 

    ] 

}
```

--------------------------------

### Register OAuth Client for Extended Permissions

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/0f587775a7ea4de29c30ac552eadbfdf.html

Use this ImpEx to define an OAuth client with extended scopes for documentation features requiring higher privileges.

```ImpEx
INSERT_UPDATE OAuthClientDetails;clientId[unique=true]    ;resourceIds       ;scope        ;authorizedGrantTypes                                            ;authorities             ;clientSecret    ;registeredRedirectUri 
                                ;<oAuthClientId3>           ;hybris            ;extended     ;authorization_code,refresh_token,password,client_credentials    ;ROLE_TRUSTED_CLIENT     ;<oAuthClientSecret>;         ; 
```

--------------------------------

### Password Mismatch Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Response when the provided password does not match the stored credentials.

```json
{

    "errors": [ 

        { 

            "message": "de.hybris.platform.commerceservices.customer.PasswordMismatchException: test1@test.com ", 

            "type": "PasswordMismatchError" 

        } 

    ] 

} 

 
```

--------------------------------

### InsufficientStockError Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Error response returned when a product is out of stock or has insufficient quantity for an operation.

```json
{ 

    "errors": [ 

        { 

            "message": "Product [816780] is currently out of stock", 

            "reason": "noStock", 

            "subject": "816780", 

            "subjectType": "product", 

            "type": "InsufficientStockError" 

        } 

    ] 

}
```

```json
{ 

    "errors": [ 

        { 

            "message": "Product [812888] is currently out of stock", 

            "reason": "noStock", 

            "subject": "0", 

            "subjectType": "entry", 

            "type": "InsufficientStockError" 

        } 

    ] 

}
```

```json
{ 

    "errors": [ 

        { 

            "message": "Not enough product [280916] in stock (there is only 360 available)", 

            "reason": "lowStock", 

            "subject": "2", 

            "subjectType": "entry", 

            "type": "InsufficientStockError" 

        } 

    ] 

}
```

--------------------------------

### Method Not Allowed Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Returned when the HTTP method used is not supported for the requested resource.

```json
{

    "errors": [

        {

            "message": "Request method 'PUT' not supported",

            "type": "HttpRequestMethodNotSupportedError"

        }

    ]

}
```

--------------------------------

### Implement Order Status Update in Action Class

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/e6211f3f15db41af9fcb7289d1bec1ca.html

Extend your order process action to send order status updates to the channel after a status change occurs.

```java
/**
 * This action implements payment authorization using {@link CreditCardPaymentInfoModel}. Any other payment model could
 * be implemented here, or in a separate action, if the process flow differs.
 */
public class CheckAuthorizeOrderPaymentAction extends AbstractSimpleDecisionAction<OrderProcessModel>
{
    private MessageChannel productExpressUpdateChannel; // channel has to be injected here
  
    @Override
    public Transition executeAction(final OrderProcessModel process)
    {
        final OrderModel order = process.getOrder();
        if (order != null)
        {
            if (order.getPaymentInfo() instanceof InvoicePaymentInfoModel)
            {
                return Transition.OK;
            }
            else
            {
                for (final PaymentTransactionModel transaction : order.getPaymentTransactions())
                {
                    for (final PaymentTransactionEntryModel entry : transaction.getEntries())
                    {
                        if (entry.getType().equals(PaymentTransactionType.AUTHORIZATION)
                                && TransactionStatus.ACCEPTED.name().equals(entry.getTransactionStatus()))
                        {
                            order.setStatus(OrderStatus.PAYMENT_AUTHORIZED);
                            modelService.save(order);
                            sendOrderToChannel(order); // send a message to the order status update queue
                            return Transition.OK;
                        }
                    }
                }
            }
        }
        return Transition.NOK;
    }
      
    /**
    * This method helps sending spring message to the orderStatusUpdateChannel
    */
    protected boolean sendOrderToChannel(final OrderModel order)
    {
        try
        {
            final Message<OrderModel> message = MessageBuilder.withPayload(order).build();
            return getOrderStatusUpdateChannel().send(message);
        }
        catch (final MessageDeliveryException exception)
        {
            LOG.warn("Probably there is no listener for orderStatusUpdateChannel", exception);
        }
        return false;
    }
      
    /* ... */
}
```

--------------------------------

### Inject Message Channel in Spring Configuration

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/e6211f3f15db41af9fcb7289d1bec1ca.html

Configure the action bean in order-process-spring.xml to inject the orderStatusUpdateChannel.

```xml
<bean id="checkAuthorizeOrderPaymentAction" class="de.hybris.platform.yacceleratorfulfilmentprocess.actions.order.CheckAuthorizeOrderPaymentAction"  parent="abstractAction">
    <property name="orderStatusUpdateChannel" ref="orderStatusUpdateChannel"/>  
</bean>
```

--------------------------------

### Invalid User Registration Request

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Request body for user registration with an incorrect UID.

```json
{
  "uid": "WRONG_UID",
  "firstName": "John",
  "lastName": "Doe",
  "titleCode": "mr",
  "password": "#JD123456"
}
```

--------------------------------

### Invalid Client Credentials Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Returned when client_id or client_secret are incorrect during token requests.

```json
{

    "error": "invalid_client",

    "error_description": "Bad client credentials"

}
```

--------------------------------

### Address Creation with Invalid Title

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Request body for creating an address with an invalid title code.

```json
{
  "firstName": "John",
  "lastName": "Doe",
  "titleCode": "WRONG_ID",
  "line1": "Toyosaki",
  "line2": "3-16-19",
  "town": "Osaka",
  "postalCode": "531-0072",
  "country": {
    "isocode": "JP"
  }
}
```

--------------------------------

### Invalid Payment Info Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

JSON response for an InvalidPaymentInfoError when payment details cannot be set.

```json
{

    "errors": [ 

        { 

            "message": "The application has encountered an error", 

            "type": "InvalidPaymentInfoError" 

        } 

    ] 

}
```

--------------------------------

### Invalid Title Identifier Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Response when the provided title code is not recognized.

```json
{

   "errors" : [ { 

      "message" : "No result for the given example [TitleModel (&lt;unsaved&gt;)] was found. Searched with these attributes: {code=WRONG_ID}", 

      "type" : "UnknownIdentifierError" 

   } ] 

}
```

--------------------------------

### InsufficientStockError - Product Out of Stock

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Error response returned when a product is out of stock or has insufficient quantity during cart operations or order placement.

```APIDOC
## POST /occ/v2/{baseSiteId}/users/current/carts/current/entries

### Description
Returns an InsufficientStockError when adding a product that is currently out of stock.

### Response
#### Error Response (400)
- **errors** (array) - List of error objects

#### Response Example
{
	"errors": [
		{
			"message": "Product [816780] is currently out of stock",
			"reason": "noStock",
			"subject": "816780",
			"subjectType": "product",
			"type": "InsufficientStockError"
		}
	]
}
```

--------------------------------

### Create Order Return Request - OCC API

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/48d55e5c0c834b5d83876d57ab5a5a3a.html

Use this POST request to create a return request for an order. You can specify multiple order entries and quantities for the return.

```http
POST https://localhost:9002/occ/v2/electornics/users/current/orderReturns
```

```json
{
    "orderCode": "00000001",
    "returnRequestEntryInputs": [
        {
            "orderEntryNumber": 0,
            "quantity": 1
        },
        {
            "orderEntryNumber": 1,
            "quantity": 1
        }
    ]
}
```

--------------------------------

### Invalid Store Name Validation Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Validation error response when a provided store name does not exist in the system.

```json
{

    "errors": [

        {

            "message": "Store with given name doesn't exist",

            "reason": "invalid",

            "subject": "entry",

            "subjectType": "parameter",

            "type": "ValidationError"

        }

    ]

}
```

--------------------------------

### Cart Entry Not Found Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Response when the requested cart entry number does not exist in the current cart.

```json
{

    "errors": [ 

        { 

            "message": "Entry not found",
```

--------------------------------

### Add Review Validation Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Validation error response returned when required fields for a product review are missing.

```json
{

    "errors": [

        {

            "message": "This field is required.",

            "reason": "missing",

            "subject": "headline",

            "subjectType": "parameter",

            "type": "ValidationError"

        },

        {

            "message": "This field is required.",

            "reason": "missing",

            "subject": "comment",

            "subjectType": "parameter",

            "type": "ValidationError"

        },

        {

            "message": "This field is required.",

            "reason": "missing",

            "subject": "rating",

            "subjectType": "parameter",

            "type": "ValidationError"

        }

    ]

}
```

--------------------------------

### Missing Request Parameter Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Returned when a required parameter is missing from the request.

```json
{

    "errors": [

        {

            "message": "Required request parameter 'timestamp' for method parameter type String is not present",

            "type": "MissingServletRequestParameterError"

        }

    ]

}
```

--------------------------------

### CartError - No Cart Found

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Error response returned when an operation requires a cart but none exists, such as adding payment details or placing an order.

```APIDOC
## POST /occ/v2/{baseSiteId}/users/current/carts/current/paymentdetails

### Description
Returns a CartError when attempting to add payment information to a non-existent cart.

### Response
#### Error Response (400)
- **errors** (array) - List of error objects

#### Response Example
{
	"errors": [
		{
			"message": "No cart created yet.",
			"reason": "notFound",
			"type": "CartError"
		}
	]
}
```

--------------------------------

### Unauthorized Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Returned when authentication is missing or the user lacks sufficient rights.

```json
{

    "errors": [

        {

            "message": "Full authentication is required to access this resource",

            "type": "UnauthorizedError"

        }

    ]

}
```

--------------------------------

### Invalid Email Format Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Response when the UID field does not contain a valid email address.

```json
{

    "errors": [ 

        { 

            "message": "This field is not a valid email address.", 

            "reason": "invalid", 

            "subject": "uid", 

            "subjectType": "parameter", 

            "type": "ValidationError" 

        } 

    ] 

}
```

--------------------------------

### Forbidden Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Returned when access to a specific resource is denied.

```json
{

    "errors": [

        {

            "message": "Access is denied",

            "type": "ForbiddenError"

        }

    ]

}
```

--------------------------------

### Cancel an Order

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/48d55e5c0c834b5d83876d57ab5a5a3a.html

Endpoints for initiating and managing order cancellations.

```APIDOC
## GET /occ/v2/electornics/users/current/orders/{orderId}

### Description
Returns the details of the order with the specified code. The flag `cancellable` indicates if the order can be cancelled.

### Method
GET

### Endpoint
https://localhost:9002/occ/v2/electornics/users/current/orders/00000001

### Query Parameters
- **fields** (string) - Optional - `DEFAULT`

### Authorization
User OAuth token

### Response
#### Success Response (200)
- **cancellable** (boolean) - Indicates if the order is cancellable.
```

```APIDOC
## POST /occ/v2/electornics/users/current/orders/{orderId}/cancellation

### Description
Creates a request to cancel a specified quantity of an order entry for a given order.

### Method
POST

### Endpoint
https://localhost:9002/occ/v2/electornics/users/current/orders/00000001/cancellation

### Request Body
- **cancellationRequestEntryInputs** (array) - Required - An array of objects, each specifying the order entry number and the quantity to cancel.
  - **orderEntryNumber** (integer) - Required - The number of the order entry to cancel.
  - **quantity** (integer) - Required - The quantity to cancel for the specified order entry.

### Request Example
```json
{
    "cancellationRequestEntryInputs": [
        {
            "orderEntryNumber": 0,
            "quantity": 1
        }
    ]
}
```

### Authorization
User OAuth token
```

--------------------------------

### Unsupported Delivery Mode Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

JSON response for an UnsupportedDeliveryModeError when the requested delivery mode is not supported for the current cart.

```json
{

    "errors": [ 

        { 

            "message": "Delivery Mode [express-gross] is not supported for the current cart", 

            "type": "UnsupportedDeliveryModeError" 

        } 

    ] 

}
```

--------------------------------

### Invalid Token Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Returned when the provided authorization token is incorrect or expired.

```json
{

    "errors": [

        {

            "type": "InvalidTokenError",

            "message": "Invalid access token"

        }

    ]

}
```

```json
{

    "errors": [

        {

            "type": "InvalidTokenError",

            "message": "Access token expired"

        }

    ]

}
```

--------------------------------

### VoucherOperationError Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Error response returned when an issue occurs while applying or managing vouchers.

```json
{ 

    "errors": [ 

        { 

            "message": "coupon.invalid.code.provided", 

            "type": "VoucherOperationError" 

        } 

    ] 

}
```

```json
{ 

    "errors": [ 

        { 

            "message": "coupon.already.exists.cart", 

            "type": "VoucherOperationError" 

        } 

    ] 

}
```

--------------------------------

### Invalid Country Code Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Response when a provided country code is not found.

```json
{

    "errors": [ 

        { 

            "message": "No country with the code tt found.", 

            "type": "ConversionError" 

        } 

    ] 

}
```

--------------------------------

### Invalid Timestamp Format Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Response when the timestamp parameter does not follow the ISO-8601 format.

```json
{

    "errors": [ 

        { 

            "message": "Wrong time format. The only accepted format is ISO-8601.", 

            "reason": "invalid", 

            "subject": "timestamp", 

            "subjectType": "parameter", 

            "type": "ValidationError" 

        } 

    ] 

}
```

--------------------------------

### Unsupported Grant Type Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Returned when an invalid grant type is provided in the token request.

```json
{

    "error": "unsupported_grant_type",

    "error_description": "Unsupported grant type"

}
```

--------------------------------

### Modify Import Statements in OCC Extension

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/f7b37faa192d4110bffa10530f1c9e36.html

Uses AntBuilder to replace import statements within the target extension directory. Ensure the script is placed in the directory specified by the --stepsdir flag.

```groovy
ant.echo("Converting: $ctx.ADDON_NAME to $ctx.EXTENSION_NAME")
ant.replace(dir: ctx.EXTENSION_DIRECTORY, token: 'import com.example.old.occ.module', value: 'import com.example.new.occ.module')
```

--------------------------------

### XML Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

XML format error response for CommerceCartModificationError.

```xml
<?xml version="1.0" encoding="UTF-16"?>
<errors>
    <error>
        <message>Unknown entry number</message>
        <type>CommerceCartModificationError</type>
    </error>
</errors>
```

--------------------------------

### Missing Grant Type Error

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Returned when the grant type parameter is missing from the request.

```json
<errors> { 

    "error": "invalid_request", 

    "error_description": "Missing grant type" 

} 
```

--------------------------------

### General Cart Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

JSON response for a CartError when no cart exists during checkout or voucher operations.

```json
{

    "errors": [ 

        { 

            "message": "No cart created yet.", 

            "reason": "notFound", 

            "type": "CartError" 

        } 

    ] 

}
```

```json
{

    "errors": [ 

        { 

            "message": "No cart created yet.", 

            "reason": "notFound", 

            "type": "CartError" 

        } 

    ] 

}
```

--------------------------------

### Cancel a Return Request

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/48d55e5c0c834b5d83876d57ab5a5a3a.html

Endpoints for retrieving and cancelling return requests.

```APIDOC
## GET /occ/v2/electornics/users/current/orderReturns

### Description
Returns the list of return requests for the current user.

### Method
GET

### Endpoint
https://localhost:9002/occ/v2/electornics/users/current/orderReturns

### Query Parameters
- **fields** (string) - Optional - `DEFAULT`

### Authorization
User OAuth token
```

```APIDOC
## GET /occ/v2/electornics/users/current/orderReturns/{returnRequestId}

### Description
Returns the details of a specific return request. The flag `cancellable` indicates if the return request can be cancelled.

### Method
GET

### Endpoint
https://localhost:9002/occ/v2/electornics/users/current/orderReturns/00000001

### Query Parameters
- **fields** (string) - Optional - `DEFAULT`

### Authorization
User OAuth token

### Response
#### Success Response (200)
- **cancellable** (boolean) - Indicates if the return request is cancellable.
```

```APIDOC
## PATCH /occ/v2/electornics/users/current/orderReturns/{returnRequestId}

### Description
Cancels the specified return request.

### Method
PATCH

### Endpoint
https://localhost:9002/occ/v2/electornics/users/current/orderReturns/00000001

### Request Body
- **status** (string) - Required - The status to set for cancelling the return request, e.g., `"CANCELLING"`.

### Request Example
```json
{"status":"CANCELLING"}
```

### Authorization
User OAuth token
```

--------------------------------

### CartError Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Error response returned when a requested cart does not exist or is not found.

```json
{ 

    "errors": [ 

        { 

            "message": "No cart created yet.", 

            "reason": "notFound", 

            "type": "CartError" 

        } 

    ] 

}
```

```json
{ 

    "errors": [ 

        { 

            "message": "Cart is not anonymous", 

            "reason": "cannotRestore", 

            "subject": "e6370a43-cdef-40e4-a624-788a4c27b333", 

            "subjectType": "cart", 

            "type": "CartError" 

        } 

    ] 

}
```

--------------------------------

### Cart Validation Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

JSON response for a CartError when required information like delivery mode or payment info is missing during order placement.

```json
{

    "errors": [ 

        { 

            "message": "Delivery mode is not set", 

            "reason": "invalid", 

            "subject": "sessionCart", 

            "subjectType": "parameter", 

            "type": "ValidationError" 

        }, 

        { 

            "message": "Payment info is not set", 

            "reason": "invalid", 

            "subject": "sessionCart", 

            "subjectType": "parameter", 

            "type": "ValidationError" 

        } 

    ] 

}
```

--------------------------------

### Declare Order Status Update Channel

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/e6211f3f15db41af9fcb7289d1bec1ca.html

Add this channel declaration to your yacceleratorfullfilmentprocess-spring.xml file to enable communication via the Spring Messaging System.

```xml
<!--Order Status Update Queue functionality -->
<int:channel id="orderStatusUpdateChannel"/>
```

--------------------------------

### Create Order Cancellation Request - OCC API

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/48d55e5c0c834b5d83876d57ab5a5a3a.html

Submit a POST request to create a cancellation request for an order. Specify the order entry number and quantity to cancel.

```http
POST https://localhost:9002/occ/v2/electornics/users/current/orders/00000001/cancellation
```

```json
{
    "cancellationRequestEntryInputs": [
        {
            "orderEntryNumber": 0,
            "quantity": 1
        }
    ]
}
```

--------------------------------

### Standard Error Responses

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Overview of common HTTP error codes and their associated error message structures returned by the API.

```APIDOC
## Standard Error Handling

### Authentication and Authorization Errors
- **401 Unauthorized**: Returned when authentication is missing, incorrect, expired, or when client credentials (client_id, client_secret) are invalid.
- **403 Forbidden**: Returned when the request is authenticated but the user lacks the necessary permissions for the resource.

### Bad Request and Resource Errors
- **400 Bad Request**: Returned for missing required parameters, invalid grant types, or invalid customer credentials.
- **404 Not Found**: Returned when the requested resource path does not exist.
- **405 Method Not Allowed**: Returned when the HTTP method used is not supported for the specific endpoint.

### Error Response Structure
Most errors follow this JSON format:
```json
{
  "errors": [
    {
      "message": "Error description",
      "type": "ErrorType"
    }
  ]
}
```
```

--------------------------------

### VoucherOperationError - Invalid Voucher

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Error response returned when an operation involving a voucher fails, such as applying a non-existent code.

```APIDOC
## POST /occ/v2/{baseSiteId}/users/current/carts/current/vouchers

### Description
Returns a VoucherOperationError when attempting to apply a voucher code that does not exist.

### Response
#### Error Response (400)
- **errors** (array) - List of error objects

#### Response Example
{
	"errors": [
		{
			"message": "coupon.invalid.code.provided",
			"type": "VoucherOperationError"
		}
	]
}
```

--------------------------------

### XML Error Response Format

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Represents an error list using XML tags. Each error entry contains fields for message, reason, subject, subjectType, and type.

```xml
<errorList>
    <errors>
        <message>...</message>
        <reason>...</reason>
        <subject>...</subject>
        <subjectType>...</subjectType>
        <type>...</type>
    </errors>

    <errors>
    ...
    </errors>    

    ...
</errorList>
```

--------------------------------

### Access Order Status Update REST Endpoint

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/e6211f3f15db41af9fcb7289d1bec1ca.html

The endpoint requires the TRUSTED_CLIENT role and returns order status updates for a specific site after the provided timestamp.

```http
GET v2/{site}/feeds/orders/statusfeed?timestamp=2013-12-12T12%3A00%3A00Z
```

--------------------------------

### Retrieve Specific Return Request - OCC API

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/48d55e5c0c834b5d83876d57ab5a5a3a.html

Fetches the details of a specific return request using its code. The response indicates if the return request is cancellable.

```http
GET https://localhost:9002/occ/v2/electornics/users/current/orderReturns/00000001?fields=DEFAULT
```

--------------------------------

### ValidationError Response Structure

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

The API returns a 400 Bad Request status with a list of validation errors when required parameters are missing or contain incorrect values.

```APIDOC
## HTTP 400 Bad Request

### Description
Returns a list of validation errors when a request contains missing or invalid parameters.

### Response
#### Error Response (400)
- **errors** (array) - A list of error objects.
  - **message** (string) - Description of the validation error.
  - **reason** (string) - The reason for the error (e.g., "missing", "invalid").
  - **subject** (string) - The parameter field that caused the error.
  - **subjectType** (string) - The type of the subject (e.g., "parameter").
  - **type** (string) - The error type (e.g., "ValidationError").

### Response Example
{
    "errors": [
        {
            "message": "This field is required.",
            "reason": "missing",
            "subject": "headline",
            "subjectType": "parameter",
            "type": "ValidationError"
        }
    ]
}
```

--------------------------------

### Cart Address Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

JSON response for a CartAddressError when the provided delivery address ID is invalid or inaccessible.

```json
{

    "errors": [ 

        { 

            "message": "Address given by id 1234 is not valid", 

            "reason": "notValid", 

            "subject": "1234", 

            "subjectType": "address", 

            "type": "CartAddressError" 

        } 

    ] 

}
```

--------------------------------

### Cancel Return Request - OCC API

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/48d55e5c0c834b5d83876d57ab5a5a3a.html

Use this PATCH request to cancel an existing return request. The request body should contain the desired status, such as 'CANCELLING'.

```http
PATCH https://localhost:9002/occ/v2/electornics/users/current/orderReturns/00000001
```

```json
{"status":"CANCELLING"}
```

--------------------------------

### JSON Error Response Format

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

Represents an error list using a JSON object containing an array of error objects. Each object maps error attributes to their respective values.

```json
{
  "errors": [
    {
      "message": "...",
      "reason": "...",
      "subject": "...",
      "subjectType": "...",
      "type": "..."
    },
    {
      "message": "...",
      "reason": "...",
      "subject": "...",
      "subjectType": "...",
      "type": "..."
    }
  ]
}
```

--------------------------------

### Cart Error Responses

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

A collection of common error scenarios returned by the Cart API when requests fail validation or business logic requirements.

```APIDOC
## Cart API Error Handling

### Description
This section details common error responses returned by the SAP Commerce Cloud Cart API when operations fail due to validation issues, missing resources, or invalid business states.

### Common Error Response Structure
- **errors** (array) - A list of error objects.
  - **message** (string) - Human-readable description of the error.
  - **reason** (string) - The specific reason for the error (e.g., "invalid", "notFound").
  - **subject** (string) - The field or parameter that caused the error.
  - **subjectType** (string) - The type of the subject (e.g., "parameter", "address").
  - **type** (string) - The specific error type (e.g., "ValidationError", "CartAddressError").

### Example: Validation Error (Quantity)
POST - https://localhost:9002/occ/v2/electronics/users/current/carts/current/entries?product.code=489702&quantity=-2

```json
{
    "errors": [
        {
            "message": "This field must be greater than 0.",
            "reason": "invalid",
            "subject": "quantity",
            "subjectType": "parameter",
            "type": "ValidationError"
        }
    ]
}
```

### Example: Cart Address Error
PUT - https://localhost:9002/rest/v1/electronics/cart/address/delivery/1234

```json
{
    "errors": [
        {
            "message": "Address given by id 1234 is not valid",
            "reason": "notValid",
            "subject": "1234",
            "subjectType": "address",
            "type": "CartAddressError"
        }
    ]
}
```

### Example: Unsupported Delivery Mode
PUT - https://localhost:9002/occ/v2/electronics/users/current/carts/current/deliverymode?deliveryModeId=express-gross

```json
{
    "errors": [
        {
            "message": "Delivery Mode [express-gross] is not supported for the current cart",
            "type": "UnsupportedDeliveryModeError"
        }
    ]
}
```
```

--------------------------------

### Cart Entry Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

JSON response indicating a CartEntryError, typically returned when an entry number is not found.

```json
"reason": "notFound", 

            "subject": "3", 

            "subjectType": "entry", 

            "type": "CartEntryError" 

        } 

    ] 

}
```

--------------------------------

### Validation Error Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

JSON response for a ValidationError when input parameters, such as quantity, are invalid.

```json
{

    "errors": [ 

        { 

            "message": "This field must be greater than 0.", 

            "reason": "invalid", 

            "subject": "quantity", 

            "subjectType": "parameter", 

            "type": "ValidationError" 

        } 

    ] 

}
```

--------------------------------

### InvalidCustomerGroupError JSON Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/3476714bba0b4cb9b3eb58c270e44439/dd27baf370a147cabc5a8887990eb31b.html

The error response body returned when a customer group request fails validation.

```json
{

    "errors": [ 

        { 

            "message": "The application has encountered an error", 

            "type": "InvalidCustomerGroupError" 

        } 

    ] 

}
```
Tokens:
Raw