General B2B Commerce Cloud API Reference

Podcast

Play an AI-generated podcast conversation about this lesson

Questions and Answers

Which of the following best describes the primary purpose of the Storefront API?

To integrate third-party payment systems.
To manage high-level administrative tasks.
To perform data analytics on user interactions.
To provide access to digital commerce functionalities. (correct)

What is a key feature of the Administrative API?

It provides access to all objects in the platform. (correct)
It is limited to viewing product details.
It enhances the user interface for storefronts.
It only handles user account information.

When signing into Configured Commerce, which two requests must be made?

Authenticate with the Storefront API and create a wishlist.
Create an account and add products to the cart.
Authenticate with Identity Server and create a Configured Commerce session. (correct)
Log in via the Administrative API and check session status.

Which HTTP method is most likely used for retrieving product details through the Storefront API?

GET (B) Signup and view all the answers

What does connected commerce allow in the context of Configured Commerce?

Integration with other platforms. (D) Signup and view all the answers

Which feature enhances the robustness and flexibility of the Storefront API?

A facade in front of the application. (D) Signup and view all the answers

Which function is NOT part of the basic commerce workflow using the Storefront API?

Cross-sell related products (C) Signup and view all the answers

How does the Storefront API support developers in enhancing the platform?

By allowing the building of services around the API. (D) Signup and view all the answers

What type of HTTP request is used to retrieve product details?

GET (B) Signup and view all the answers

What is required in the 'beforeSend' function for AJAX requests?

Token authentication via an access token (D) Signup and view all the answers

Which method is used to add a product to the wishlist after creating it?

POST (A) Signup and view all the answers

What is the format of the product ID used in the API request?

UUID (D) Signup and view all the answers

What information must be included when creating a wishlist?

Wishlist name (D) Signup and view all the answers

What is the primary purpose of the 'success' callback function in AJAX requests?

To process and display returned data (A) Signup and view all the answers

Which property is used to specify the data type expected from the server in an AJAX request?

dataType (B) Signup and view all the answers

What element is necessary to reference an existing wishlist when adding products to it?

wishlistId (C) Signup and view all the answers

What type of request is used to create a session in the Configured Commerce application?

POST request (D) Signup and view all the answers

What is the purpose of the 'beforeSend' function in the AJAX requests?

To set request headers before the request is sent (B) Signup and view all the answers

Why might the retrieve product catalog request not include an access token?

Authentication may not be needed based on the related settings. (B) Signup and view all the answers

What action should be taken with the access token upon a successful login?

Store it for subsequent requests. (B) Signup and view all the answers

Which endpoint is used to retrieve all product categories?

/api/v1/categories (D) Signup and view all the answers

What would typically be included in the data object of the session creation request?

User's username and password (C) Signup and view all the answers

What HTTP method is used to retrieve the product catalog?

GET (D) Signup and view all the answers

What is the likely function of the 'success' callback in the AJAX requests?

To process the response data from the server. (D) Signup and view all the answers

What is the method used to add a product to the shopping cart?

POST (D) Signup and view all the answers

Which URL is used to change the quantity of a product in the shopping cart?

/api/v1/carts/current/cartlines/{cartLineId} (D) Signup and view all the answers

What type of data is expected when submitting the order?

Updated cart with shipping information (B) Signup and view all the answers

Which method is used to change an existing cart item's quantity?

PATCH (A) Signup and view all the answers

What will the 'beforeSend' function do in the AJAX calls?

Set the Authorization header using the access token. (C) Signup and view all the answers

What is logged in the success callback after an item is added to the shopping cart?

A confirmation message and the returned data. (C) Signup and view all the answers

What is the purpose of the 'dataType: json' line in the AJAX requests?

To specify the type of data being expected in response. (D) Signup and view all the answers

For which action is the data variable structured with product ID and quantity ordered?

Adding a product to the shopping cart. (B) Signup and view all the answers

Study Notes

Configured Commerce REST APIs

The Configured Commerce REST API is built on RESTful-based services using JSON objects interacting with Configured Commerce data.
The Storefront API uses HTTP verbs for its objects and methods.
The Storefront API was designed with the following considerations in mind:
- Connecting to Configured Commerce from other platforms (connected commerce).
- Allowing developers to build services around the API for a developer-friendly, flexible, and modern experience.
- Providing seamless upgrades.
- Building a facade in front of the application to allow for improvements with minimal interruption.
- Scalability.
The Storefront API focuses on delivering digital commerce functionality for:
- Viewing products related to a website.
- Adding products to a user's cart.
- Working with user account information.
The Administrative API provides data-level access to all objects in the Configured Commerce platform.
The Administrative API is used to integrate other platforms that require access to all objects in Configured Commerce, not just those within a specific user or website context.
The Storefront API includes a basic digital commerce workflow using jQuery:
- Signing In and Creating a B2B Session requires two requests: one to authenticate with Identity Server and a second to create a Configured Commerce session.
- Retrieving the Product Catalog retrieves products available in the current context (e.g., user, customer, website). This request may not require authentication.
- Retrieving All Categories fetches all categories.
- Searching for Products using a query allows users to search the product catalog using a text query.
- Retrieving Product Details displays the details of a specific product.
- Creating a Wishlist and Adding a Product to it involves two steps: creating a wishlist and adding a product to the newly created wishlist.
- Adding Products to the Shopping Cart allows users to add products to their cart with a quantity.
- Changing the Quantity of a Product in the Shopping Cart allows users to adjust the quantity of products in their cart.
- Submitting an Order finalizes the order using the updated cart with shipping information, payment method, and other details.

Studying That Suits You

Use AI to generate personalized quizzes and flashcards to suit your learning preferences.

Description

This quiz covers the key components and functionalities of the Configured Commerce REST APIs. It focuses on the Storefront API and Administrative API, highlighting their integration capabilities, digital commerce functionality, and scalable architecture. Test your knowledge of how these APIs enhance the developer experience and facilitate connected commerce.