OroCommerce Integration API Endpoints

The OroCommerce integration communicates with your OroCommerce store through the OroCommerce REST JSON API. The API uses the JSON:API media type (application/vnd.api+json) and is served under your store instance's admin path.

The base URL pattern is your API URL combined with the Admin Base Path configured in the subscription settings. Throughout this article, the placeholder [Base URL] represents that combined value, for example:

Both the API URL and the Admin Base Path are instance-specific. The Admin Base Path defaults to admin when it is not set. Every endpoint listed below is shown relative to [Base URL], so a documented path such as [Base URL]/products/{id} resolves to https://yourdomain.oro-cloud.com/admin/api/products/{id} for the example above.

The endpoints in this article are the complete set of OroCommerce calls the integration makes, grouped by entity. Use it to assess deprecation impact, configure firewall whitelisting, and support troubleshooting. Path and query parameters are shown in {curly braces} where the integration substitutes values at sync time.

These endpoints cover simple products, configurable products, product variants, and product kits. Product variants and kits are stored as products in OroCommerce, so they share the /products resource.

Used to create simple products, configurable products, product variants, and product kits.

Used to update simple products, configurable products, product variants, and product kits.

Retrieves the product associated with a configurable product's variant link.

Product prices are managed alongside products and price lists. OroCommerce stores each price as a separate productprices record.

The integration applies the price list, product, and unit filters as needed to locate the matching price record.

In OroCommerce, the company-level customer record is the customers resource.

Customer users are the buyer contacts that belong to a company customer, stored as the customerusers resource.

Customer groups are stored as the customergroups resource.

OroCommerce stores addresses in two separate resources depending on the owner. Company customer addresses use the customeraddresses resource, and customer user addresses use the customeruseraddresses resource. The integration selects the matching resource based on the address owner, so the {addressResource} segment below resolves to either customeraddresses or customeruseraddresses at sync time.

For company customer addresses the owner filter is filter[customer]. For customer user addresses it is filter[customerUser]. The country and region filters are appended only when those values are present.

Price lists and their assignment to customer groups are managed through the pricelists and pricelisttocustomergroups resources.

Sales orders flow from OroCommerce into iPaaS.com. The integration reads orders, their line items, and order subtotals.

The include parameter returns the related billing and shipping addresses with the order.

Used to retrieve orders updated on or after the last polling timestamp. Results are paged, and the integration follows the API's paging links until all matching orders are retrieved.

Shipment tracking records flow from iPaaS.com into OroCommerce as the ordershippingtrackings resource.

These read-only endpoints resolve names, codes, and labels into the internal OroCommerce identifiers that other records reference. They support dynamic relationship resolution during transfers and are typically called as part of preparing a create or update.

OroCommerce does not support label search on roles, so the integration retrieves the role list and matches the role name in code.

Returns the entity schema for a module. The integration uses this to validate and create custom fields. The {moduleName} segment resolves to values such as product, productprice, productkititem, customeruser, customeraddress, and customeruseraddress.

A generic relationship lookup. The integration resolves {entityName}, {entityId}, and {relationshipName} at sync time to retrieve related records for an entity.

A product-specific relationship lookup, with {relationshipName} resolved at sync time.

Retrieves the supported options for a related entity type, where {relatedEntityType} is resolved at sync time.

The integration authenticates with OroCommerce using OAuth 2.0 with the Authorization Code grant and PKCE (S256 code challenge method). Authorization is performed against your store instance's OAuth endpoint, which is served from the API URL without the admin API path. In the placeholders below, [Base URL without /api] represents your API URL, for example https://yourdomain.oro-cloud.com.

The user is directed to this endpoint to grant access. The integration supplies the client ID, redirect URI, requested scope, and a PKCE code challenge (S256). On success, OroCommerce redirects back to the configured redirect URL with an authorization code.

The integration exchanges the authorization code for an access token and a refresh token at this endpoint, and later uses the same endpoint to exchange a refresh token for a new access token. The request body carries the grant type (authorization_code for the initial exchange, refresh_token for renewals) along with the client ID, client secret, and the code or refresh token. The resulting access token is sent as a Bearer token on all subsequent API requests.

These are OroCommerce's own published developer API documents.