Adding context for entity relationships in the API
Entities
- StoreGroup
- StoreMarket
- ProductVariantPrice
- Inventory
Relationships
StoreGroup and StoreMarket
- A
StoreGroup
can be assigned multipleStoreMarkets
. - Each
StoreMarket
is unique to aStoreGroup
.
StoreGroup 1 ----< StoreMarket
StoreMarket and ProductVariantPrice
- A
ProductVariantPrice
is set to acountryCode
and astoreGroupId
, making it unique to aStoreMarket
.
StoreMarket 1 ----< ProductVariantPrice
StoreMarket and Inventory
- Multiple
Inventories
(identified byinventoryId
) can be assigned to multipleStoreMarkets
.
StoreMarket >----< Inventory
Entity Attributes
StoreGroup
id
: Unique identifiername
: Name of the StoreGroupdescription
: Description of the StoreGroup
StoreMarket
countryCode
: Country codecurrencyCode
: Currency codestoreGroupId
: ID of the StoreGroup it belongs to
ProductVariantPrice
countryCode
: Country codestoreGroupId
: ID of the StoreGroup it belongs toprice
: Price of the product variant
Inventory
inventoryId
: Unique identifier for the inventory
Full Diagram
StoreGroup 1 ----< StoreMarket >----< Inventory
|
|
1
|
|
|
V
ProductVariantPrice
This diagram outlines the relationships between the entities within domain management in the Brink Commerce API.
graph TD
subgraph External Client
A[External Client Integration]
end
subgraph Management API
B[Store]
C[Tax]
D[Product]
E[Price]
F[Inventory]
G[Discount]
end
subgraph Event Flow
B -->|Events| K[Shopper API]
K -->|Events| N[Order Management API]
end
subgraph Shopper API
K
end
subgraph Front-end Client
L[Front-end Client]
L -->|API Calls| K
end
subgraph Order Management API
N
end
subgraph Client Integration
O[Client Integration]
O -->|API Calls| N
end
subgraph External Client
A -->|Data| B
A -->|Data| C
A -->|Data| D
A -->|Data| E
A -->|Data| F
A -->|Data| G
end
subgraph Shopper API
K -->|API Calls| L
end
subgraph Order Management API
N -->|Data| O
end