Edit in GitHubLog an issue
Adobe Commerce only. Learn more

Using the data ingestion API

Use the data ingestion API to create and manage product data for your ecommerce catalog. Data includes products, product attribute metadata, prices books, and prices.

Endpoints

Send all Data Ingestion requests to this endpoint: https://commerce.adobe.io/api

Authentication

To interact with the Data Ingestion API, the consumer must authenticate by generating a JWT token signed with the public API key from your Commerce account at https://account.magento.com.

For instructions on generating the public API key, see Generate the production and sandbox keys

Generate JWT token

Use the following java code to generate a JWT token signed with the private key associated with your public API key.

JwtGenerator.java

Copied to your clipboard
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import java.security.PrivateKey;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.Date;
public class JwtGenerator {
public String generateJwt(PrivateKey privateKey) {
Instant now = Instant.now();
return Jwts.builder()
.setIssuedAt(Date.from(now))
.setExpiration(Date.from(now.plus(5L, ChronoUnit.MINUTES)))
.signWith(privateKey, SignatureAlgorithm.RS256)
.compact();
}
}

Path parameters

Include the following path parameter in each API request.

Parameter nameRequiredDescription
DATA_SPACE_ID
Yes
The data space ID for the data space where commerce catalog data is stored. See SaaS configuration.

Header parameters

Include the following headers in REST API requests.

Header nameRequiredDescription
Content-Encoding
No
Use this header only if the payload is compressed with gzip. Accepted value: gzip
Content-Type
Yes
Media type of the resource. Accepted value: application/json
x-api-key
Yes
Use the public API Key for your production environment when submitting Data Ingestion API requests.
x-gw-signature
Yes

Request template

Use the following template to submit requests using cURL.

Copied to your clipboard
curl --request POST \
--url https://commerce.adobe.io/api/v1/<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 nameDescription
API_ENDPOINT
Endpoint for specific Data Ingestion API, for example: /api/v1/catalog/products/prices/
DATA_SPACE_ID
API_KEY
JWT_TOKEN
API_PAYLOAD
API payload see examples in the tutorial

For sample requests, see the tutorial.

  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2025 Adobe. All rights reserved.