Octopus RPC

Octopus Store

Underlying Specs

Entities Hierarchy Overview

• Brand

• Catalog
  └ Price

• CustomerNext

• DetailCategory

• Product
  ├ ProductDetail
  └ ProductVariant
    ├ Picture
    └ Stock

• Taxon

• VariantCategory
  └ VariantOption

• UoM
• Order

• EntitiesChangelog

Low Level Entity Schemata

object { # | Ω(#) := "Brands"
	union {integer{1,}; null} "id";
	string{,50} "name" = "";
} "Brand"

object { # | Ω(#) := "BuyTogether"
	union {integer{1,}; null} "id";
	integer{1,} "idProductA";
	integer{1,} "idProductB";
	number{0,} "discount";
	integer{0,} "status";
	integer{1,} "idProductVariantB" ?;
	string{0,} "daysOfWeek" ?;
	string{10,19} "dtExpiration" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;
} "BuyTogetherEntry"

array [ # := "Cart"
	string {1, 32} "id";
	integer "idProductVariant" = 0;
	integer "quantity" = 0;
	string{10,19} "display_priority" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;
	integer "idBuyTogether" = 0;
]

"Cart"

object { # | Ω(#) := "Catalogs"
	union {integer{1,}; null} "id";
	string{,32} "code" = "";
	string      "name" = "";
	number{0,}  "minimum_order_amount" = 0;
} "Catalog"

object { # | Ω(#) := "Configs"
	union {string{,64}; null} "idModule";
	string "config";
} "Config"

object { # | Ω(#) := "CrossSelling"
	union {integer{1,}; null} "id";
	integer{1,} "idProductA";
	integer{1,} "idProductB";
	integer{0,} "active";
} "CrossSellingEntry"

object { # | Ω(#) := "Customers"
	union {integer{1,}; null} "id";
	integer{1,} "idCatalog";

string{1,1} "userType" ["F", "J"] = "F";
	string{,50} "fullname" = "";
	string{1,1} "gender" ["M", "F"] = "M";
	string{10,19} "birthday" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/;

string{,20} "cpf_cnpj_passaporte" = "";
	string{,20} "rg_ie" = "";

string{,50} "company" = "" ?;
	string{,20} "department" = "" ?;
	string{,20} "occupation" = "" ?;

string{,50} "email" = "";
	string{,50} "telephone" = "";
	string{,50} "cellular_faxNumber" = "" ?;

string{,10} "password" = "" ?;

string{,100} "street" = "";
	string{,20} "number" = "";
	string{,50} "poBox" = "" ?;
	string{,50} "neighborhood" = "" ?;
	string{,50} "locality" = "";
	string{,50} "region" = "";
	string{,50} "country" = "";
	string{,8} "postalCode" = "";

boolean "active" = true;
} "Customer"

object { # | Ω(#) := "Customers"
	union {integer{1,}; null} "id";
	integer{1,} "idCatalog" = 1;

string{1,1} "userType" ["F", "J"] = "F";
	string{,50} "fullname" = "";
	string{1,1} "gender" ["M", "F"] = "M";
	string{10,19} "birthday" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/;

string{,20} "cpf_cnpj_passaporte" = "";
	string{,20} "rg_ie" = "";

string{,50} "company" = "" ?;
	string{,20} "department" = "" ?;
	string{,20} "occupation" = "" ?;

string{,50} "email" = "";
	string{,50} "telephone" = "";
	string{,50} "cellular_faxNumber" = "" ?;

string{,24} "password" = "" ?;

string "notes" ?;
	string "privateNotes" ?;

string{10,19} "dtIns" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;
	string{10,19} "dtUpd" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;

boolean "active" = true;

array{
		object{
			string{,50} "id" = "";
			string{,50} "contact" = "";
			string{,100} "street" = "";
			string{,20} "number" = "";
			string{,50} "poBox" = "" ?;
			string{,50} "neighborhood" = "" ?;
			string{,50} "locality" = "";
			string{,50} "region" = "";
			string{,50} "country" = "";
			string{,8} "postalCode" = "";
		}
	} "shipping_addresses" = [] ?;

object{}* "custom_fields" ?;
} "CustomerNext"

object { # | Ω(#) := "Dbs"
	string "sqlcmd" = "";
} "Db"

object { # | Ω(#) := "DetailCategories"
	union {integer{1,}; null} "id";
	string{,50} "name" = "";
	string "template" = "";
	boolean "freeze" = false;
	integer "display_priority" = 0;
} "DetailCategory"

object { # | Ω(#) := "EntitiesChangelogs"
	string{,32} "entity";
	union {integer{1,};} "id";
	string{,32} "action" ["INSERT","UPDATE","DELETE"];
	string{10,19} "made_at" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;
} "EntitiesChangelog"

object { # | Ω(#) := "Orders"
	union {integer{1,}; null} "id";
	integer{1,} "idCustomer";
	integer{-1,} "idPayment";
	integer "idStatus" [0,1,2,3,4,5];
		# 0: CANCELADO
		# 1: AGUARDANDO_PAGAMENTO
		# 2: EM ANÁLISE
		# 3: PAGO
		# 4: ENVIADO_PARA_TRANSPORTADORA
		# 5: FINALIZADO

string{10,19} "dtIns" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;
	integer{1,} "code" ?;
	boolean "unread" ?;

array{
		object {
			integer{1,} "idParent" ?;
			string{,32} "sku";
			string{,256} "name";
			number{0,} "price";
			integer{0,} "qty";
			string{,10} "uom";
			integer{0,} "width";
			integer{0,} "height";
			integer{0,} "depth";
			integer{0,} "weight";
			object{}* "custom_fields";
		}
	} "items" = [];
	number "alpha" = 1;
	number "beta" = 0;

array{
		object {
			integer{1,} "idParent" ?;
			string{,50} "name";
			string{,50} "code";
			number{0,} "value";
		}
	} "coupons_giftcards" = [];

object {
		string{,100} "street";
		string{,20} "number";
		string{,50} "poBox";
		string{,50} "neighborhood";
		string{,50} "locality";
		string{,50} "region";
		string{,50} "country";
		string{,8} "postalCode";
	} "billing_address";

string{,50} "addressee" = "";

number{0,} "shipping_cost";
	boolean "is_gift" = false;

integer{1,} "compound_interest_t";
	number "compound_interest_i";
	number "credit_card_charge";
	number "acrescimo_substituicao_tributaria";

number "buy_together_discount";

string "notes";

object{}* "custom_fields";
} "Order"

object { # | Ω(#) := "Pictures"
	union {integer{1,}; null} "id";
	integer{1,} "idProductVariant";
	string{,1024} "src";
	string{,256} "alt";
	boolean "icon" = false;
	integer "display_priority" = 0;
	union {integer{1,}; null} "idBoundVariant";
} "Picture"

object { # | Ω(#) := "Prices"
	union {integer{1,}; null} "id";
	integer{1,} "idCatalog";
	integer{1,} "idProductVariant";
	integer "idAvailability" [1,2,3];
		# 1:EM_ESTOQUE
		# 2:ESGOTADO
		# 3:SOB_CONSULTA
	integer "idStatus" [1,2,3,4];
		# 1:NORMAL
		# 2:PROMOCAO
		# 3:LANCAMENTO
		# 4:ILUSTRATIVO
	number{0,} "price";
	number{0,} "discount";
	object{}* "custom_fields" ?;
} "Price"

object { # | Ω(#) := "Products"
	union {integer{1,}; null} "id";
	string{,100} "name" = "";
	integer{1,} "idBrand";
	integer{1,} "idUoM";
	integer "display_priority" = 0;
	boolean "display_at_home" = false;
	boolean "has_image" = true;
	integer{0,} "swap_depth" = 0;
	object{}* "custom_fields" ?;
} "Product"

object { # | Ω(#) := "ProductCategories"
	union {integer{1,}; null} "id";
	string{,50} "name" = "";
} "ProductCategory"

object { # | Ω(#) := "ProductDetails"
	union {integer{1,}; null} "id";
	integer{1,} "idProduct";
	integer{1,} "idDetailCategory";
	string "content" = "";
	integer "display_priority" = 0;
} "ProductDetail"

object { # | Ω(#) := "ProductVariants"
	union {integer{1,}; null} "id";
	integer{1,} "idProduct";
	string{,50} "composition" = "";
	string{,32} "sku";
	integer{0,} "width";
	integer{0,} "height";
	integer{0,} "depth";
	integer{0,} "weight";
	boolean "active" = true;
	boolean "icon" = false;
	integer "display_priority" = 0;
} "ProductVariant"

object { # | Ω(#) := "Quotations"
	union {string{,32}; null} "id";
	string{,64} "email" = "";
	string{,8} "postalCode";
	object{}* "custom_fields";

array{
		object {
			string{,32} "idParent";
			integer{1,} "idProductVariant";
			integer{0,} "qty";
			object{}* "custom_fields";
		}
	} "items" = [];
} "Quotation"

object { # | Ω(#) := "Salesmen"
	union {integer{1,}; null} "id";
	string{,50} "name" = "";
	boolean "active" = true;
	string{10,19} "dtIns" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;
	string{10,19} "dtUpd" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;
	object{}* "custom_fields" ?;
} "Salesman"

object { # | Ω(#) := "Inventory"
	union {integer{1,}; null} "id";
	integer{1,} "idProductVariant";
	integer{0,} "minimum_quantity";
	integer{0,} "quantity";
} "Stock"

object { # | Ω(#) := "UnitsOfMeasurement"
	union {integer{1,}; null} "id";
	string{,10} "abbr" = "";
	string{,50} "name" = "";
} "UoM"

object { # | Ω(#) := "VariantCategories"
	union {integer{1,}; null} "id";
	string{,50} "name" = "";
	integer "display_priority" = 0;
} "VariantCategory"

object { # | Ω(#) := "VariantOptions"
	union {integer{1,}; null} "id";
	integer{1,} "idVariantCategory";
	string{,50} "name" = "";
	integer "display_priority" = 0;
} "VariantOption"