@peabody-soft/mbs-protos 1.0.0

package/Message.proto

@@ -0,0 +1,40 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "Entity.proto";
+import "MessageType.proto";
+import "PartyPreferencesPayload.proto";
+import "SalesOrderPayload.proto";
+import "TaskStatus.proto";
+
+// A message sent to a business. An order is a message with a SalesOrderPayload; the shopping cart
+// of a customer is a message with a PartyPreferencesPayload.
+// In Java the payload is a serialized string, whose type is determined by messageType; it is typed
+// here. There is no payload for MONEY_TRANSFER messages in this protocol.
+message Message {
+
+  Entity entity = 1;
+
+  // Id of the entity that sent this message - the User of the customer, for anything a storefront
+  // creates. That user is not carried by a business sync out, so a client that needs more than the
+  // id resolves it against a profile sync out, or against senderName and senderPhone below.
+  int64 senderId = 2;
+
+  MessageType messageType = 3;
+
+  TaskStatus status = 4;
+
+  // At most Constants.MESSAGE_SENDER_NAME_MAX_LENGTH
+  optional string senderName = 5;
+
+  // E.164 formatted phone number of the sender
+  optional string senderPhone = 6;
+
+  oneof payload {
+
+    SalesOrderPayload salesOrder = 7;
+    PartyPreferencesPayload partyPreferences = 8;
+  }
+}

package/MessageType.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+// The type of a message, which determines the type of its payload.
+// Values match the ids of the corresponding Java enum entries and must never be changed.
+enum MessageType {
+
+  // MoneyTransferPayload is not part of this protocol - the id is retained so that the values
+  // below continue to match their Java counterparts
+  MONEY_TRANSFER = 0;
+
+  // An order placed by a customer - the payload is a SalesOrderPayload
+  SALES_ORDER = 1;
+
+  // The preferences of a party, including the shopping cart - the payload is a
+  // PartyPreferencesPayload
+  PARTY_PREFERENCES = 2;
+
+  // An unknown type of message
+  OTHER = 32767;
+}

package/OrderStatus.proto

@@ -0,0 +1,30 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+// Status of a sales order.
+// Values match the ids of the corresponding Java enum entries and must never be changed.
+enum OrderStatus {
+
+  // Not started working on the order yet
+  NOT_STARTED = 0;
+
+  // Getting ready to start processing the order
+  PREPARING = 4;
+
+  // The order is being processed
+  PROCESSING = 8;
+
+  // The order is ready for service / delivery / pickup
+  READY = 12;
+
+  // The order is being served / delivered to the customer
+  FULFILLING = 16;
+
+  // The order has been completed successfully
+  FULFILLED = 20;
+
+  // The order has been cancelled
+  CANCELLED = 24;
+}

package/Package.proto

@@ -0,0 +1,34 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "Dimensions.proto";
+import "Item.proto";
+import "PackageIdentifier.proto";
+import "Weight.proto";
+
+// A package (or variant) of a product: a difference in quantity, colour or size - a 500 gram
+// bottle of mango pickle, for example.
+// The product of a package is its Item.parentItemId. A package contains no other entity: its
+// prices are the prices whose packageId is this package, and its photos are the Attachments whose
+// owningEntityId is this package.
+// Excluded: isLowStockWarningEnabled, lowStockLevel, storeProperties and all Translations fields.
+message Package {
+
+  // Base class - carries the Entity of this package
+  Item item = 1;
+
+  // True if this package can be bought in variable quantities (4.2 litres of oil, for example)
+  bool isSoldLoose = 2;
+
+  // GTIN, barcode, etc.
+  int64 itemCode = 3;
+
+  // Identifiers of this package, one per kind of identifier (at most Constants.MAX_IDENTIFIERS)
+  repeated PackageIdentifier identifiers = 4;
+
+  Dimensions dimensions = 5;
+
+  Weight weight = 6;
+}

package/PackageIdentifier.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "PackageIdentifierType.proto";
+
+// An identifier of a package, and the kind of identifier it is. A protobuf map cannot be keyed by
+// an enum, so the identifiers of a package are a repeated pair rather than a map.
+message PackageIdentifier {
+
+  PackageIdentifierType type = 1;
+
+  // The identifier itself (at most Constants.IDENTIFIER_MAX_LENGTH)
+  string value = 2;
+}

package/PackageIdentifierType.proto

@@ -0,0 +1,30 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+// A kind of identifier that a package can carry.
+// The Java enum identifies these by string id rather than by number, so the values below are
+// numbered here: map each one to the Java id given in its comment.
+enum PackageIdentifierType {
+
+  UNSPECIFIED_PACKAGE_IDENTIFIER_TYPE = 0;
+
+  // "gtin8" - a.k.a EAN-8
+  GTIN_8 = 1;
+
+  // "gtin12" - a.k.a UPC or UPC-A
+  GTIN_12 = 2;
+
+  // "gtin13" - a.k.a EAN or EAN-13 or JAN
+  GTIN_13 = 3;
+
+  // "gtin14" - a.k.a ITF-14 or UCC-14
+  GTIN_14 = 4;
+
+  // "isbn13"
+  ISBN_13 = 5;
+
+  // "sku_id"
+  SKU_ID = 6;
+}

package/PartyPreferencesPayload.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "FulfillmentMode.proto";
+import "ShoppingList.proto";
+
+// The payload of a PARTY_PREFERENCES message: the preferences of a customer of a business,
+// including their shopping cart. In Java the shopping list is held as a serialized string.
+// Excluded: serializedUserSettings.
+message PartyPreferencesPayload {
+
+  // The shopping cart of the customer: packages that have been picked but not yet ordered
+  ShoppingList shoppingList = 1;
+
+  // Fulfillment mode the customer last chose.
+  // UNSPECIFIED_FULFILLMENT_MODE means they have not chosen one.
+  FulfillmentMode fulfillmentMode = 2;
+}

package/PaymentMethod.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+// A method by which a customer can pay a business.
+// Values match the method ids of the corresponding Java enum entries and must never be changed.
+enum PaymentMethod {
+
+  // India: Unified Payments Interface. Supports QR codes.
+  UPI = 0;
+
+  // A method that is not known to this version
+  OTHER_METHOD = 32767;
+}

package/PaymentMethodDetail.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "PaymentMethod.proto";
+
+// A payment method that a business accepts, and the details a customer needs in order to use it.
+// Excluded: targetLedgerId.
+message PaymentMethodDetail {
+
+  PaymentMethod method = 1;
+
+  // Details of this method - the UPI id of the business, for example
+  // (at most Constants.PAYMENT_METHOD_DATA_MAX_LENGTH)
+  optional string data = 2;
+}

package/Price.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "Item.proto";
+
+// The price of a package. Item.parentItemId is the id of the PriceList this price belongs to.
+// A storefront is sent only the prices of the price list it sells from, and that price list, so
+// every price it receives for a package can be displayed and its list can always be resolved.
+// Not included because it is derived: finalPrice, which is offerPrice when that is greater than
+// zero and less than regularPrice, and regularPrice otherwise.
+message Price {
+
+  // Base class - carries the Entity of this price
+  Item item = 1;
+
+  // Id of the package this price applies to. Nothing nests in this protocol, so this is how a
+  // client finds the prices of a package.
+  int64 packageId = 2;
+
+  // The price the package is normally sold at, multiplied by Constants.AMOUNT_FACTOR
+  int64 regularPrice = 3;
+
+  // The price the package is on sale at, multiplied by Constants.AMOUNT_FACTOR.
+  // 0 means this package is not on offer. Never greater than regularPrice.
+  int64 offerPrice = 4;
+}

package/PriceList.proto

@@ -0,0 +1,31 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "Item.proto";
+
+// A named list of prices. A price list contains nothing: the prices of a price list are the
+// prices whose Item.parentItemId is this price list. A price list has no parent of its own, so
+// its own Item.parentItemId is 0.
+//
+// A business keeps at least two, created on its first catalog load with the well known ids
+// Constants.DEFAULT_SALE_PRICE_LIST and Constants.DEFAULT_PURCHASE_PRICE_LIST, and may have more.
+// A storefront sells from exactly one of them and is sent only that one, so that no package ever
+// arrives with two prices to choose between; every Price a client receives therefore belongs to
+// the single price list it also receives.
+//
+// This is carried rather than left as the bare Item.parentItemId of a Price for two reasons: a
+// price list has a name, and a client that pushes a shopping cart back has to name the price list
+// its prices came from in ShoppingList.priceListId.
+//
+// Excluded: isPurchasePriceList, which says whether a list holds the prices the business buys at
+// rather than sells at. A purchase price list is not public and its prices are of no use to a
+// customer, so a storefront is never sent one and the flag would always be false (see the
+// visibility flags, which are left out for the same reason). Java keeps it in the packed category
+// short, which is never sent.
+message PriceList {
+
+  // Base class - carries the Entity of this price list
+  Item item = 1;
+}

package/Product.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "Address.proto";
+import "Item.proto";
+import "ProductType.proto";
+import "Tax.proto";
+
+// A product (goods, service, raw material or fixed asset) in the catalog of a business.
+// A product belongs to at most one product category, whose id is Item.parentItemId (0 when it
+// belongs to none). A product contains no other entity: its packages are the packages whose
+// Item.parentItemId is this product, and its photos are the Attachments whose owningEntityId is
+// this product.
+// Excluded: isDraft, forOfflineSaleOnly, isStockKeepingEnabled, isExpiryTrackingEnabled,
+// storeProperties, defaultExpiry, classifications and all Translations fields.
+message Product {
+
+  // Base class - carries the Entity of this product
+  Item item = 1;
+
+  ProductType productType = 2;
+
+  // At most Constants.PRODUCT_BRAND_MAX_LENGTH
+  optional string brand = 3;
+
+  // Absent means true: this product is manufactured by the business that sells it
+  optional bool isManufacturedByBusiness = 4;
+
+  // At most Constants.PRODUCT_MANUFACTURER_MAX_LENGTH
+  optional string manufacturer = 5;
+
+  Address manufacturerAddress = 6;
+
+  // Taxes that apply to this product (at most Constants.MAX_TAXES)
+  repeated Tax taxes = 7;
+
+  // One line bullet points about this product (at most Constants.PRODUCT_MAX_FEATURES, each at
+  // most Constants.PRODUCT_FEATURE_MAX_LENGTH)
+  repeated string features = 8;
+}

package/ProductCategory.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "Item.proto";
+
+// A category that groups products of a catalog. Its name is always set.
+// A category contains nothing: the products of a category are the products whose
+// Item.parentItemId is this category. A product belongs to at most one category, and a product
+// whose parentItemId is 0 belongs to none.
+message ProductCategory {
+
+  // Base class - carries the Entity of this category
+  Item item = 1;
+}

package/ProductType.proto

@@ -0,0 +1,26 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+// The kind of product. Values match the type ids of the corresponding Java enum entries, which are
+// bit flags, and must never be changed.
+enum ProductType {
+
+  UNSPECIFIED_PRODUCT_TYPE = 0;
+
+  // Tangible, sold and purchased
+  GOODS = 1;
+
+  // Intangible, sold
+  SERVICE_SOLD = 2;
+
+  // Tangible, purchased
+  RAW_MATERIAL = 4;
+
+  // Intangible, purchased
+  SERVICE_PURCHASED = 8;
+
+  // Tangible, purchased
+  FIXED_ASSET = 16;
+}

package/ProfileSyncOutRequest.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+// A request to sync out the profile of the caller: who they are, which businesses they are linked to,
+// and those businesses. This is what signs an existing user in, and it is incremental, so the request
+// carries a cursor per entity type and the ProfileSyncOutResponse carries only what has changed since.
+//
+// Who is asking is not part of this message: it is in the AuthTokens of the authorization header. That
+// is also why the request names no business - a profile is not scoped to one, and the response is what
+// tells the caller which businesses exist for them.
+//
+// There is one cursor per entity type this reads, and they are exactly the three entity types that
+// Java puts in a profile database (EntityType with DbType.PROFILE that this protocol carries): USER,
+// BUSINESS and BUSINESS_LINK. A business database is read by a BusinessSyncOutRequest instead, and the
+// two sets of cursors never mix - an update number is only comparable within one entity type, and only
+// against the same database.
+//
+// Each cursor below is the highest Entity.updateNumber of that entity type that this client has
+// already synced out. The server sends back the entities of that type whose updateNumber is greater,
+// so a client stores the highest updateNumber it receives per type and sends it back on the next call.
+// Zero, the default, means this client has nothing yet and asks for everything - signing in for the
+// first time therefore leaves every cursor unset.
+//
+// Sync out is bounded: one call returns at most Constants.SYNC_OUT_LIMIT entities across all types
+// together. On receiving that many, a client must call again with its updated cursors until it
+// receives fewer.
+message ProfileSyncOutRequest {
+
+  // The caller themselves - entity type Constants.USER_ENTITY_TYPE_ID
+  int64 userUpdateNumber = 1;
+
+  // The businesses the caller is linked to - entity type Constants.BUSINESS_ENTITY_TYPE_ID.
+  // A Business is a profile database entity, which is why it is read here and not by a
+  // BusinessSyncOutRequest - that call returns the contents of one business, not the business itself.
+  int64 businessUpdateNumber = 2;
+
+  // The links between the caller and those businesses, each carrying the token that lets the caller
+  // act against one of them - entity type Constants.BUSINESS_LINK_ENTITY_TYPE_ID
+  int64 businessLinkUpdateNumber = 3;
+}

package/ProfileSyncOutResponse.proto

@@ -0,0 +1,64 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "Business.proto";
+import "BusinessLink.proto";
+import "User.proto";
+
+// The answer to a ProfileSyncOutRequest: who the caller is, which businesses they are linked to, and
+// those businesses. This is what signs an existing user in - a client calls it with the credentials in
+// the AuthTokens of the authorization header and gets back everything it needs to know about the
+// customer before it reads any one business.
+//
+// This is the other half of the split the business sync messages leave open: a BusinessSyncOutResponse
+// carries what is in a business database and therefore no User and no BusinessLink, and this carries
+// what is in a profile database. Java splits them the same way, into Service.profileSyncOut and
+// Service.businessSyncOut. A Business is a profile database entity and belongs here; it is also
+// carried by a BusinessSyncOutResponse, so that a client that has not signed in can still learn the
+// business it is showing.
+//
+// How a client uses it:
+//   1. user            who the caller is, and the addresses an order can be delivered to
+//   2. businessLinks   one per business the caller is linked to. Each names its business in
+//                      BusinessLink.businessId and carries the BusinessLink.linkToken that goes into
+//                      AuthTokens.linkToken of every later request about that business.
+//   3. businesses      the businesses those links name, so that a client can show the caller a list
+//                      of shops without a call per shop. Match BusinessLink.businessId against
+//                      Business.entity.id, not against Business.businessId.
+// Nothing is nested, for the same reason nothing is nested in a business sync out: a link and the
+// business it names change independently, so a tree could not say which of them a response is
+// reporting.
+//
+// Every field is optional, as follows. A signed in caller whose profile has not changed gets a
+// response with nothing in it at all, which is valid and means "nothing new".
+// - user is a singular message field, so it has explicit presence: absent means the profile of the
+//   caller has not changed, not that there is no caller.
+// - businessLinks and businesses are repeated, and a proto3 repeated field cannot be marked optional
+//   because it has no presence of its own. An empty array is the absent state, and means no link or
+//   no business has changed - it never means the caller has none. Only an arriving entity, or a
+//   tombstone, changes what a client holds.
+//
+// A tombstone works as it does in a business sync out: an entity whose
+// (updateNumber & Constants.UPDATE_TYPE_MASK) equals Constants.UPDATE_TYPE_DELETED has been deleted,
+// only its Entity is meaningful, and a deleted BusinessLink means the caller may no longer reach that
+// business and its link token must be discarded.
+//
+// This sync out is incremental and bounded, exactly as the business one is: ProfileSyncOutRequest
+// carries a cursor for each of the three entity types below, and one response returns at most
+// Constants.SYNC_OUT_LIMIT entities across all three together. A client that receives that many
+// raises each cursor to the highest updateNumber it has seen for that type and requests again, until
+// it receives fewer. The response carries no cursors of its own: a client computes them from the
+// entities it receives.
+message ProfileSyncOutResponse {
+
+  // The caller. Absent unless their own profile has changed.
+  User user = 1;
+
+  // The businesses the caller is linked to, and the token for each. Empty unless a link has changed.
+  repeated BusinessLink businessLinks = 2;
+
+  // The businesses that the links above name. Empty unless a business has changed.
+  repeated Business businesses = 3;
+}

package/README.md

@@ -0,0 +1,27 @@
+# @peabody-soft/mbs-protos
+
+The MeraBills shop wire protocol: the `.proto` files themselves, unchanged, published so any
+client can install them and compile them with whatever protoc plugin its own language and
+toolchain need. This directory is the single source of the protocol - the Java server also
+generates from it - so the package ships these files as-is rather than a compiled form of them.
+
+A TypeScript client, for instance, runs its own `protoc` (via `@protobuf-ts/plugin`, `ts-proto`,
+or similar) against the installed package's `.proto` files. This package has no build step and no
+opinion on which plugin or language a consumer uses.
+
+## Publish
+
+```
+npm login
+npm version <patch|minor|major>
+npm publish
+```
+
+## Use
+
+```
+npm install @peabody-soft/mbs-protos
+```
+
+The `.proto` files land at `node_modules/@peabody-soft/mbs-protos/*.proto`. Point your `protoc`
+`--proto_path` there.

package/ReservedPackage.proto

@@ -0,0 +1,35 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+// The packages reserved for the charge and summary lines of a shopping list. A ShoppingListItem
+// whose packageId is one of these is not a catalog package and will never be found in the catalog:
+// it carries a charge, a discount or the list total, and a client must label it itself.
+//
+// A reserved package id does not fit in an enum value, which is 32 bits, so the value below is the
+// low part of the id and a client builds the whole id as
+//
+//   id = (Constants.PACKAGE_ENTITY_TYPE_ID << Constants.ENTITY_TYPE_BIT_SHIFT) | value
+//
+// using 64 bit arithmetic - BigInt in TypeScript. The four ids that produces are
+// 4611686018427387904, 4611686018427387905, 4611686018427387906 and 4611686018427387907
+// (0x4000000000000000 to 0x4000000000000003). Conversely, a packageId is a reserved package when
+// its low 56 bits are less than or equal to SERVICE_CHARGE_PACKAGE.
+//
+// This is a carrier for constants, not the type of any field, so zero being a real value is safe.
+enum ReservedPackage {
+
+  // The total of the shopping list. Present only in a list a merchant has laid out for display;
+  // a storefront should prefer ShoppingList.totalAmountBeforeDiscount.
+  TOTAL_PACKAGE = 0;
+
+  // The discount applied to the whole shopping list
+  DISCOUNT_PACKAGE = 1;
+
+  // The delivery charge, added when ShoppingList.autoAddDeliveryCharge is true
+  DELIVERY_CHARGE_PACKAGE = 2;
+
+  // The service charge, added when ShoppingList.autoAddServiceCharge is true
+  SERVICE_CHARGE_PACKAGE = 3;
+}

package/Role.proto

@@ -0,0 +1,44 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+// What an entity linked to a business may do with it. This is the role of a BusinessLink.
+//
+// The values are the ids of the Java Role entries and must never change. Each is built from a group
+// and a role within that group, (groupId << 6) | roleId, so they are not consecutive: the group is
+// the upper bits and, within a group, a higher value means fewer rights. The groups are
+// 0 owner, 1 employee, 2 vendor, 3 customer, 4 partner and 63 other. A client that only needs to
+// know which group a role is in can compute it as (role >> 6); a client that needs the actual rights
+// cannot, because the rights are not on the wire.
+//
+// A storefront customer is normally CUSTOMER. The other values are here so that a role a storefront
+// does not expect maps to a name rather than to a number, and so that the numbering cannot drift
+// from Java by having gaps filled in later.
+enum Role {
+
+  // Owner group. Only a user can be in one of these roles.
+  PRIMARY_OWNER = 0;   // Can do anything, and is the entity that is billed
+  OWNER = 8;           // Can do anything except remove the primary owner
+
+  // Employee group. Only a user can be in one of these roles.
+  MANAGER = 96;
+  AGENT = 104;
+  STAFF = 112;
+
+  // Vendor group. A user or a business can be in this role.
+  VENDOR = 160;
+
+  // Customer group. A user or a business can be in this role, and this is the role a storefront
+  // customer has.
+  CUSTOMER = 224;
+
+  // Partner group. An entity in one of these roles has no party id.
+  ACCOUNTANT = 272;
+  AUDITOR = 280;
+  MENTOR = 304;
+
+  // No rights at all to the business. Also what Java returns for an id it does not recognise, so a
+  // client that receives this should treat the link as unusable rather than as an error.
+  NONE = 4095;
+}

package/SalesOrderPayload.proto

@@ -0,0 +1,37 @@
+syntax = "proto3";
+package com.merabills.storefront;
+option java_multiple_files = true;
+option java_package = "com.merabills.server.core.generated";
+
+import "FulfillmentMode.proto";
+import "OrderStatus.proto";
+import "ShoppingList.proto";
+
+// The payload of a SALES_ORDER message: an order placed by a customer.
+// Excluded: serviceStationNumber and dueDate.
+// Payments made against an order are not part of this payload - they are payment transactions
+// whose parent is the income transaction of the order.
+message SalesOrderPayload {
+
+  OrderStatus status = 1;
+
+  FulfillmentMode fulfillmentMode = 2;
+
+  // What was ordered
+  ShoppingList shoppingList = 3;
+
+  // Total of the shopping list, multiplied by Constants.AMOUNT_FACTOR
+  int64 shoppingListTotal = 4;
+
+  // Number of items in the shopping list
+  int32 shoppingListCount = 5;
+
+  // Id of the delivery address, in User.addresses of the customer. 0 means no address.
+  int64 deliveryAddressId = 6;
+
+  // Time this order was created, in milliseconds since Jan 1, 1970 00:00:00 UTC
+  int64 creationDate = 7;
+
+  // Note from the customer (at most Constants.SALES_ORDER_NOTE_MAX_LENGTH)
+  optional string note = 8;
+}