Data Ingestion API #91
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@mslabko, I recommend converting this to a "draft" PR until all teams have contributed. |
jeff-matthews
added
internal
new-topic
meker12
reviewed
Aug 6, 2024
| Let's check basic scenarios on how you may use Data Ingestion API | ||
|
|
||
| Example below demonstrate how you can create your Catalog in Commerce Services. | ||
| This example will register 4 products, category tree, product attributes metadata and scopes in Commerce Services. |
There was a problem hiding this comment.
Suggested change
| This example will register 4 products, category tree, product attributes metadata and scopes in Commerce Services. | |
| This example shows how to use the Data Ingestion API to create a catalog in Commerce Services. In the API requests, the payload specifies the product attributes, scopes, customer groups, prices, and catalog navigation. | |
| - Define the product attributes metadata available for configuring products. | |
| - Represent the website-store-storeview structure for a store with one website, store, and storeview by defining scopes. | |
| - Define the customer groups | |
| - Define four simple products using the available attributes | |
| - Define prices for each product | |
| - Create the catalog navigation by defining categories and category paths. |
| | API_KEY | API_KEY obtained in [this section](#register-tenant-api-keys) | | ||
| | JWT_TOKEN | JWT token obtained in [this section](#obtain-a-jwt-token-for-your-request) | | ||
| | API_PAYLOAD | API payload see in examples below | | ||
|
|
There was a problem hiding this comment.
Suggest adding a top-level heading for all the payload examples with links to each section.
API Payload
In Data Ingestion API requests, the payload can specify the product attributes, scopes, customer groups, prices, and catalog navigation for the catalog.
This example shows different payloads to create catalog components including the following:
- Define the product attributes metadata available for configuring products.
- Represent the website-store-storeview structure for a store with one website, store, and storeview by defining scopes.
- Define the customer groups
- Define four simple products using the available attributes
- Define prices for each product
- Create the catalog navigation by defining categories and category paths.
| | JWT_TOKEN | JWT token obtained in [this section](#obtain-a-jwt-token-for-your-request) | | ||
| | API_PAYLOAD | API payload see in examples below | | ||
|
|
||
| ### Define product attributes and their characteristics |
There was a problem hiding this comment.
Suggested change
| ### Define product attributes and their characteristics | |
| #### Define product attributes and their characteristics |
| ] | ||
| ``` | ||
|
|
||
| ### Define scopes |
There was a problem hiding this comment.
Suggested change
| ### Define scopes | |
| #### Define scopes | |
| Scope determines the websites and storefronts where catalog data is available for use. | |
| For Commerce projects built on Commerce Foundation, a store is represented by the [website - store - storeview](https://experienceleague.adobe.com/en/docs/commerce-admin/start/setup/websites-stores-views) structure. The following payload defines a single website with one store and one storeview. |
Comment on lines
+449
to
+452
|
|
||
| Define customer groups. Shoppers requests prices providing `WEBSITE_CODE` and `CUSTOMER_GROUP_CODE` scopes. | ||
| Please define all Customer Groups related to Website applicable for your Store. | ||
| Soft limit: 1000 per website |
There was a problem hiding this comment.
Suggested change
| Define customer groups. Shoppers requests prices providing `WEBSITE_CODE` and `CUSTOMER_GROUP_CODE` scopes. | |
| Please define all Customer Groups related to Website applicable for your Store. | |
| Soft limit: 1000 per website | |
| #### Define customer groups | |
| Shoppers request prices by providing the `WEBSITE_CODE` and `CUSTOMER_GROUP_CODE` scopes. | |
| The following payload shows an example that defines a single customer group. For your store, you must define all customer groups associated with each store website. | |
| Soft limit: 1000 per website |
|
@mslabko I've provided some review comments to improve existing PR. Based on meeting with Alex Jose while you were out, there's a need to publish the current feed ingestion documentation to support some customer use cases, and they'll be some changes to it later. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
This PR is based on the proposal described in wiki: https://wiki.corp.adobe.com/display/ACDS/Feed+Ingestion+Service+-+notes+for+public+docs
Several teams have to contribute to this PR until it can be transferred to tech writers.
Reference: DCAT-1473
Staging version of API documentation
Affected pages
Links to Magento Open Source code