Adobe Commerce (Magento)

📘
Checkout the API docs here for more information

Set up

Enter the relevant hostname and API key into the text areas asking for Host and Bearer Token respectively. To retrieve/create these credentials log into Commerce Marketplace -> account name (top right) -> My Profile -> Access Keys.

If you have whitelisting restrictions in place please whitelist the following IP addresses:

54.74.228.117/32
54.78.204.135/32
34.242.207.164/32

Features

Feature	Support	Notes
Backfill	ℹ️	At least 2 years of backfilled data available on all reports
Incremental	✅	Incremental is available on all reports except Categories, it is usually based on the timestamp `UPDATED_AT`
API reliability	🟢	Reliable

Reports detail

⬇️ Report	🔑 Incremental key	🔑 Primary key	📄 Link to API endpoint	✏️ Notes
Categories	`N/A`	`ID`	Category List	Incremental not supported
Customers	`UPDATED_AT`	`ID`	Customers Search	Backfills all customers may take several hours to complete
Invoices	`UPDATED_AT`	`INCREMENT_ID`	Invoice List	Backfills any invoice updated in the last 2 years
Order Items	`ORDER_UPDATED_AT`	`ITEM_ID`	List orders	Flattens the items object and backfills any order updated in the last 2 years
Order Status History	`ORDER_UPDATED_AT`	`ENTITY_ID`	List orders	Flattens the status histories object and backfills any order updated in the last 2 years
Orders	`UPDATED_AT`	`INCREMENT_ID`	List orders	Backfills any order updated in the last 2 years
Products	`UPDATED_AT`	`ID`	Product list	Backfills all products may take several hours to complete
Shipments	`UPDATED_AT`	`ENTITY_ID`	List Shipments	Backfills any shipment updated in the last 2 years