API Overview
The Elastic Path Commerce Cloud API is a set of APIs used to manage resources. The following table lists the top-level resources in alphabetical order with a brief description and links to related content. To view all endpoints, see the methods in the linked sections or use the Postman collection.
| Resource | Description | Links |
|---|---|---|
/pcm/catalogs | Catalog configuration, rules, and releases. | Catalogs, Catalog Releases |
/pcm/catalog | Retrieve the published catalog that best matches the shopper context according to the defined catalog rules. | Catalogs, Catalog Releases |
/pcm/hierarchies | Hierarchy management that supports user-defined, structured hierarchies. | PCM Hierarchies |
/pcm/pricebooks | Price books contain product prices in multiple currencies. | Price Books |
/pcm/products | Product information and relationships. | PCM Products |
/v2/authentication-realms | Single sign-on support for your business customers. | Authentication Realms, OpenID Connect Profiles |
/v2/carts | Cart management, including carts, cart items, and taxes. Associate carts with customers. | Carts |
/v2/currencies | Currencies that are used to display prices. | Currencies |
/v2/customers | Customer management, including addresses and orders. | Customers |
/v2/files | Images and other files. | Files |
/v2/flows | Data model extensions. You can extend an existing resource or create a new resource. | Custom Data (Flows) |
v2/gateways | Payment gateways that you can configure so that customers can pay for their orders. | Gateways |
/v2/integrations | Events that you can use to add webhooks. | Events (Webhooks) |
/v2/inventories | Inventory management within your project. | Inventories |
/v2/jobs | Task management for long-running background tasks, such as exporting orders. | Jobs |
/v2/merchant-realm-mappings | Single sign-on configuration for administrators and developers. | Merchant Settings |
/v2/orders | Orders are the result of checking out a cart. A payment for an order is called a transaction. | Orders, Transactions |
/v2/promotions | Promotions management, including promotion codes. | Promotions |
/v2/settings | Global settings that affect your project, such as page length and language settings. | Settings |
Legacy APIs
The following API resources are supported but have been replaced by enhanced services.
| Resource | Description | Links | Replacement |
|---|---|---|---|
/v2/brands | Hierarchies that are used to organize products by brand, such as Leviʼs® or Adidas®. | Brands | /pcm/hierarchies |
/v2/categories | Hierarchies that are used to organize products by categories, such as Appliances or Shoes. | Categories | /pcm/hierarchies |
/v2/collections | Hierarchies that are used to organize products by collections, such as Fall Collection or Sale Collection. | Collections | /pcm/hierarchies |
/v2/products | Products or services that you sell in your store. You define product attributes, such as name and description. You also define relationships to other resources, such as files and types of hierarchies. Finally, you can build child products based on variations. | Products, Child Products, Translations | /pcm/products, /pcm/pricebooks |
/v2/variations | Attributes necessary to build child products. A child product is one version of the parent product based on product variations, such as a size 7 shoe in black. You can override attribute values from the parent product by using modifiers. | Product Variations, Product Modifiers | Future |