- restapi/code/index.js
- restapi/code/swagger-ui.css
- restapi/code/swagger-ui.css.map
- restapi/code/swagger-ui.js
- restapi/code/swagger-ui-bundle.js
- restapi/code/swagger-ui-bundle.js.map
- restapi/code/swagger-ui-standalone-preset.js
- restapi/code/swagger-ui-standalone-preset.js.map
- restapi/code/absolute-path.js
- restapi/code/oauth2-redirect.html
- restapi/code/authentication_and_session_management.yaml
- restapi/code/cart.yaml
- restapi/code/catalog.yaml
- restapi/code/commerce_composer_services.yaml
- restapi/code/price.yaml
- restapi/code/coupons_and_promotions.yaml
- restapi/code/location_based_services.yaml
- restapi/code/marketing.yaml
- restapi/code/other.yaml
- restapi/code/order_capture.yaml
- restapi/code/search_services.yaml
- restapi/code/search_services_bod_based.yaml
- restapi/code/store_configurations.yaml
- restapi/code/subscription.yaml
- restapi/code/user_and_organization_management.yaml
- restapi/code/workspace_support.yaml
- WebSphere Commerce Storefront REST API
WebSphere Commerce REST API documentation contains a list of resources that are provided by the WebSphere Commerce REST API. Each REST resource contains information such as URLs, descriptions, and sample input and output data.
- Authentication, Authorization and Session Management
These services provide classes related to authentication and session management
in a B2B or B2C store. Use these classes to: Generate a preview token; Get the user context of a
shopper (for example, PersonalizationId); Log on or log off a registered shopper using their
username and password; Create or log off a guest user.
- Cart
These services provide classes related to the shopping cart in a B2B or B2C
store. Use these classes to: Get, add, update, or delete payment instructions; Get, add, update, or
delete items in the shopping cart; Get the billing address; Calculate order prices; Lock or unlock
the cart; Checkout; Get or update shipping information.
- Catalog
These services provide classes related to browsing either a B2B or B2C store.
Use these classes to: Get category data for administrative purposes; Get catalogs by search term or
by store ID; Get catalog entries by parent part number or by search term.
- Commerce Composer
These services put the power to create new store pages and design page layouts
in the hands of business users. By using a library of prebuilt layout templates and widgets,
business users can quickly create and assemble pages directly in Management Center. Use these
classes to find information about pages, widgets, and the page design.
- Contract and Price
These services provide APIs related to contracts and pricing in either a B2B or
B2C store. Use these classes to: Get information about currency formatting; Get contract details;
Get terms and conditions, entitled prices, range prices, and display prices for catalog entries;
Switch contracts.
- Coupons and Promotions
These services provide classes related to promotional activities in either a B2B
or B2C store. Use these classes to: Get, add, update, or delete assigned coupons; Get, add, update,
or delete assigned promotion codes; Get associated promotions.
- Location Based Services
These services provide classes related to locational data, including the store
locator feature. In a B2C store, shoppers use the store locator feature to locate a nearby store,
where a list of nearby stores is given based on the the location entered by the shopper. In a B2B
store, the store locator displays countries that stores are located in.
- Marketing
These services provide classes related to marketing in either a B2B or B2C
store. Use these classes to: Get e-Marketing Spot data; Get customer segment data; Trigger marketing
based on certain types of events.
- Miscellaneous
These services provide APIs related to features, aggregate features, and file
upload jobs in a B2B or B2C store.
- Order Capture
These services provide classes related to orders in a B2B or B2C store. Use
these classes to: Find information about order history and order details; Find inventory details for
products; Get and manage a shopper's wishlists, or items in the wish list.
- Search Services
These services provide APIs related to searching either a B2B or B2C store. Use
these classes to: Get top-level categories, child categories, category details by category ID,
products, products by part number, products details by ID Provide brand, product, content and custom
suggestions Search unstructured content by search term
- Search Services (BOD-based)
These services, located on the WebSphere Commerce server, provide APIs related
to searching either a B2B or B2C store. Use these classes to: get category data for search-based
catalog navigation get product data for search-based catalog navigation get product view details get
information about search term associations (for example, landing pages) get resource details for
site content such as the search results page
- Store Configurations
These services provide APIs related to the store configuration in a B2B or B2C
store. Use these classes to:Get configuration details; Get flow information by flow ID; Get
configuration details for system integrations; Get available resource URLs for a store; Get
SEO-related information.
- Subscription
These services provide APIs related to subscriptions. Use these classes to:
Submit a recurring or subscription order Cancel a recurring or subscription order; Get subscriptions
by user and subscription type; Get subscription information by subscription ID.
- User and Organization Management
These services provide APIs related to user and organization management in a B2B
or B2C store. Use these classes to: Get member groups; Get person details Add or update a member;
Get order and buyer approval status records and approve or reject them; Register a person as a
member; Update a member; Get or update organization information; Get or update a checkout profile;
Switch organizations.
- Workspace Support
These services provide APIs related to workspaces in a B2B or B2C store. Use
these classes to: get task group details; task details; to get workspace
details.
- Mapping of REST services to BOD services
The following sections detail how the REST resource method names relate to specific BOD services.
- Mapping of REST services to storefront checkout actions
The Aurora starter store uses REST services throughout the checkout process. The actions for each page map to a REST service.
- REST service annotations
WebSphere Commerce REST services and Search REST services are annotated so you view and test the APIs with Swagger, an interactive REST service interface. The REST Discovery API generates a list of REST resources and APIs by parsing annotations on a resource handler. By documenting your custom REST resource handlers with the same annotation standards as WebSphere Commerce REST services, your custom REST services can be viewed and tested with Swagger.