Download the PHP package angeo/module-openai-product-feed-api without Composer
On this page you can find all versions of the php package angeo/module-openai-product-feed-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download angeo/module-openai-product-feed-api
More information about angeo/module-openai-product-feed-api
Files in angeo/module-openai-product-feed-api
Package module-openai-product-feed-api
Short Description Magento 2 REST API for the OpenAI Agentic Commerce Protocol (ACP). Implements the ACP feed API surface: feeds, paginated products with configurable variants, and SalesRule-sourced promotions. Bearer-token authenticated, DB-persisted feeds, PATCH-as-POST bridge for Magento compatibility.
License MIT
Homepage https://angeo.dev
Informations about the package module-openai-product-feed-api
OpenAI Agentic Commerce Protocol (ACP) API for Magento 2
Magento 2 REST implementation of the OpenAI Agentic Commerce Protocol (ACP) feed API: Feeds, Products and Promotions resources, so ChatGPT can retrieve and update your catalog data through API-based delivery instead of (or alongside) daily file uploads.
All endpoints are bearer-token authenticated per the ACP specification. Feeds are persisted in the database (they survive cache flushes and restarts), product export is fully paginated with configurable-product variants, and promotions are sourced from Magento Cart Price Rules including coupon codes and free shipping.
Works together with angeo/module-openai-product-feed (CSV file-upload feed): per OpenAI's guidance, provide the full feed daily via file upload and send incremental updates through this API.
Requirements
- PHP >= 8.1
- Magento 2.4.x (Open Source or Adobe Commerce)
angeo/module-openai-product-feed^2.0
Installation
Authentication (required)
Every endpoint requires a bearer token carrying the Angeo_OpenAiProductFeedApi::manage_feeds ACL resource, matching the ACP requirement that requests include Authorization: Bearer <api_key>.
- In the Magento admin, go to System → Extensions → Integrations → Add New Integration.
- On the API tab, select the resource Angeo — Manage Product Feed API (under Marketing).
- Save, then Activate the integration and copy the Access Token.
- Provide that token to OpenAI as the feed API key; use it in the
Authorization: Bearerheader for your own calls as well.
Requests without a valid token receive 401 Unauthorized.
Endpoints
| Method | Path | Description |
|---|---|---|
POST |
/rest/V1/angeo/product_feeds |
Create a product feed |
GET |
/rest/V1/angeo/product_feeds |
List all feeds (extension beyond the ACP spec) |
GET |
/rest/V1/angeo/product_feeds/:id |
Get feed metadata |
GET |
/rest/V1/angeo/product_feeds/:id/products |
Get products (paginated) |
POST |
/rest/V1/angeo/product_feeds/:id/products/upsert |
Upsert products (PATCH bridge) |
POST |
/rest/V1/angeo/product_feeds/:id/products/invalidate |
Reset product cache for the feed |
GET |
/rest/V1/angeo/product_feeds/:id/promotions |
Get promotions |
POST |
/rest/V1/angeo/product_feeds/:id/promotions/upsert |
Upsert promotions (PATCH bridge) |
Invalid target_country returns 400 Bad Request; unknown feed or store IDs return 404 Not Found, per the ACP error model.
PATCH bridge — web server setup
Magento 2's REST framework does not support HTTP PATCH. The ACP spec defines upserts as PATCH /product_feeds/:id/products. Bridge this with a rewrite before the request reaches Magento:
Quick start
How caching works
- Catalog snapshot — built from the Magento catalog on the first
GET, persisted until invalidated. Store-scoped feeds are built under frontend store emulation, so URLs, currency and locale match the store view. - Upsert overlay — products received via PATCH/upsert are stored separately and merged over the snapshot at read time (overlay wins). Catalog rebuilds never discard upserted products.
- Page slices — formatted responses are cached for 30 minutes with their own tag; any upsert invalidates them immediately.
/invalidate— full reset for the feed: snapshot, overlay and pages.
Configuration
Stores → Configuration → Angeo → Product Feed API
| Setting | Description | Default |
|---|---|---|
| Enabled | Enable/disable the API | Yes |
| Default Target Country | ISO 3166-1 alpha-2, validated on feed creation | US |
| UTM Medium | Appended to all product URLs for attribution | feed |
| Include List Price | Original price when a special price is active | Yes |
| Include Barcodes | Read EAN/UPC/GTIN attributes | Yes |
| Seller Name | Store/brand name in ACP responses | Store name |
| ToS / Privacy / Refund / Shipping / FAQ URLs | Emitted as seller.links |
— |
ACP Product schema coverage
| Field | Source |
|---|---|
id |
product.entity_id — stable, never changes |
title |
Product name |
description.plain / description.html |
description / short_description |
url |
Product URL + utm_medium + utm_source=chatgpt |
media |
Gallery images via Magento's ImageUrlBuilder |
variants[].id / title |
Configurable children, or the product itself |
variants[].price / list_price |
Final price / original price, minor units (cents) |
variants[].availability |
Stock status → in_stock / out_of_stock |
variants[].categories |
Category names, merchant taxonomy |
variants[].variant_options |
Configurable attribute labels/values (color, size, …) |
variants[].barcodes |
ean / upc / gtin / barcode / isbn attributes |
variants[].condition |
["new"] |
variants[].seller |
Name + policy links from configuration |
ACP Promotion schema coverage
Sourced from active Magento Cart Price Rules (SalesRules):
| Magento SalesRule | ACP field |
|---|---|
rule_id |
id as promo_rule_{id} |
name |
title |
description + coupon code (via CouponRepositoryInterface) |
description.plain |
is_active + dates |
status: active / scheduled / expired / disabled |
from_date / to_date |
active_period (RFC 3339) |
by_percent |
{type:"percent_off"} |
by_fixed / cart_fixed |
{type:"amount_off"} (minor units) |
simple_free_shipping |
{type:"free_shipping"} — combinable with a discount benefit |
Testing
The PromotionMapper suite (14 tests) covers benefit mapping, free-shipping detection, coupon-code resolution and status transitions.
The Angeo agentic commerce suite
| Module | Purpose |
|---|---|
angeo/module-openai-product-feed |
OpenAI CSV product feed (file upload, all product types) |
angeo/module-openai-product-feed-api |
This module — ACP REST API |
angeo/module-ucp |
Universal Commerce Protocol discovery + MCP binding |
angeo/module-mcp-server |
Read-only commerce tools over MCP |
angeo/module-llms-txt |
llms.txt AI content map |
angeo/module-aeo-audit |
AEO readiness audit |
Need help with agentic commerce for Magento? Professional support, AEO audits and implementation at angeo.dev. Check how your store looks to AI agents with the free scanner at api.angeo.dev.
Questions? Contact me at [email protected]
License
MIT — see LICENSE
All versions of module-openai-product-feed-api with dependencies
magento/framework Version *
magento/module-catalog Version *
magento/module-catalog-inventory Version *
magento/module-configurable-product Version *
magento/module-store Version *
magento/module-sales-rule Version *
magento/module-backend Version *
angeo/module-openai-product-feed Version ^2.0