CIAMA
English
API documentation · Overview
Your ERP holds your product data. Your channels generate orders. Your teams rely on the numbers. The CIAMA REST API connects that data to your applications, in both directions.
Your data journey
Send data · PUT / JSON
Products, brands, categories and tags
Customers, offers, orders and shipments
Quantities in the default warehouse
CIAMAREST APIThe multichannel cockpit
Catalog · operations · metricsUse data · GET / JSON
Multichannel orders, lines and shipments
Financial data and exposed aggregates
Read own and connected external inventory
Planned API extension01 / Resources
Start with the data you need to exchange. These routes outline the scope; your instance’s reference specifies formats, filters and required permissions.
Write & read
Send products, brands, categories and tags from your system of record. External identifiers preserve the link to records in your ERP or PIM.
/api/pim/products/by-external-id/{externalId}/api/pim/products/by-external-id/{externalId}Inventory is a separate resource: updating a product does not replace its stock quantities.
Write & read
Send customers, sales representatives, pricing terms, offers, orders and shipments. Your ERP’s activity feeds the operations and calculations in the cockpit.
/api/b2b/customers/by-external-id/{externalId}/api/b2b/orders/by-external-id/{externalId}Calculations follow import processing; accepting an import does not mean that metrics update immediately.
Write & read · scope expanding
Connect your inventory data to CIAMA. The current foundation exposes warehouse reads and stock exchanges for the default warehouse. The target scope extends this to multiple warehouses and connected 3PL inventory.
/api/warehouse/warehouses/api/inventory/default-warehouse/stocks/by-product-external-id/{externalId}Warehouse creation, per-warehouse writes and unified 3PL inventory reads are planned extensions, to be scoped for your deployment.
Read
Retrieve multichannel orders, order lines and shipments to connect your ERP or internal tools to the operations centralized in CIAMA.
/api/oms/orders/api/oms/order-lines/api/oms/fulfillmentsReading data from your application is separate from a connector that automatically sends orders to an ERP.
Read
Reuse financial data from order lines and the aggregates exposed on brands and categories: amounts, margins and activity broken down by channel.
/api/pim/brand/{id}/api/pim/category/{id}Available metrics depend on the resource and version. The API reference describes the fields actually exposed.
Import monitoring
Track what happens after you send data. A receipt lets your system check import status and distinguish a received request from an applied update.
/api/pim/products/receipts/{receiptId}/api/b2b/orders/receipts/{receiptId}The relevant import resources also support snapshot-based reconciliation.
02 / Warehouses & 3PL inventory
Your own warehouse, a logistics partner, a marketplace fulfillment service: each source contributes to availability. The aim is to preserve that origin, not hide it inside a total.
Quantities supplied by your ERP or WMS.
Inventory collected through enabled logistics connections.
Data your applications can use, with its stock source preserved.
The target: create warehouses from your systems, send quantities per warehouse and read external inventory collected by CIAMA. Amazon FBA illustrates this need; Cdiscount Fulfillment and other 3PLs may be included depending on the selected integrations. Each connection and API access is confirmed during scoping.
Explore multi-warehouse inventory ↗03 / The import lifecycle
The integration client and its permissions determine the account and write scope. External identifiers link each resource to its source system.
Send business data with the appropriate synchronization metadata. Idempotency supports retries without multiplying identical imports.
A 202 response means the import has been accepted for processing. Validation and application of the data may continue asynchronously.
Read the receipt. Source revisions and snapshots, on supported resources, provide additional controls for updates and reconciliation.
04 / Access & capacity
The API uses JWT tokens. Machine clients have dedicated permissions for catalog, inventory or B2B imports. Read APIs have their own authorization requirements: access is prepared for the selected flows.
Frequency, import size, history and peak traffic: we define capacity and call limits with you, based on your server and requirements. There is no universal throughput promise in place of sizing your instance.
A dedicated cloud instance operated by Dawap or installation within your infrastructure: CIAMA remains licensed software. Integration accounts for your network constraints, source systems and enabled modules.
05 / Technical reference
Methods, parameters, schemas and responses: your instance’s Swagger documentation is the reference for building your connection. This overview helps you select the flows; it does not duplicate their technical contracts.
/api/doc/api/doc.jsonThe access URL depends on your instance. Request the reference matching your version of CIAMA.
Request documentation access ↗Tell us about your systems, the data you need to exchange and expected volumes. Together, we will define access, resources and any adaptations required.
Discuss my integration ↗