SAP Commerce Cloud Public Cloud Accelerators

https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/
Admin
SAP Commerce Cloud Accelerators are pre-built modules and extensions that provide B2C and B2B...
Tokens:757,735
Snippets:9,617
Trust Score:9.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Run Default Setup Task for a Recipe

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8c46c266866910149666a0fe4caeee4e.html?locale=en-US&state=PRODUCTION&version=v2211

Use the -r option to execute the default setup task for a specified installer recipe.

```bash
./install.sh -r <recipe>
```

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

### Access Sample Storefronts via URL

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8ab6a84e86691014b935a582ca5ef6fc.html

Examples of how to access the installed sample storefronts using their configured local domains and default ports.

```text
http://apparel-uk.local:9001/yacceleratorstorefront
```

```text
http://apparel-de.local:9001/yacceleratorstorefront
```

```text
http://electronics.local:9001/yacceleratorstorefront
```

```text
http://powertools.local:9001/yb2bacceleratorstorefront
```

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

### Perform SAP Commerce Cloud Installation

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/efe03bafbeb54182b328e9ccdb2ad8a1.html?locale=en-US&state=PRODUCTION&version=v2211

This command compiles, initializes, and starts SAP Commerce Cloud. Ensure you are in the \"<HYBRIS_HOME>/installer\" directory before execution.

```bash
./install.sh -r dhtutorial perform
```

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

### List Available Installer Recipes

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8c46c266866910149666a0fe4caeee4e.html?locale=en-US&state=PRODUCTION&version=v2211

Use the -l option to list all available installer recipes.

```bash
./install.sh -l <recipe>
```

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

### Start SAP Commerce Cloud Server

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8c46c266866910149666a0fe4caeee4e.html?locale=en-US&state=PRODUCTION&version=v2211

Use the -r <recipe> start command to start the SAP Commerce Cloud Server for a specified recipe.

```bash
./install.sh -r <recipe> start
```

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

### Demo Widget Test Class Setup

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8be493da866910148e4f94bf4b9a6e51.html?locale=en-US&state=PRODUCTION&version=v2211

This example demonstrates setting up a test class for a widget, including null-safety configuration, input socket declaration, and view event declaration. It extends AbstractWidgetUnitTest and overrides getWidgetController.

```java
@NullSafeWidget(false)
@DeclaredInput(value = DemoWidgetController.IN_SOCKET, socketType = String.class)
@DeclaredViewEvent(componentID = DemoWidgetController.LAST_SIZE_BUTTON_ID, eventName = Events.ON_CLICK)
public class DemoWidgetTest extends AbstractWidgetUnitTest<DemoWidgetController>
{
	private final DemoWidgetController controller = new DemoWidgetController();

	@Override
	protected DemoWidgetController getWidgetController()
	{
		return controller;
	}

}
```

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

### Display Installer Script Help

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8c46c266866910149666a0fe4caeee4e.html?locale=en-US&state=PRODUCTION&version=v2211

Use the -h option to print help information for the installer script and its recipe usage.

```bash
./install.sh -h <recipe>
```

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

### Install stocknotificationaddon AddOn

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/4a5dfff722264daaaca783de8254979d.html?locale=en-US&state=PRODUCTION&version=v2211

Run this ant command to install the stocknotificationaddon and configure project properties.

```bash
ant addoninstall -Daddonnames="stocknotificationaddon"  -DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront"
```

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

### Install B2B Addons

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/6b3c400939a046cd9ff4b80bf6ab6d80.html?locale=en-US&state=PRODUCTION&version=v2211

Installs the 'b2bacceleratoraddon' and 'commerceorgaddon' for the custom B2B storefront using ant addoninstall.

```bash
ant addoninstall -Daddonnames="b2bacceleratoraddon" -DaddonStorefront.yacceleratorstorefront="myprojectb2bstorefront"
ant addoninstall -Daddonnames="commerceorgaddon" -DaddonStorefront.yacceleratorstorefront="myprojectb2bstorefront"
```

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

### Install chinesepspwechatpaymentsamplesaddon AddOn

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/120f3389e4eb4569a70bc3a5b6c13d88.html?locale=en-US&state=PRODUCTION&version=v2211

Use this command to install the chinesepspwechatpaymentsamplesaddon. Ensure you replace 'yacceleratorstorefront' with your actual storefront name if it differs.

```bash
ant addoninstall -Daddonnames="chinesepspwechatpaymentsamplesaddon"  -DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront"
```

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

### Configure Addon Installation Strategy

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8ada254186691014a61a97498443531b.html?locale=en-US&state=PRODUCTION&version=v2211

Set the addon.china.install.strategy property in local.properties to 'B2C' to specify the installation strategy for the AddOn.

```properties
addon.china.install.strategy=B2C
```

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

### Install chinesepspalipaysamplesaddon AddOn

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/b72aa9d2e9d3441c8782d921bea28767.html?locale=en-US&state=PRODUCTION&version=v2211

Use this command to install the chinesepspalipaysamplesaddon. Ensure you replace 'yacceleratorstorefront' with your actual storefront name.

```bash
ant addoninstall -Daddonnames="chinesepspalipaysamplesaddon"  -DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront"
```

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

### Install timedaccesspromotionsstorefront AddOn

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8ada254186691014a61a97498443531b.html?locale=en-US&state=PRODUCTION&version=v2211

Use the ant addoninstall command with the specified addonnames and addonStorefront parameters to install the timedaccesspromotionsstorefront AddOn.

```bash
ant addoninstall -Daddonnames="timedaccesspromotionsstorefront" -DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront"
```

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

### REST Call Response for PunchOut Setup

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8af7a3b286691014a37df118970f70b6.html

This is an example of a successful REST response for a PunchOut setup request. It includes a status code and a URL to start the PunchOut session.

```xml
<?xml version="1.0" encoding="UTF-8"?>
				<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.024/cXML.dtd">
				<cXML payloadID="1396546295006.7271@powertools" timestamp="2014-04-03T13:31:35-04:00" xml:lang="en-US">
				<Response>
				<Status code="200" text="success"/>
				<PunchOutSetupResponse>
				<StartPage>
				<URL>https://powertools.local:9002/yb2bacceleratorstorefront/punchout/cxml/session?key=az...</URL>
				</StartPage>
				</PunchOutSetupResponse>
				</Response>
				</cXML>
```

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

### Get Selective Cart Response Example

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/63137f4389a94b629ef44844bebbcdaa.html

This is an example response when retrieving a selective cart. If no selective cart exists, a new one will be created.

```json
{
  "type": "cartWsDTO",
  "code": "selectivecartelectronics449ba5c9-c2d6-4443-9b7d-463f5e4b26e3",
  "entries": [],
  "guid": "4f1210f3-04bb-449e-992d-1cdc74f4fe5e",
  "totalItems": 0,
  "totalPrice": {
    "currencyIso": "CNY",
    "value": 0
  },
  "totalPriceWithTax": {
    "currencyIso": "CNY",
    "value": 0
  }
}
```

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

### Generate cXML PunchOutSetupRequest Example

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8af7a3b286691014a37df118970f70b6.html

This is an example of the cXML PunchOutSetupRequest that is sent to the PunchOut site. It includes buyer information, item details, and supplier setup URLs.

```xml
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.024/cXML.dtd">
				<cXML payloadID="1383150894297..." timestamp="2013-10-30T09:34:54-07:00" xml:lang="en-US">
				<Header>
				<From>
				<Credential domain="NetworkID">
				<Identity>AN...</Identity>
				</Credential>
				</From>
				<To>
				<Credential domain="NetworkID">
				<Identity>AN...</Identity>
				</Credential>
				</To>
				<Sender>
				<Credential domain="AribaNetworkUserId">
				<Identity>...</Identity>
				<SharedSecret>******</SharedSecret>
				</Credential>
				<UserAgent>CatalogTester</UserAgent>
				</Sender>
				</Header>
				<Request>
				<PunchOutSetupRequest operation="create">
				<BuyerCookie>Wzlr...</BuyerCookie>
				<Extrinsic name="CostCenter">670</Extrinsic>
				<Extrinsic name="UniqueName">catalog_tester</Extrinsic>
				<Extrinsic name="UserEmail">catalog_tester@ariba.com</Extrinsic>
				<BrowserFormPost>
				<URL>https://service.ariba.com/CatalogTester.aw/671869/ad/handlePunchOutOrder/...</URL>
				</BrowserFormPost>
				<SupplierSetup>
				<URL>https://www.hybris.com</URL>
				</SupplierSetup>
				<ShipTo>
				<Address addressID="26">
				<Name xml:lang="en-US">Catalog Tester</Name>
				<PostalAddress name="_5uicbb">
				<DeliverTo>Catalog Tester</DeliverTo>
				<Street>1234 Catalog Tester Way</Street>
				<City>Sunnyvale</City>
				<State>CA</State>
				<PostalCode>94089</PostalCode>
				<Country isoCountryCode="US">United States</Country>
				</PostalAddress>
				</Address>
				</ShipTo>
				<SelectedItem>
				<ItemID>
				<SupplierPartID>AAA</SupplierPartID>
				<SupplierPartAuxiliaryID />
				</ItemID>
				</SelectedItem>
				</PunchOutSetupRequest>
				</Request>
				</cXML>
```

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

### Install Permanent License From File

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8c49aad986691014afeea8e93299233a.html?locale=en-US&state=PRODUCTION&version=v2211

Install a permanent license by specifying the file path containing the license key using the -install option. Use -i as a shortcut.

```bash
$ ./license.sh -install /path/to/fileContainingLicense.txt
		1 SAP license key(s) successfully installed.

```

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

### Getting an Attribute from an Integration Object

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/c14448b49ce043ff9f213edae3edf008.html?locale=en-US&state=PRODUCTION&version=v2211

Retrieve attribute information for an Integration Object using a GET request. This example demonstrates fetching catalogVersion attribute details.

```APIDOC
## GET /odata2webservices/InboundProduct/Products/{productId}/catalogVersion

### Description
Retrieve information about the catalog version attribute for a specific product.

### Method
GET

### Endpoint
https://electronics.local:9002/odata2webservices/InboundProduct/Products('Staged%7CDefault%7C1000003')/catalogVersion

### Parameters
#### Path Parameters
- **productId** (string) - Required - The unique identifier of the product, including its catalog version context (e.g., 'Staged%7CDefault%7C1000003').

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **d** (object) - Contains the data for the catalog version.
  - **__metadata** (object) - Metadata about the object.
    - **id** (string) - The unique identifier URI for the catalog version.
    - **uri** (string) - The canonical URI for the catalog version.
    - **type** (string) - The type of the object (e.g., 'HybrisCommerceOData.CatalogVersion').
  - **version** (string) - The version of the catalog (e.g., 'Staged').
  - **active** (boolean) - Indicates if the catalog version is active.
  - **integrationKey** (string) - The integration key for the catalog version (e.g., 'Staged|Default').
  - **catalog** (object) - Deferred object representing the associated catalog.
    - **__deferred** (object)
      - **uri** (string) - The URI to fetch the associated catalog details.

#### Response Example
```json
{
  "d": {
    "__metadata": {
      "id": "https://electronics.local:9002/odata2webservices/InboundProduct/CatalogVersions('Staged%7CDefault')",
      "uri": "https://electronics.local:9002/odata2webservices/InboundProduct/CatalogVersions('Staged%7CDefault')",
      "type": "HybrisCommerceOData.CatalogVersion"
    },
    "version": "Staged",
    "active": true,
    "integrationKey": "Staged|Default",
    "catalog": {
      "__deferred": {
        "uri": "https://electronics.local:9002/odata2webservices/InboundProduct/CatalogVersions('Staged%7CDefault')/catalog"
      }
    }
  }
}
```
```

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

### Install marketplaceoccaddon AddOn

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/f35da6dec2ab4e1c9a86bb2c94f77b56.html

Run the ant addoninstall command to generate properties and add dependencies. Specify the addonnames and the storefront extension.

```bash
ant addoninstall -Daddonnames="marketplaceoccaddon"  -DaddonStorefront.ycommercewebservices="ycommercewebservices"
```

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

### Get Total Entry Count using $count

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/04feab0a91ee4763939eeafc95d8d386.html?locale=en-US&state=PRODUCTION&version=v2211

Use the $count query option to retrieve the total number of entries for a specified collection. This example shows how to get the total number of inbound products.

```APIDOC
## GET /odata2webservices/InboundProduct/Products/$count

### Description
Retrieves the total number of entries in the 'Products' collection within the 'InboundProduct' OData service.

### Method
GET

### Endpoint
https://localhost:9002/odata2webservices/InboundProduct/Products/$count

### Response
#### Success Response (200)
- **integer** - The total count of entries in the collection.

### Response Example
```
6
```
```

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

### GET /odata2webservices/InboundProduct/Products with $skip

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/cf34b9bbd7d94e0c9eb37e5147d20da1.html?locale=en-US&state=PRODUCTION&version=v2211

Demonstrates how to use the $skip query option to retrieve a subset of products, starting after a specified element.

```APIDOC
## GET /odata2webservices/InboundProduct/Products?$skip

### Description
Use the $skip query option to retrieve a subset of the collection, starting at the element after the value specified. The value of $skip must be an integer greater than or equal to 0 (zero). If the value specified is less than 0, the URI is considered malformed and the request results in an error. The query parameter $orderby is not supported, so the data service must return a fully ordered Collection.

### Method
GET

### Endpoint
https://localhost:9002/odata2webservices/InboundProduct/Products

### Query Parameters
- **$skip** (integer) - Required - The number of elements to skip from the beginning of the collection. Must be >= 0.

### Request Example
```json
{
  "example": "https://localhost:9002/odata2webservices/InboundProduct/Products?$skip=2"
}
```

### Response
#### Success Response (200)
- **d.results** (array) - An array of product objects.
- **d.__next** (string) - A URL to the next page of results if available.

#### Response Example
```json
{
    "d": {
        "results": [
            {
                "__metadata": {
                    "id": "https://localhost:9002/odata2webservices/InboundProduct/Products('Staged%7CDefault%7Ctest_article3')",
                    "uri": "https://localhost:9002/odata2webservices/InboundProduct/Products('Staged%7CDefault%7Ctest_article3')",
                    "type": "HybrisCommerceOData.Product"
                },
                "code": "test_article3",
                "name": "test_article3",
                "integrationKey": "Staged|Default|test_article3",
                "catalogVersion": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/InboundProduct/Products('Staged%7CDefault%7Ctest_article3')/catalogVersion"
                    }
                },
                "unit": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/InboundProduct/Products('Staged%7CDefault%7Ctest_article3')/unit"
                    }
                }
            },
            {
                "__metadata": {
                    "id": "https://localhost:9002/odata2webservices/InboundProduct/Products('Staged%7CDefault%7Ctest_article4')",
                    "uri": "https://localhost:9002/odata2webservices/InboundProduct/Products('Staged%7CDefault%7Ctest_article4')",
                    "type": "HybrisCommerceOData.Product"
                },
                "code": "test_article4",
                "name": "test_article4",
                "integrationKey": "Staged|Default|test_article4",
                "catalogVersion": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/InboundProduct/Products('Staged%7CDefault%7Ctest_article4')/catalogVersion"
                    }
                },
                "unit": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/InboundProduct/Products('Staged%7CDefault%7Ctest_article4')/unit"
                    }
                }
            }
        ],
        "__next": "https://localhost:9002/odata2webservices/InboundProduct/Products?$skiptoken=4"
    }
}
```
```

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

### GET /OutboundIntegrationMonitoring/<someURLsegment>

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/a1a17de3d71f43d78accedb52a6c961d.html?locale=en-US&state=PRODUCTION&version=v2211

Retrieves outbound integration monitoring data. Requires membership in the 'integrationmonitoringgroup'. The example shows how to expand the 'status' for more detailed information.

```APIDOC
## GET /OutboundIntegrationMonitoring/<someURLsegment>

### Description
Retrieves outbound integration monitoring data. Requires membership in the 'integrationmonitoringgroup'. The example shows how to expand the 'status' for more detailed information.

### Method
GET

### Endpoint
https://localhost:9002/odata2webservices/OutboundIntegrationMonitoring/OutboundRequests?$expand=status

### Parameters
#### Query Parameters
- **$expand** (string) - Optional - Specifies related entities to retrieve. Example: `status`.

### Request Example
```
GET https://localhost:9002/odata2webservices/OutboundIntegrationMonitoring/OutboundRequests?$expand=status
```

### Response
#### Success Response (200)
- **d.results** (array) - Contains a list of outbound request objects.
  - **__metadata** (object) - Metadata for the request.
  - **requestIntegrationKey** (string) - The integration key for the request.
  - **sapPassport** (string) - The SAP Passport information.
  - **type** (string) - The type of the outbound request.
  - **destination** (string) - The destination URL for the request.
  - **messageId** (string) - The unique message ID.
  - **error** (object|null) - Error details if the request failed.
  - **integrationKey** (string) - The integration key.
  - **status** (object) - The status of the integration request.
    - **__metadata** (object) - Metadata for the status.
    - **code** (string) - The status code (e.g., 'SUCCESS').
    - **integrationKey** (string) - The integration key for the status.

#### Response Example
```json
{
    "d": {
        "results": [
            {
                "__metadata": {
                    "id": "https://localhost:9002/odata2webservices/OutboundIntegrationMonitoring/OutboundRequests('2a54482a0300e6000053415020436f6d6d657263650000000000000000000000000000000000000000002761646d696e00000000000000000000000000000000000000000000000000000073656e64204f7574626f756e6450726f647563740000000000000000000000000000000000000000000b000000000000000000000000000000000000000000000000000000000000000042374531414536353438394534443135393337373543313430313641384539390000000001e8fa06ce1aa544c69508d3e894da70a7b9150ec4ad2247df988cb641e2f6299100000000000000002a54482a",
                    "uri": "https://localhost:9002/odata2webservices/OutboundIntegrationMonitoring/OutboundRequests('2a54482a0300e6000053415020436f6d6d657263650000000000000000000000000000000000000000002761646d696e00000000000000000000000000000000000000000000000000000073656e64204f7574626f756e6450726f647563740000000000000000000000000000000000000000000b000000000000000000000000000000000000000000000000000000000000000042374531414536353438394534443135393337373543313430313641384539390000000001e8fa06ce1aa544c69508d3e894da70a7b9150ec4ad2247df988cb641e2f6299100000000000000002a54482a",
                    "type": "HybrisCommerceOData.OutboundRequest"
                },
                "requestIntegrationKey": "Online|Default|TESTPRoduct",
                "sapPassport": "2a54482a0300e6000053415020436f6d6d657263650000000000000000000000000000000000000000002761646d696e00000000000000000000000000000000000000000000000000000073656e64204f7574626f756e6450726f647563740000000000000000000000000000000000000000000b000000000000000000000000000000000000000000000000000000000000000042374531414536353438394534443135393337373543313430313641384539390000000001e8fa06ce1aa544c69508d3e894da70a7b9150ec4ad2247df988cb641e2f6299100000000000000002a54482a",
                "type": "OutboundProduct",
                "destination": "https://localhost:9002/odata2webservices/OutboundProduct/Products",
                "messageId": "ac84d2e3-df97-44e3-a3d7-ab51c326a83c",
                "error": null,
                "integrationKey": "2a54482a0300e6000053415020436f6d6d657263650000000000000000000000000000000000000000002761646d696e00000000000000000000000000000000000000000000000000000073656e64204f7574626f756e6450726f647563740000000000000000000000000000000000000000000b000000000000000000000000000000000000000000000000000000000000000042374531414536353438394534443135393337373543313430313641384539390000000001e8fa06ce1aa544c69508d3e894da70a7b9150ec4ad2247df988cb641e2f6299100000000000000002a54482a",
                "status": {
                    "__metadata": {
                        "id": "https://localhost:9002/odata2webservices/OutboundIntegrationMonitoring/IntegrationRequestStatuses('SUCCESS')",
                        "uri": "https://localhost:9002/odata2webservices/OutboundIntegrationMonitoring/IntegrationRequestStatuses('SUCCESS')",
                        "type": "HybrisCommerceOData.IntegrationRequestStatus"
                    },
                    "code": "SUCCESS",
                    "integrationKey": "SUCCESS"
                }
            }
        ]
    }
}
```
```

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

### Install marketplaceaddon AddOn

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/e07314668f7342e4b8291292214bdbdc.html

Run the ant addoninstall command to generate properties and establish dependencies. Specify the addon name and the storefront to integrate with.

```bash
ant addoninstall -Daddonnames="marketplaceaddon"  -DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront"
```

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

### Summary View Widget Configuration Example

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/73c72587ab0a4898bfed2cda081569c7.html?locale=en-US&state=PRODUCTION&version=v2211

This XML configuration demonstrates how to set up sections, attributes, and actions for the Summary View widget for a Product type.

```xml
<context type="Product" component="summary-view">
	<summary-view:summary-view xmlns:summary-view="http://www.hybris.com/cockpitng/component/summaryview">
		<summary-view:section name="hmc.essential">
			<summary-view:attribute qualifier="code"/>
			<summary-view:attribute qualifier="name"/>
			<summary-view:attribute qualifier="catalogVersion"/>
		</summary-view:section>
		<summary-view:section name="hmc.section.product.pictures">
			<summary-view:attribute qualifier="picture"/>
			<summary-view:attribute qualifier="thumbnail"/>
		</summary-view:section>
		<summary-view:section name="Actions">
			<summary-view:actions component-id="summaryviewactions" group="common"/>
		</summary-view:section>
	</summary-view:summary-view>
</context>
```

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

### GET /InboundIntegrationMonitoring/<someURLsegment>

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/485b479c3b294d88916edea277e409a4.html?locale=en-US&state=PRODUCTION&version=v2211

Retrieves monitoring data for inbound integration requests. Requires membership in the 'integrationmonitoringgroup'. The example shows how to expand 'status' and 'errors' for requests.

```APIDOC
## GET /InboundIntegrationMonitoring/<someURLsegment>

### Description
Retrieves monitoring data for inbound integration requests. This endpoint allows you to view the status and any associated errors for integration processes.

### Method
GET

### Endpoint
/odata2webservices/InboundIntegrationMonitoring/InboundRequests

### Parameters
#### Query Parameters
- **$expand** (string) - Optional - Specifies related entities to expand in the response. Example: `status,errors`.

### Request Example
```
GET https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/InboundRequests?$expand=status,errors
```

### Response
#### Success Response (200)
- **d.results** (array) - Contains a list of inbound requests.
  - **requestIntegrationKey** (string) - The integration key for the request.
  - **type** (string) - The type of integration service.
  - **creationtime** (string) - The timestamp when the request was created.
  - **messageId** (string) - The ID of the message.
  - **integrationKey** (string) - The unique integration key.
  - **errors** (object) - Contains details about any errors associated with the request.
    - **results** (array) - A list of error objects.
      - **creationtime** (string) - The timestamp when the error occurred.
      - **message** (string) - The error message.
      - **code** (string) - The error code.
      - **integrationKey** (string) - The integration key associated with the error.
  - **status** (object) - Contains the status of the inbound request.
    - **code** (string) - The status code (e.g., 'ERROR', 'SUCCESS').
    - **integrationKey** (string) - The integration key for the status.

#### Response Example
```json
{
    "d": {
        "results": [
            {
                "__metadata": {
                    "id": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/InboundRequests('1568915657343%7C%7C')",
                    "uri": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/InboundRequests('1568915657343%7C%7C')",
                    "type": "HybrisCommerceOData.InboundRequest"
                },
                "requestIntegrationKey": "",
                "sapPassport": null,
                "type": "IntegrationService",
                "creationtime": "/Date(1568915657343)/",
                "messageId": "",
                "integrationKey": "1568915657343||",
                "errors": {
                    "results": [
                        {
                            "__metadata": {
                                "id": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/InboundRequestErrors('1568915657339%7C1568915657343%7C%7C')",
                                "uri": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/InboundRequestErrors('1568915657339%7C1568915657343%7C%7C')",
                                "type": "HybrisCommerceOData.InboundRequestError"
                            },
                            "creationtime": "/Date(1568915657339)/",
                            "message": "Media type text/plain is not supported.",
                            "code": "unknown_error",
                            "integrationKey": "1568915657339|1568915657343||",
                            "inboundRequest": {
                                "__deferred": {
                                    "uri": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/InboundRequestErrors('1568915657339%7C1568915657343%7C%7C')/inboundRequest"
                                }
                            }
                        }
                    ]
                },
                "status": {
                    "__metadata": {
                        "id": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/IntegrationRequestStatuses('ERROR')",
                        "uri": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/IntegrationRequestStatuses('ERROR')",
                        "type": "HybrisCommerceOData.IntegrationRequestStatus"
                    },
                    "code": "ERROR",
                    "integrationKey": "ERROR"
                },
                "user": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/InboundRequests('1568915657343%7C%7C')/user"
                    }
                }
            },
            {
                "__metadata": {
                    "id": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/InboundRequests('1568915679339%7C%7Cpcm')",
                    "uri": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/InboundRequests('1568915679339%7C%7Cpcm')",
                    "type": "HybrisCommerceOData.InboundRequest"
                },
                "requestIntegrationKey": "pcm",
                "sapPassport": null,
                "type": "IntegrationService",
                "creationtime": "/Date(1568915679339)/",
                "messageId": "",
                "integrationKey": "1568915679339||pcm",
                "errors": {
                    "results": []
                },
                "status": {
                    "__metadata": {
                        "id": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/IntegrationRequestStatuses('SUCCESS')",
                        "uri": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/IntegrationRequestStatuses('SUCCESS')",
                        "type": "HybrisCommerceOData.IntegrationRequestStatus"
                    },
                    "code": "SUCCESS",
                    "integrationKey": "SUCCESS"
                },
                "user": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/InboundIntegrationMonitoring/InboundRequests('1568915679339%7C%7Cpcm')/user"
                    }
                }
            }
        ]
    }
}
```
```

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

### Configure AddOns in setup task

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/26a148aaf55c4cc290d5a7bfe91a1e43.html

Adjust the setup task in build.gradle to include 'commerceorgaddon' in the comma-separated list of AddOn names.

```gradle
task setup << {
	...
	pl.project.addons {
			names "liveeditaddon,commerceorgaddon"
			template "yacceleratorstorefront"
			storeFronts "yacceleratorstorefront"
			platform pl
	}
	...
}
```

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

### Example OData2 GET API Request Exceeding Max Page Size

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/13238689430f418dafda178ee2bae430.html?locale=en-US&state=PRODUCTION&version=v2211

When the $top value exceeds the defined default max value, the system returns the default max page size with a link to the next page. This example shows a request for 45 items when the max is set to 5.

```http
https://localhost:9002/odata2webservices/InboundProduct/Products?$top=45
```

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

### Start SAP Commerce Cloud Server

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/9af51e8010034ac7bda41a3486196894.html?locale=en-US&state=PRODUCTION&version=v2211

Start the SAP Commerce Cloud server using the provided command after configuring the extensions.

```bash
./hybrisserver.sh
```

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

### Getting a Single Entity using Integration Key

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/f592f4e1200c46d9a0a914a421b7d0ac.html?locale=en-US&state=PRODUCTION&version=v2211

Retrieve a single entity via a defined Integration Object using the integrationKey. This example shows how to retrieve a Product item.

```APIDOC
## GET /odata2webservices/MyProduct/Products/{integrationKey}

### Description
Retrieves a single entity using its integration key. The integration key is a unique identifier for the entity within the integration object.

### Method
GET

### Endpoint
`/odata2webservices/MyProduct/Products('Staged%7CDefault%7Cmyproduct')`

### Query Parameters
- **$expand** (string) - Optional - Allows retrieval of multiple levels of expanded navigation properties, such as `localizedAttributes`.

### Response
#### Success Response (200)
- **data** (object) - Contains the data for simple properties.
- **deferred links** (object) - Links to navigation properties that can be retrieved separately.
- **localizedAttributes** (object) - If specified in the Integration Object Item Attributes, contains all localized values for those attributes when using `$expand=localizedAttributes`.

#### Response Example (with $expand=localizedAttributes)
```json
{
  "d": {
    "__metadata": {
      "uri": "https://localhost:9002/odata2webservices/MyProduct/Products('Staged%7CDefault%7Cmyproduct')",
      "type": "MyProduct.Products"
    },
    "Product": "myproduct",
    "integrationKey": "Staged|Default|myproduct",
    "localizedAttributes": [
      {
        "__metadata": {
          "uri": "https://localhost:9002/odata2webservices/MyProduct/Products('Staged%7CDefault%7Cmyproduct')/localizedAttributes('en')",
          "type": "MyProduct.localizedAttributes"
        },
        "language": "en",
        "name": "Example Product Name"
      }
    ]
  }
}
```
```

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

### Install b2bpunchoutaddon using ant

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8ac599b986691014a25a8584458ea758.html

Execute the ant addoninstall task to install the b2bpunchoutaddon and associate it with your storefront extension. Replace 'yb2bacceleratorstorefront' with your actual storefront extension name if different.

```bash
ant addoninstall -Daddonnames="b2bpunchoutaddon" -DaddonStorefront.yb2bacceleratorstorefront="yb2bacceleratorstorefront"
```

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

### Get Tax Invoice Recipient Types Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/a46ea3c287664312b7efeac4e9f6ed86.html?locale=en-US&state=PRODUCTION&version=v2211

This JSON example shows the structure of the response when retrieving tax invoice recipient types. It includes the code and type for each recipient.

```json
[
  {
    "code": "INDIVIDUAL",
    "type": "InvoiceRecipientType"
  },
  {
    "code": "UNIT",
    "type": "InvoiceRecipientType"
  }
]
```

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

### Initialize SAP Commerce Cloud System

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/6cc825154e42479f86a0d28cfd6bce79.html?locale=en-US&state=PRODUCTION&version=v2211

Run this command to initialize the SAP Commerce Cloud system after configuring the local extensions. Do not close the command prompt during this process.

```bash
install -r cx_china_b2b initialize -A initAdminPassword=nimda
```

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

### Implement Custom Project Data Initialization

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8afb209e866910148073da1c2c7212dd.html

Implement this method to create project-specific data during system initialization. The `SystemSetupContext` provides necessary parameters and values.

```java
/**
	 * Implement this method to create data that is used in your project. This method will be called during the system
	 * initialization.
	 *
	 * @param context the context provides the selected parameters and values
	 */
	@SystemSetup(type = Type.PROJECT, process = Process.ALL)
	public void createProjectData(final SystemSetupContext context)
	{
		/*
		 * Add import data for each site you have configured
		 *
		 * final ImportData sampleImportData = new ImportData();
		 * electronicsImportData.setProductCatalogName(SAMPLE_PRODUCT_CATALOG_NAME);
		 * electronicsImportData.setContentCatalogNames(Arrays.asList(SAMPLE_CONTENT_CATALOG_NAME));
		 * electronicsImportData.setStoreNames(Arrays.asList(SAMPLE_STORE_NAME));

		 * getCoreDataImportService().importData(context, sampleImportData);
		 * getEventService().publishEvent(new CoreDataImportedEvent(context, Arrays.asList(sampleImportData)));

		 * getSampleDataImportService().importData(context, sampleImportData);
		 * getEventService().publishEvent(new SampleDataImportedEvent(context, Arrays.asList(sampleImportData)));
		*/
	}
```

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

### Get Order Forms for Current User

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8aed167e8669101486bda9b400f02de2.html

Retrieves a list of saved order forms associated with the currently logged-in user. No specific setup is required beyond having a user session.

```Java
List<OrderFormData> getOrderFormsForCurrentUser();
```

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

### Get All Customer Conversations API Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/4381c533588748d0b4cfcd8c11ff6b9d.html

This JSON example illustrates the structure of the response when retrieving all conversations for a customer. It includes conversation details, customer information, and the latest message.

```json
{
    "conversations": [
        {
            "createDate": "2017-12-13T07:43:27+0000",
            "customer": {
                "name": "Customer1",
                "uid": "customer1@hybris.com"
            },
            "id": "00000000005",
            "latestMessage": {
                "content": "when can I expect the delivery?",
                "sender": {
                    "name": "Customer1",
                    "uid": "customer1@hybris.com"
                },
                "sentTime": "2017-11-12T04:44:49+0000"
            },
            "status": "OPEN"
        }
    ]
}
```

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

### Get Total Number of Inbound Products

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/04feab0a91ee4763939eeafc95d8d386.html?locale=en-US&state=PRODUCTION&version=v2211

Use $count to retrieve the total number of entries of a specified type in the system. This example requests the total count of inbound products.

```http
https://localhost:9002/odata2webservices/InboundProduct/Products/$count
```

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

### Get Chinese Delivery Time Slots Response

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/894a9565480b493995c4773c5aef502b.html

This JSON example shows the structure of the response when retrieving all Chinese delivery time slots. It includes codes and names for different delivery options.

```json
{
  "deliveryTimeSlots": [
    {
      "code": "AnyTime",
      "name": "Any Days"
    },
    {
      "code": "OnlyWeekdays",
      "name": "Only In Weekdays"
    },
    {
      "code": "OnlyWeekends",
      "name": "Only In Weekends"
    }
  ]
}
```

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

### Display Command Line License Tool Help

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8c49aad986691014afeea8e93299233a.html?locale=en-US&state=PRODUCTION&version=v2211

Run the license script with -help or no options to display all available commands and their usage. Use -h as a shortcut.

```bash
$ ./license.sh -help
		SAP license key administration toolkit for Java environment
		Usage: license.sh <Option(s)>
		Options:
		-help  . . . . . . . . . . . . . . . . . . . Display this help
		-version . . . . . . . . . . . . . . . . . . Display the tool version
		-get . . . . . . . . . . . . . . . . . . . . Display infos about the system
		-number  . . . . . . . . . . . . . . . . . . Same as -get
		-install <filename>  . . . . . . . . . . . . Install license keys from a file
		-show  . . . . . . . . . . . . . . . . . . . Display license keys
		-temp <Product>  . . . . . . . . . . . . . . Create a temporary license key
		-temppossible <Product>  . . . . . . . . . . Check whether a temporary license key may be installed
		-delete <System Id> <Hardware Key> <Product> Delete license key(s)
		
		For each of the parameters after "-delete" you can use "*" as a wildcard.
		Remember to use quotes to mask the "*"!

```

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

### Compare View Widget Configuration Example

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/33096c08d4ac4ca1b225e9d991fa151e.html?locale=en-US&state=PRODUCTION&version=v2211

Example configuration for the Compare View widget, demonstrating the use of editor-area-ctx and grid-view-ctx.

```xml
<!-- ... -->
<context type="typecode" component="compare-view">
    <com:compare-view xmlns:com="http://www.hybris.com/cockpitng/component/compareview">
      <!--Optional:-->
      <com:editor-area-ctx ctx="editor-area" use="true"/>
      <!--Optional:-->
      <com:grid-view-ctx ctx="grid-view" use="true"/>
      <!--Optional:-->
```

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

### Initialize SAP Commerce Cloud for China

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/7e6eef9edbe84a31876aa4710f864313.html

Run this command in the installer directory to initialize SAP Commerce Cloud and enable China-specific functions. Ensure the localextensions.xml file is correctly configured.

```bash
install -r cx_china -A initAdminPassword=nimda
```

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

### Example Response for OutboundChannelConfigurations GET Request

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/f3c109a69c2a4744874ec7f39db5af7e.html?locale=en-US&state=PRODUCTION&version=v2211

This JSON object shows the structure of a response when requesting details for outbound channel configurations. It includes metadata, code, integration key, and deferred links for integration objects and destinations.

```json
{
    "d": {
        "results": [
            {
                "__metadata": {
                    "id": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('outboundExample')",
                    "uri": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('outboundExample')",
                    "type": "HybrisCommerceOData.OutboundChannelConfiguration"
                },
                "code": "outboundExample",
                "autoGenerate": false,
                "integrationKey": "outboundExample",
                "integrationObject": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('outboundExample')/integrationObject"
                    }
                },
                "destination": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('outboundExample')/destination"
                    }
                }
            },
            {
                "__metadata": {
                    "id": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('MyOutboundChannelConfig')",
                    "uri": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('MyOutboundChannelConfig')",
                    "type": "HybrisCommerceOData.OutboundChannelConfiguration"
                },
                "code": "MyOutboundChannelConfig",
                "autoGenerate": true,
                "integrationKey": "MyOutboundChannelConfig",
                "integrationObject": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('MyOutboundChannelConfig')/integrationObject"
                    }
                },
                "destination": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('MyOutboundChannelConfig')/destination"
                    }
                }
            },
            {
                "__metadata": {
                    "id": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('%257B%257BoutboundChannelCode%257D%257D')",
                    "uri": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('%257B%257BoutboundChannelCode%257D%257D')",
                    "type": "HybrisCommerceOData.OutboundChannelConfiguration"
                },
                "code": "{{outboundChannelCode}}",
                "autoGenerate": true,
                "integrationKey": "%7B%7BoutboundChannelCode%7D%7D",
                "integrationObject": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('%257B%257BoutboundChannelCode%257D%257D')/integrationObject"
                    }
                },
                "destination": {
                    "__deferred": {
                        "uri": "https://localhost:9002/odata2webservices/OutboundChannelConfig/OutboundChannelConfigurations('%257B%257BoutboundChannelCode%257D%257D')/destination"
                    }
                }
            }
        ]
    }
}
```

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

### Display Installed License Information

Source: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/7e47d40a176d48ba914b50957d003804/8c49aad986691014afeea8e93299233a.html?locale=en-US&state=PRODUCTION&version=v2211

Use the -show option to view details about currently installed licenses, including system information, product limits, and validity. Use -s as a shortcut.

```bash
$ ./license.sh -show
		System . . . . . : CPS
		Hardware Key. . : Y4989890650
		SW product. . . : CPS_SQL
		SW product Limit: Unlimited
		Begin date. . . : 10/May/2016
		Expiration date : 08/Aug/2016
		License key type: Temporary
		Installation No.: 0000000000
		System No.. . . : 000000000000000000
		Validity. . . . : valid

```
Tokens:
Raw