Data extensibility - Introduction
Who is this for?
Profile | Role on this topic |
|---|---|
🔧 System Integrator (SI) | You define the custom field schema during implementation and map it to the retailer's data model (ERP, PIM, CRM). |
⚙️ Retailer Tech Team | You own the field definitions post-go-live and maintain the data pipelines that populate them. |
🚀 Discovering OneStock | Read the "When to use" blocks in each section to understand what custom data unlocks. |
Our data extensibility lets you add custom fields to orders, items, and stock locations so that OneStock can carry your business-specific data through sourcing, orchestration, UI, and exports.
These fields are defined via public APIs and are available across rules, queries, and back-office screens.
Order data extensibility
When to use
You need extra attributes on orders (e.g. fraud score, marketing campaign, channel tags).
You want sourcing or carrier selection to react to retailer-specific order data.
How it works
Define custom order attributes via the Order API / schema https://developers.onestock-retail.com/paths/orders/post
Populate these attributes from your commerce, CRM, or risk engines when creating/updating orders.
Where the data is used
Sourcing rules: use custom order fields as conditions and inputs to your sourcing strategies.
Carrier assignment: drive carrier selection based on order attributes (destination type, risk, VIP status, etc.).
Item data extensibility
When to use
You need additional fields on items (e.g. product family, merchandising tags, hazard flags).
You want stock queries or UI to reflect retailer-specific product attributes.
How it works
Define custom item attributes via the Item API / schema https://developers.onestock-retail.com/paths/item_imports-id--items/post
Keep them in sync with your PIM/ERP when creating or updating items.
Where the data is used
Back Office: display custom item fields in selected product and order detail pages.
Stock queries: filter and group stock using item-level custom attributes (via item/stock query APIs).
Stock location data extensibility
When to use
You need to describe locations with extra data beyond standard fields (e.g. store cluster, picking capability, SLA tier).
You want sourcing and exports to apply those location-specific attributes.
How it works
Define custom stock-location attributes via the Stock location API / schema https://developers.onestock-retail.com/paths/endpoint_imports-id--endpoints/post
Maintain these attributes from your store master data, WMS, or ERP.
Where the data is used
Stock-location-based exports: include custom location fields in stock exports for BI and downstream systems.
Sourcing: use location attributes as criteria in sourcing decisions (eligible nodes, priorities, cut-offs).