Skip to main content
Version: 1.0.0

CatalogOrders

Purpose​

The CatalogOrders collection defines the structure of catalog-related operations.
Its purpose is to track actions requested on catalogs (such as adding assets), including references to products, variants, and processing status.

Document schema​

{
"catalogRef": "string",
"clientId": "string",
"list_3d_assets_results": [
{
"cataloguesProductsRef": "string",
"cataloguesVariantsRef": "string",
"eanCode": "string",
"isSelected": "boolean",
"result": "string",
"skuCode": "string",
"status": "string",
"upcCode": "string"
}
],
"profile": "string",
"status": "string",
"timestamp": {
"__time__": "timestamp"
},
"type": "string"
}

Indexes​

  • catalogRef is a string that refers to the ID of the Catalogues collection;
  • clientId is a string that refers to the ID of the Client collection;
  • cataloguesProductsRef is a string that refers to the ID of the CataloguesProducts collection;
  • cataloguesVariantsRef is a string that refers to the ID of the CataloguesVariants collection;
  • profile is a string that refers to the ID of the Profiles collection;

Query examples​

// Fetch the Reference Doc from Firebase
const catalogOrderRefDoc = doc(db, "CatalogOrders", catalogOrderId);

// Get the Document Snapshot from the Reference Doc
const catalogOrderRefSnap = await getDoc(catalogOrderRefDoc);