ScaleIndex B2B & Syndication — Complete Exposed Data Dictionary (36 Fields)
Every ScaleIndex producer instance exposes a rich, standardized commercial, logistic, customs, and GS1-compliant dataset across 27 native languages. Below is the complete reference table of all fields projected by the ScaleIndex Universal Datafeed (/rest/catalog/full-products.{csv|json|xml}) and modular REST endpoints, complete with generic sample values.
wholesalePrice) and the official Recommended Retail Price / MSRP (recommendedRetailPrice / retailPrice), along with exact Net Weight, Gross Shipping Weight, Volumetric Dimensions (L×W×H), Packaging Dimensions, Customs HS Code, 3-Tier Localized Descriptions, Bullet Highlights, and GS1 Technical Specifications.
| Field Name (JSON / CSV / XML) | Data Type | Business Logic & Database Source Mapping | Generic Example Value |
|---|---|---|---|
| A. Product, Variant & GS1 Identification | |||
| productId | int32 | Unique master product ID in the producer's database. | 104 |
| variantId | int32? | Unique sellable variant ID (null if single-SKU master product). |
502 |
| parentSku | string | Master product SKU grouping all size, format, or color variations. | "PRD-BIO-OLV-001" |
| sku | string | Unique sellable Variant SKU (used as reference for order creation and stock sync). |
"PRD-BIO-OLV-001-500ML" |
| internalCompanyCode | string | Producer's internal ERP / accounting article code (CodiceInternoAziendale). |
"ERP-ART-00492" |
| barcode | string | Official GS1 GTIN / EAN-13 barcode (resolves variant EAN-13 first, falls back to parent EAN-13). | "8051234567890" |
| mpn | string? | Manufacturer Part Number (CodiceMPN). |
"MPN-OLV-500" |
| B. B2B Wholesale Pricing, Recommended Retail Price (MSRP / RRP) & VAT | |||
| wholesalePrice | decimal | Your Net B2B Purchase / Dropshipping Price (dynamically calculated from variant/B2B base price and partner discount tier). | 11.40 |
| recommendedRetailPrice (alias: retailPrice) |
decimal | Official Recommended Retail Price (RRP / MSRP / Street Price) for B2C public storefront and marketplace positioning (PrezzoVenditaB2C / Variant price). |
19.00 |
| salePrice | decimal? | Optional promotional or discounted price if an active promotion is running (PrezzoScontato). |
16.90 |
| currency | string | ISO 4217 currency code of the price list. | "EUR" |
| vatRate | int32 | Applicable statutory VAT percentage for the product category (e.g., 4, 10, 22). |
10 |
| unitPriceMeasureText | string? | Reference price per unit of measure for EU Omnibus / consumer compliance (TestoPrezzoUnita). |
"38.00 EUR / Liter" |
| C. Real-Time Inventory & Restock Lead Time | |||
| inventoryQuantity | int32 | Real-time available physical stock quantity ready for immediate dispatch (QuantitaDisponibile). |
140 |
| condition | string | Item condition mapped to Schema.org standard (NewCondition). |
"New" |
| restockDateUtc | datetime? | Expected future availability date if currently out of stock (DataDisponibilitaFutura). |
null |
| D. Physical Weights, Parcel Dimensions & Customs Export Data | |||
| netWeightKg | decimal | Net product weight in kilograms excluding packaging (variant PesoNetto or product PesoKg). |
0.500 |
| grossWeightKg | decimal | Gross shipping weight in kilograms including primary container/jar for carrier rate calculation (variant PesoLordo). |
0.820 |
| volumeM3 | decimal | Unit volume in cubic meters or liters (Volume). |
0.002 |
| dimensionsCm | object | Out-of-package / item dimensions in centimeters: lengthCm (X), widthCm (Y), heightCm (Z), plus inPackageWidthCm, inPackageHeightCm, inPackageDepthCm. |
{"lengthCm":7.5,"widthCm":7.5,"heightCm":26.0} |
| physicalDataText | string? | Human-readable physical format summary (TestoDatiFisici). |
"500 ml (16.9 fl oz) Dark Glass Bottle" |
| unitOfMeasure | string | Base commercial unit of measure (UnitaMisuraBase: e.g., PZ, KG, LT). |
"PZ" |
| hsCode | string? | Harmonized System (HS / TARIC) Customs Tariff Code for cross-border export declarations. | "15092000" |
| countryOfOriginIso | string | ISO 3166-1 alpha-2 country of production/origin (PaeseDiOrigine). |
"IT" |
| E. 27-Language Content, 3-Tier Descriptions, Composition & GS1 Specifications | |||
| title | string | Product title localized in the requested lang (product_translations.Nome). |
"Organic Extra Virgin Olive Oil - Cold Pressed" |
| shortDescription | string | Tier 1 — Short Commercial Summary localized in lang (DescrizioneBreve, fallback to DescrizioneArticolo). |
"100% Italian organic cold-pressed extra virgin olive oil." |
| technicalArticleDescription | string | Tier 2 — Technical / Commodity Article Description (DescrizioneArticolo — 100% populated across all catalog items). |
"Superior category olive oil obtained directly from organic olives..." |
| descriptionProduct | string | Tier 3 — Extended Product Description (DescrizioneLunga combined with DescrizioneArticolo, Bullet Highlights, Material/Composition, and the table of GS1 Technical Specifications). |
"Harvested from centuries-old organic groves and cold-pressed..." |
| highlights | string[] | Array of up to 5 localized key selling points / bullet highlights (ProductHighlight1..5). |
["100% Cold Extracted", "Certified Organic EU"] |
| material | string? | Localized primary material or raw ingredient (Materiale). |
"100% Organic Olives (Cultivar Moraiolo & Frantoio)" |
| composition | string? | Localized detailed composition / INCI / textile or food breakdown (ComposizioneProdotto). |
"Monovarietal blend, acidity < 0.2%, peroxide index < 6" |
| specifications | object[] | Structured array of localized GS1 & technical specification rows (systemKey, label, value) from product_specification_values. |
[{"key":"gs1_storage","label":"Storage","value":"Cool, dark place"}] |
| F. Brand, Taxonomy, Variant Options & High-Resolution Media | |||
| brand | string | Official Manufacturer / Brand name (brands.Name / products.Brand). |
"Acme Artisanal Producers" |
| category + googleProductCategory & gpcCode |
string | Localized category name plus official Google Merchant Category ID and GS1 GPC classification code. | "Pantry & Cooking Oils" (GPC: "10000045") |
| option1Name & option1Value | string | Localized variant attribute name and value (e.g., Format: 500 ml, Size: L, Color: Navy). |
"Format" / "500 ml" |
| imageUrls & publicImageUrlsCommaSeparated |
string[] | Up to 10 high-resolution public WebP/JPEG URLs (variant-specific image first, followed by master gallery images filtered by B2B visibility flags). | ["https://producer-example.com/uploads/products/oil-500ml-lg.webp"] |
FEED Universal Flat Datafeed (CSV / JSON / XML)
Generates an always-updated, flat product and variant feed from the producer's catalog projecting all 36 standardized fields detailed in the table above. Each row represents a distinct, sellable Variant/SKU complete with its own EAN barcode, Net & Gross Weights, B2B Wholesale Price, Recommended Retail Price (MSRP), real-time stock, 3-tier localized descriptions, and GS1 specification table.
Query & Path Parameters
| Parameter | Type | Description |
|---|---|---|
| formatREQUIRED | string | Path extension: csv, json, or xml. |
| apiKeyREQUIRED | string | Your permanent B2B API Key on the producer's server (or sent via Authorization: Bearer header). |
| langOPTIONAL | string | Any of the 27 supported ISO codes (e.g. en, it, de, fr, pl, ja). Defaults to en. |
# 1. CSV Flat Datafeed (English)
https://{PRODUCER_B2B_DOMAIN}/rest/catalog/full-products.csv?apiKey=YOUR_API_KEY&lang=en
# 2. JSON Flat Datafeed (English)
https://{PRODUCER_B2B_DOMAIN}/rest/catalog/full-products.json?apiKey=YOUR_API_KEY&lang=en
# 3. XML Flat Datafeed (German)
https://{PRODUCER_B2B_DOMAIN}/rest/catalog/full-products.xml?apiKey=YOUR_API_KEY&lang=de
[
{
"productId": 104,
"variantId": 502,
"parentSku": "PRD-BIO-OLV-001",
"sku": "PRD-BIO-OLV-001-500ML",
"internalCompanyCode": "ERP-ART-00492",
"barcode": "8051234567890",
"mpn": "MPN-OLV-500",
"brand": "Acme Artisanal Producers",
"category": "Pantry & Cooking Oils",
"googleProductCategory": "Food, Beverages & Tobacco > Cooking Oils",
"gpcCode": "10000045",
"title": "Organic Extra Virgin Olive Oil - Cold Pressed (500 ml)",
"shortDescription": "100% Italian organic cold-pressed extra virgin olive oil in dark glass bottle.",
"technicalArticleDescription": "Superior category organic extra virgin olive oil obtained directly from olives and solely by mechanical means (500 ml / 16.9 fl oz).",
"descriptionProduct": "<p>100% Italian organic cold-pressed extra virgin olive oil.</p><p>Superior category organic extra virgin olive oil obtained directly from olives.</p><ul><li>Cold extracted below 27°C</li><li>Certified EU Organic</li></ul><table><tbody><tr><td><strong>Country of Origin</strong></td><td>Italy</td></tr><tr><td><strong>Storage Instructions</strong></td><td>Store in a cool, dry place away from direct light.</td></tr></tbody></table>",
"highlights": [
"Cold extracted below 27°C",
"Certified EU Organic"
],
"material": "100% Organic Olives",
"composition": "Monovarietal blend, acidity < 0.2%",
"wholesalePrice": 11.40,
"recommendedRetailPrice": 19.00,
"retailPrice": 19.00,
"salePrice": null,
"currency": "EUR",
"vatRate": 10,
"unitPriceMeasureText": "38.00 EUR / L",
"inventoryQuantity": 140,
"condition": "New",
"unitOfMeasure": "PZ",
"netWeightKg": 0.500,
"grossWeightKg": 0.820,
"volumeM3": 0.002,
"dimensionsCm": {
"lengthCm": 7.5,
"widthCm": 7.5,
"heightCm": 26.0,
"inPackageWidthCm": 8.5,
"inPackageHeightCm": 28.0,
"inPackageDepthCm": 8.5
},
"physicalDataText": "500 ml Dark Glass Bottle",
"hsCode": "15092000",
"countryOfOriginIso": "IT",
"option1Name": "Format",
"option1Value": "500 ml",
"publicImageUrlsCommaSeparated": "https://producer-example.com/uploads/products/oil-500ml-lg.webp",
"imageUrls": [
"https://producer-example.com/uploads/products/oil-500ml-lg.webp"
],
"specifications": [
{
"systemKey": "gs1_Product_gs1_countryOfOriginStatement",
"label": "Country of Origin",
"value": "Italy"
},
{
"systemKey": "gs1_Product_gs1_consumerStorageInstructions",
"label": "Storage Instructions",
"value": "Store in a cool, dry place away from direct light."
}
]
}
]
Multi-Producer Federated Architecture
ScaleIndex provides a standardized, high-performance e-commerce and B2B distribution infrastructure deployed across independent producers, artisanal manufacturers, and specialized brand owners.
ScaleIndex operates on a federated, single-tenant per producer architecture. Every producer or brand powered by ScaleIndex hosts its own isolated database, inventory, carrier matrix, and dedicated API domain (
https://{PRODUCER_B2B_DOMAIN}).While the API routes, 36-field JSON/XML/CSV schemas, and authentication mechanisms are 100% identical across all ScaleIndex-powered producers, you must direct your API requests to the specific Base URL and use the specific API Key provided during onboarding for each individual producer.
Endpoint Resolution Structure
| Parameter | Format / Example | Description |
|---|---|---|
| {PRODUCER_B2B_DOMAIN} | https://apibtb.{producer-domain.com} | The dedicated B2B API host assigned to the specific producer (e.g., https://apibtb.acme-producer.com). |
| {YOUR_API_KEY} | sk_b2b_{id}_{hmacSignature} | Your unique B2B credential issued by that specific producer's ScaleIndex instance. |
{
"engine": "ScaleIndex Enterprise B2B Engine",
"specificationVersion": "1.2.0",
"architecture": "Federated Multi-Instance (1 Producer = 1 Dedicated Endpoint)",
"supportedFormats": ["json", "xml", "csv"],
"nativeLanguages": 27,
"exampleProducerInstances": [
{
"producerName": "Acme Organic Foods S.r.l. (Producer #1)",
"apiBaseUrl": "https://apibtb.acme-organic-example.com",
"mediaDomain": "https://acme-organic-example.com"
},
{
"producerName": "Atelier Milano Fashion S.r.l. (Producer #2)",
"apiBaseUrl": "https://apibtb.atelier-milano-example.com",
"mediaDomain": "https://atelier-milano-example.com"
}
]
}
Authentication & Security
Every ScaleIndex producer instance authenticates machine-to-machine requests using a permanent cryptographic B2B API_KEY (format: sk_b2b_{customerId}_{hmacSignature}). Wholesale prices, assigned discounts, and commercial credit limits are dynamically resolved based on the B2B account associated with your key on that producer's server.
Supported Authentication Schemes
| Scheme | Header / Query Parameter | Recommended Usage |
|---|---|---|
| Bearer Token | Authorization: Bearer YOUR_API_KEY | Standard REST API integrations and OpenAPI clients. |
| API Key Header | X-Api-Key: YOUR_API_KEY | Custom ERP connectors and backend microservices. |
| Query Parameter | ?apiKey=YOUR_API_KEY | Automated Datafeed URL pulls (CSV, XML, JSON) for dropshipping platforms. |
# Replace {PRODUCER_B2B_DOMAIN} with the producer's API host
curl -X GET "https://{PRODUCER_B2B_DOMAIN}/rest/user/auth/status.json" \
-H "Authorization: Bearer sk_b2b_5_2d69a9c239b730789a4c..." \
-H "Accept: application/json"
Rate Limits & HTTP Status Codes
Every response includes the X-RateLimit-Limit HTTP header specifying the maximum number of requests permitted per hour for your account tier on that producer's node.
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 X-RateLimit-Limit: 1200
27 Native Official Languages
Every ScaleIndex producer database natively localizes product titles, 3-tier descriptions, technical specification tables, category taxonomies, and variant option values across 27 official languages. Supply any of the following ISO 639-1 codes in the isoCode or lang query parameter:
[
{ "name": "Italian", "nativeName": "Italiano", "isoCode": "it" },
{ "name": "English", "nativeName": "English", "isoCode": "en" },
{ "name": "German", "nativeName": "Deutsch", "isoCode": "de" },
{ "name": "Spanish", "nativeName": "Español", "isoCode": "es" },
{ "name": "French", "nativeName": "Français", "isoCode": "fr" }
]
GET Account Status, Credit Limit & Credentials
Verify your API authentication status on the producer's node, inspect your available B2B commercial credit limit (fidoCommerciale) and assigned wholesale discount rate (scontoFissoPercentuale), or retrieve your complete directory of 27 localized datafeed URLs.
{
"customerId": 5,
"currency": "EUR",
"fidoCommerciale": 2500.00,
"scontoFissoPercentuale": 25.00,
"giorniDilazione": 30
}
GET Category Taxonomies & Product Tags
Returns the producer's hierarchical category tree (including parentTaxonomy references) and active classification tags localized in the requested isoCode.
[
{
"id": 12,
"name": "Pantry & Cooking Oils",
"url": "pantry-cooking-oils",
"parentTaxonomy": null,
"urlImages": "https://{PRODUCER_MEDIA_DOMAIN}/uploads/cat-pantry-lg.webp",
"isoCode": "en"
}
]
GET Products Master List & Localized Content
/rest/catalog/products.json returns the structural product master record (SKU, EAN-13, Brand, B2B Wholesale Price, Recommended Retail Price, VAT rate, Net Weight, HS Code, Country of Origin).
/rest/catalog/productsinformation.json returns localized titles, URL slugs, 3-tier descriptions (shortDescription, technicalArticleDescription, descriptionProduct), highlights, composition, and structured GS1 specification tables.
[
{
"id": 104,
"manufacturer": 1,
"brandName": "Acme Artisanal Producers",
"sku": "PRD-BIO-OLV-001",
"internalCode": "ERP-ART-00492",
"ean13": "8051234567890",
"wholesalePrice": 11.40,
"recommendedRetailPrice": 19.00,
"retailPrice": 19.00,
"taxRate": 10,
"netWeightKg": 0.500,
"hsCode": "15092000",
"countryOfOriginIso": "IT",
"active": 1,
"condition": "New",
"unitOfMeasure": "PZ",
"hasAttributes": true,
"hasImages": true,
"hasSpecifications": true
}
]
GET Media, Variations, Pricing & Real-Time Inventory
High-performance modular endpoints engineered for frequent stock, weight, and price synchronization (every 15 minutes) without transferring static text or media payloads.
[
{
"id": 502,
"productId": 104,
"sku": "PRD-BIO-OLV-001-500ML",
"ean13": "8051234567890",
"mpn": "MPN-OLV-500",
"wholesalePrice": 11.40,
"recommendedRetailPrice": 19.00,
"netWeightKg": 0.500,
"grossWeightKg": 0.820,
"inventoryQuantity": 140,
"option1Name": "Format",
"option1Value": "500 ml"
}
]
POST Logistics Carriers & Matrix Shipping Calculation
Calculates real-time shipping rates by evaluating the cumulative gross/net weight of all requested SKUs against the producer's configured carrier zone matrix (matching destination Country ISO code and Postal Code prefixes for islands or remote zones).
{
"order": {
"delivery": {
"isoCountry": "DE",
"postcode": "10115"
},
"products": [
{ "reference": "PRD-BIO-OLV-001-500ML", "quantity": 2 }
]
}
}
{
"totalWeightKg": 1.640,
"shippingOptions": [
{
"serviceId": 1,
"serviceName": "Express International Courier",
"delay": "1-3 days",
"costWithoutTaxes": 12.50,
"costWithTaxes": 15.25
},
{
"serviceId": 2,
"serviceName": "Standard Road Freight",
"delay": "2-4 days",
"costWithoutTaxes": 8.90,
"costWithTaxes": 10.86
}
]
}
POST Simulate & Submit B2B / Dropshipping Order
Use /rest/order/check.json to verify real-time inventory availability on the producer's warehouse and calculate the exact net subtotal, shipping fee, and applicable VAT prior to order placement.
Use /rest/order/create.json to register the order directly into the producer's fulfillment system. Billing details are automatically bound to your B2B fiscal profile while the parcel is dispatched to the end-customer's shipping address.
{
"order": {
"internalReference": "EXT-ORD-2026-99481",
"language": "en",
"paymentMethod": "fido_or_prepaid",
"salesChannelName": "B2B_API",
"carriers": [
{ "id": 2 }
],
"shippingAddress": {
"firstName": "Lukas",
"lastName": "Weber",
"country": "DE",
"postcode": "10115",
"town": "Berlin",
"province": "BE",
"address": "Torstrasse 112",
"phone": "+4915123456789",
"email": "recipient@example.de",
"comment": "Deliver to reception desk"
},
"products": [
{
"reference": "PRD-BIO-OLV-001-500ML",
"quantity": 2,
"internalOrderItemId": "LINE-1"
}
]
}
}
{
"orderId": "5021",
"orderCode": "B2B-5-20261028153012-A9F1",
"internalReference": "EXT-ORD-2026-99481",
"orderStatus": "In Lavorazione",
"paymentStatus": "Fido Commerciale B2B",
"totalAmount": 33.66,
"currency": "EUR"
}
GET Order Tracking & Shipment Fulfillment
Retrieve carrier tracking numbers, courier names, and live tracking URLs from the producer's server by supplying either the ScaleIndex orderId, the orderCode, or your external internalReference.
{
"id": 5021,
"orderCode": "B2B-5-20261028153012-A9F1",
"reference": "EXT-ORD-2026-99481",
"status": "Spedito",
"trackings": [
{
"trackingNumber": "079123456789",
"courierName": "Express Courier",
"trackingUrl": "https://tracking.carrier-example.com/?parcel=079123456789",
"status": "Shipped",
"dispatchedAt": "2026-10-28T16:45:00Z"
}
]
}