RCG B2C Commerce System API - Implementation Template

Each implementation template relies on services or data in order to function.

Please review the use cases described on the MuleSoft Accelerator for Retail solution pages for more information about dependencies on other APIs and services.

Prerequisite setup

• A B2C Commerce sandbox instance is required

• Login to B2C Commerce, navigate to Administration-> Site Development -> Open Commerce API Settings,choose "data" from the "Select Type" drop down, and add the following entries to access the OCAPI api:

  {
  "resource_id": "/products/*",
  "methods": [
      "get",
      "put",
      "patch"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/products/*/variation_attributes/*",
  "methods": [
      "get",
      "put"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/products/*/variation_attributes/*/values/*",
  "methods": [
      "get",
      "put"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/products/*/variations/*",
  "methods": [
      "get",
      "put"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/catalogs/*/categories/*/products/*",
  "methods": [
      "get",
      "patch",
      "put"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/inventory_lists/*/product_inventory_records/*",
  "methods": [
      "get",
      "put",
      "patch"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/sites/*/orders/**",
  "methods": [
      "put",
      "patch"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/sites/*/promotions/*",
  "methods": [
      "get",
      "put",
      "patch"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/sites/*/customer_groups",
  "methods": [
      "get"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/sites/*/customer_groups/*",
  "methods": [
      "get",
      "put",
      "patch"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/sites/*/customer_groups/*/members",
  "methods": [
      "get"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/sites/*/customer_groups/*/members/*",
  "methods": [
      "get",
      "put"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/sites/*/campaigns/*",
  "methods": [
      "get",
      "put",
      "patch"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  },
  {
  "resource_id": "/sites/*/campaigns/*/promotions/*",
  "methods": [
      "put",
      "patch"
  ],
  "read_attributes": "(**)",
  "write_attributes": "(**)"
  }

• Above entry is required to access the following OCAPI Data API endpoints:PUT: /products/{id}PUT: /products/{master_product_id}/variations/{id}PUT: /products/{product_id}/variation_attributes/{id}PUT: /products/{product_id}/variation_attributes/{attribute_id}/values/{id}PUT: /catalogs//categories//products/PUT: /inventory_lists//product_inventory_recordsPUT: /customer_groups/{customerGroupName}PUT: /customer_groups/{customerGroupName}/members/{customerId}PUT: /promotions/{promotionId}

• Above entry is required to access the following Commerce REST API endpoints:PUT: /orders

• Ensure that for products integration, a catalog is created in B2C Commerce with the name same as defined under the "OWNING_CATALOG_ID" on Products table in PIM.

Next steps

Refer to the Deployment page for instructions on how to configure and deploy this application.