Here is the naming convention for the different host names.
Norce Commerce Services is a set of services primarily focused on application development in front of the commerce engine Norce. These services are designed for front-end applications and provide the correct information to rich UIs such as sales tools, e-commerce sites, and similar applications. The services include metadata around products, product information, shopping logic, and order history - everything needed to build front-end sites.
When to use: Use these services when building customer-facing applications, e-commerce storefronts, sales tools, or any application that needs to interact with commerce functionality in real-time.
- Postman examples
- How to call the Norce Commerce Services
- Note that all datetimes returned in this API are in Unix Epoch format, e.g., Date(1727273870693+0200)
| Service | Description |
|---|---|
| Metadata | https://[hostname]/commerce/metadata/1.1/[method] Contains the Application and Expose endpoints. The Application endpoint manages applications as entities. It contains the Application entity, Store, and other lookup data common to an application and client's configuration. The Expose endpoint has shared information used by all other services. |
| Customer | https://[hostname]/commerce/customer/1.1/[method] The Customer service manages customer and company data. |
| Order | https://[hostname]/commerce/order/1.1/[method] The Order service handles orders and related entities such as DeliveryNotes and Invoices. |
| Product | https://[hostname]/commerce/product/1.1/[method] The Product service manages product catalog data including products, prices, and availability. |
| Shopping | https://[hostname]/commerce/shopping/1.1/[method] Contains entities and methods to handle baskets and payments. |
This API provides an effective way to export large product catalogs from Norce for different use cases. The Norce Commerce product feed works in tandem with the Norce Commerce services and can proactively populate search services from third parties or send product catalogs to other sales channels like marketplaces. It's built from the ground up to be effective and efficient at sending out large amounts of data, supporting both full data feeds and delta feeds (changed data only). The product information provided should be the same presentation information you would get from asking for products through the Norce Commerce services.
When to use: Use this API when you need to export large product catalogs to external systems such as search services, marketplaces, or other sales channels. Ideal for system integrations that require bulk product data synchronization.
| Service | Description |
|---|---|
| API | https://[hostname]/commerce/productfeed/1.0/api/v1/[endpoint] Set up exports of product catalogs to different channels. |
Norce Management API provides functionality for working behind the scenes with configurations. You can access much of the same information as from Norce Commerce services, but here you can change and reconfigure metadata. Common use cases include updating product metadata in your catalog, rebuilding your product model through scripts or integrations from third-party systems like external PIM systems. You can also script your entire application or client setup, including setting up new clients, versioning configurations, and synchronizing between environments. Additionally, you can work with campaigns, setting up promotions or price lists dynamically and getting real-time feedback on those configurations.
When to use: Use this API for administrative tasks, product metadata management, application configuration, campaign management, and when building integrations with external PIM systems. Perfect for scripting deployments and maintaining configurations across environments.
| Service | Description |
|---|---|
| API | https://[hostname]/api/[endpoint] Manage configuration and business logic on clients and applications. |
Connect is an API primarily designed for system integrations, focusing on importing data into Norce Commerce. You can effectively update large amounts of product catalogs, customer registries, and similar data. It also provides the ability to monitor import jobs as they progress. Connect includes order and transactional endpoints for getting order information, updating order status, or passing in delivery notes and invoices to Norce. Overall, Connect works behind the scenes for building system integrations, transactional integrations for sales orders and other transactions, and large updates of order, customer, supplier, or product data.
When to use: Use this API for system integrations that involve large data imports, batch processing of products/customers/orders, ERP integrations, and when you need to update transactional data like order statuses, delivery notes, and invoices.
| Service | Description |
|---|---|
| Customer | https://[hostname]/commerce/connect/4.0/Customer/[method] Import customer and company data. |
| Job | https://[hostname]/commerce/connect/4.0/Job/[method] Storm Connect job information. |
| Order | https://[hostname]/commerce/connect/4.0/Order/[method] Import order statuses, delivery notes, and invoices, and send new orders to integrated systems. |
| Product | https://[hostname]/commerce/connect/4.0/Product/[method] Entities, enums, and methods for importing products and product-related information. |
| Supplier | https://[hostname]/commerce/connect/4.0/Supplier/[method] Import supplier product data. |
The Norce Query is an OData REST API with all write and update capabilities disabled. It's a lookup API that works best for use cases where you want detailed information in your own applications. Query works directly against the data layer in Norce, so it's not as preferable to use as Management API or the Norce Commerce services. The data is "raw" since no business logic is applied when accessing it, making it complex and potentially slow since the data is not cached.
When to use: Use Query API only when you cannot use the other APIs. It's suitable for finding specific information to pass through to other systems in system integration solutions, but should be used with caution due to performance considerations.
| Service | Description |
|---|---|
| Application | https://[hostname]/commerce/query/2.0/Application/[method] Contains entities and methods for all different settings for the client and application. |
| Core | https://[hostname]/commerce/query/2.0/Core/[method] Contains entities and methods for all different settings for all clients. |
| Customers | https://[hostname]/commerce/query/2.0/Customers/[method] Contains entities and methods for all customer and company related information. |
| Orders | https://[hostname]/commerce/query/2.0/Orders/[method] Contains entities and methods for orders, delivery notes, and invoices—everything regarding transactions that happen after purchase. |
| Products | https://[hostname]/commerce/query/2.0/Products/[method] Contains entities and methods for all product-related data. |
| Reporting | https://[hostname]/commerce/query/2.0/Reporting/[method] Contains entities and methods for looking up simple reports and summaries. |
| Shopping | https://[hostname]/commerce/query/2.0/Shopping/[method] Contains entities and methods concerning the setup of shopping rules. |
Event is a collection of webhooks that allow integrations to subscribe to data changes in Norce. This is the webhook framework where you can listen to events in Norce that can trigger actions in your solution, primarily for system integration solutions. Note that this service is not designed to be fast or real-time and is not built for real-time feedback in front-end applications. It can take a couple of minutes before changes are signaled through webhooks.
When to use: Use this API for system integrations that need to react to changes in Norce data, such as automated workflows, data synchronization with external systems, or triggering processes based on commerce events. Not suitable for real-time front-end applications.
- How to use Norce Commerce Webhooks
| Service | Description |
|---|---|
| Webhooks | Catch Commerce events. |
Payment Callback API is primarily used by third-party systems like payment service providers that need to call back behind the scenes to Norce Commerce directly. This API is almost never used by customer solutions - it's typically used by Norce's own adapters behind the scenes. Its purpose is to allow third-party services to call back to Norce when payments are approved, failed, or changed.
When to use: This API is normally not used by client solutions. Only payment integrations, such as Norce's own Adapters, typically use these endpoints.
The base URL for payment callbacks to Norce Commerce is https://[hostname]/commerce/callback/1.0/. See respective PSP documentation for more information.