Getting started with catalog data management
Developers setting up catalogs for merchants with large or complex product assortments use the Data Ingestion API to send catalog data to Commerce storefront services directly, bypassing the need to go through an Adobe Commerce instance, saving time and processing power.
This direct connection decreases the time that it takes to process product changes because it bypasses the Adobe Commerce instance and moves catalog data from a third-party Enterprise Resource Planning (ERP) directly to Adobe Commerce services.
The Data Ingestion API is implemented as a REST (Representational State Transfer) API endpoint to manage the following types of data.
- Products <-- what is product?, how to create product
- Product Variants <--what is variant, how to create product variants
- Product Metadata <-- what client can manage, how to extend?
- PriceBooks and Prices <-- what is price, how price connected to products, what is price book?
Endpoints
Send all Data Ingestion requests to the https://commerce.adobe.io/feeds endpoint. For details about using the API, see the API Reference.
Authentication
API reference
Send all Data Ingestion API requests to the https://commerce.adobe.io/feeds endpoint. For details about using the API, see API Reference
Headers
Headers list should be present in each Data Ingestion API call
| Header name | Required | Description |
|---|---|---|
Content-Type | Yes | Media type of the resource. Accepted value: application/json |
x-api-key | Yes | Public API Key. TODO: add link docs according to https://wiki.corp.adobe.com/display/ACDS/Feed+Ingestion+Service+-+notes+for+public+docs#FeedIngestionServicenotesforpublicdocs-RegistertenantAPIkeys |
x-gw-signature | Yes | JWT generated for Public API key. TODO: add link to docs according to https://wiki.corp.adobe.com/display/ACDS/Feed+Ingestion+Service+-+notes+for+public+docs#FeedIngestionServicenotesforpublicdocs-ObtainaJWTtokenforyourrequest |
Content-Encoding | No | Use this header only if the payload is compressed with gzip. Accepted value: gzip |
Examples
Use the following examples to learn about the basic scenarios for using the 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.
Use the following template for API call:
Copied to your clipboardcurl --location 'https://commerce.adobe.io/api/<API_ENDPOINT>/<DATA_SPACE_ID>' \--header 'Content-Type: application/json' \--header 'x-api-key: <API_KEY>' \--header 'x-gw-signature: <JWT_TOKEN>' \--data '<API_PAYLOAD>'
| Placeholder name | Description |
|---|---|
API_ENDPOINT | API endpoint retrieved from API reference for specific Data Ingestion API, for example: metadata/v2/metadata |
DATA_SPACE_ID | Data Space ID obtained in this section. |
API_KEY | API_KEY obtained in this section. |
JWT_TOKEN | JWT token obtained in this section. |
API_PAYLOAD | API payload see in examples below |
