Service - Sell Offer Standard: Difference between revisions

From Izara Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 7: Line 7:
https://bitbucket.org/izara-market-products/izara-market-products-sell-offer-standard/src/master/
https://bitbucket.org/izara-market-products/izara-market-products-sell-offer-standard/src/master/


= DynamoDB tables =
= Object Schemas =
; Additional Information: [[Per Service Schemas]]


== [[Standard Config Table Per Service]] ==
== objType ==


=== Configuration tags ===
=== sellOfferStandard ===


<syntaxhighlight lang="JavaScript">
<syntaxhighlight lang="JavaScript">
{
{
configTag: "SellOfferHandlerServiceNameTag"
objectType: "sellOfferStandard",
configKey: "SellOfferHandlerServiceNameTag"
extendObjType: {
configValue: xxx // this own services ServiceNameTag, eg "SellOfferStandard"
serviceTag: "sellOfferManager",
}
objectType: "sellOffer"
</syntaxhighlight>
},
 
storageResources: {
<syntaxhighlight lang="JavaScript">
myGraph: {
{
storageType: "graph",
configTag: "ProductGraphServiceName"
graphServerTag: "GraphHandler"
configKey: "ProductGraphServiceName"
}
configValue: xxx // eg: "ProductGraph"
    },
}
    fieldNames: {
</syntaxhighlight>
currencyId: {
 
type: "currency",
<syntaxhighlight lang="JavaScript">
storageResourceTags: ['myGraph']
{
configTag: "SellOfferManagerServiceName"
configKey: "SellOfferManagerServiceName"
configValue: xxx // eg: "SellOfferManager"
}
</syntaxhighlight>
 
== LogicalResults ==
 
Stores results for any requests to perform logical searches on sell offer data
 
<syntaxhighlight lang="JavaScript">
{
resultId: xxx // eg: filterMainId for a single logical element
dataId: xxx // one sellofferId
}
</syntaxhighlight>
 
* partition key: resultId
* sort key: dataId
 
= Graph database =
 
== [[Service - Products Graph]]==
 
=== Nodes ===
 
<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{SellOfferStandardLib.SELL_OFFER_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
sellOfferId: {
identifier: true, //(random uuid)
},
productId: {
immutable: true,
},
sellOfferHandlerServiceNameTag: {
immutable: true,
},
currencyId: {
immutable: true, // matches the sellOfferPlan's currencyId
},
},
},
}
    },
}
}
</syntaxhighlight>
</syntaxhighlight>


=== Relationships ===
== Object Relationships ==


<syntaxhighlight lang="JavaScript">
= SellOffer currency =
{
relationshipType: "{SellOfferStandardLib.createHasSellOfferGraphRelationshipType()}", //"has_sellOffer"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{SellOfferStandardLib.createDisabledSellOfferGraphRelationshipType()}", //"disabled_sellOffer"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
* SellOffer relationship links the sell offer with it's parent product, the sell offer can be enabled (hasSellOffer) or disabled (disabledSellOffer)
* when enabling/disabling we remove the old relationship and replace it with the new setting


<syntaxhighlight lang="JavaScript">
* When creating a sellOffer it's currency will be set to the same as the sellOfferPlan chosen
{
* sellOfferPrices is not linked to a set currency, this allows the pricing structure to be used across sellOffers with different currencies (eg USD equivalent currencies)
relationshipType: "{SellOfferPlanLib.createUsesSellOfferPlanGraphRelationshipType()}", // "uses_sellOfferPlan"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
* links a sell offer to a sell offer plan
* a sell offer has only one sell offer plan


== Basic node schemas ==
== Carts ==


<syntaxhighlight lang="JavaScript">
* a Cart chooses one deliveryMethod, any sellOffers(actually the sellOffer's sellOfferPlan) added to the cart that are not the same currency as the selected deliveryMethod will be invalid when validating cart
{
nodeLabel: "{SellOfferStandardLib.SELL_OFFER_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
sellOfferId: {
identifier: true,
},
sellOfferHandlerServiceNameTag: {
immutable: true,
},
},
}
}
</syntaxhighlight>
* [[Service - Orders Graph]]


= Complex Filter requests =
== Delivery Method Links ==


<syntaxhighlight lang="JavaScript">
* when adding a deliveryMethod to a sellOfferPlan the currencies must match
{
* because we expect deliveryMethods to have a rate returned, a shipping price, so expect to be able to combine that to the sellOffer's price without any conversion
filterType: "sellOffer" //unique id is sellOfferId
* perhaps not allow changing of a deliveryMethod and sellOfferPlan's currency, if want to change need to create new
type: "group",
elements:
[
// ...
{
type: "complexFilter",
complexFilter: {
filterType: "sellOfferPlan",
// see [[Service - Sell Offer Plan|Complex Filter requests]]
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "sellOfferTermLink",
// see [[Service - Sell Offer Terms|Complex Filter requests]]
}
},
...
]
}
</syntaxhighlight>


= SellOffer currency =
== Payment Method Links ==


* When creating a sellOffer it's currency will be set to the same as the sellOfferPlan chosen
* All deliveryMethods added to the sellOfferPlan must be the same currency as the sellOfferPlan, so total price can be calculated accurately
* paymentMethod does not need to match the sellOfferPlan currency, seller can have sellOfferTerms to explain currency conversion when making payment
* paymentMethod does not need to match the sellOfferPlan currency, seller can have sellOfferTerms to explain currency conversion when making payment
* however if the paymentMethod has a oneTimeAmount setting, that will make calculating the price invalid if it does not match the deliveryMethod/Cart's currency (maybe not store currency in paymentMethod, apply as is to whatever currency the sellOfferPlan is)
* oneTimePercentage can be set even if currencies do not match


= Working documents =
= Working documents =

Latest revision as of 23:18, 16 August 2025

Overview

Handler service for the standard sell offer type.

Repository

https://bitbucket.org/izara-market-products/izara-market-products-sell-offer-standard/src/master/

Object Schemas

Additional Information
Per Service Schemas

objType

sellOfferStandard

{
	objectType: "sellOfferStandard",
	extendObjType: {
		serviceTag: "sellOfferManager",
		objectType: "sellOffer"
	},
	storageResources: {
		myGraph: {
			storageType: "graph",
			graphServerTag: "GraphHandler"
		}
    },
    fieldNames: {
		currencyId: {
			type: "currency",
			storageResourceTags: ['myGraph']
		},
    },
}

Object Relationships

SellOffer currency

  • When creating a sellOffer it's currency will be set to the same as the sellOfferPlan chosen
  • sellOfferPrices is not linked to a set currency, this allows the pricing structure to be used across sellOffers with different currencies (eg USD equivalent currencies)

Carts

  • a Cart chooses one deliveryMethod, any sellOffers(actually the sellOffer's sellOfferPlan) added to the cart that are not the same currency as the selected deliveryMethod will be invalid when validating cart

Delivery Method Links

  • when adding a deliveryMethod to a sellOfferPlan the currencies must match
  • because we expect deliveryMethods to have a rate returned, a shipping price, so expect to be able to combine that to the sellOffer's price without any conversion
  • perhaps not allow changing of a deliveryMethod and sellOfferPlan's currency, if want to change need to create new

Payment Method Links

  • paymentMethod does not need to match the sellOfferPlan currency, seller can have sellOfferTerms to explain currency conversion when making payment
  • however if the paymentMethod has a oneTimeAmount setting, that will make calculating the price invalid if it does not match the deliveryMethod/Cart's currency (maybe not store currency in paymentMethod, apply as is to whatever currency the sellOfferPlan is)
  • oneTimePercentage can be set even if currencies do not match

Working documents

Sell Offer Standard

Retrieved from "https://izara.io/wiki/index.php?title=Service_-_Sell_Offer_Standard&oldid=3509"