Store Management Service

Introduction

The Store Management Service in the Brink Commerce API is designed to be as flexible as possible in order to tailor to your needs. This service allows for a wide range of operations that can be tailored to fit the unique needs of your business. This documentation aims to provide comprehensive information on how to utilize the Store Management Service effectively.

StoreGroup

A StoreGroup acts as a sales channel, specifying who buys something, from whom they buy it, where they buy it, and what price they pay for it.

Features

  • Multiple Storefronts: A single StoreGroup can represent one or multiple storefronts.

  • Customer Tiering: Use StoreGroup to implement customer tiering strategies.

  • Commercial Prerequisites: Tailor aspects like pricing according to your needs.

  • Legal Entities: Allows a merchant to operate under different legal entities within the same Brink Commerce API. For example, you can have Merchant Ltd for the UK market and Merchant Inc for the US market.

StoreMarket

A StoreMarket is a country with a specified currency.

Features

  • Provider Integrations: Easily specify what Payment Service Providers, gift card providers and shipping checkout providers that should be available for a specific StoreMarket.

  • Inventory setup: Connect and prioritize your your inventories

Entity relationship

  • A StoreGroup can be assigned multiple StoreMarkets.
  • Each StoreMarket is unique to a StoreGroup.
StoreGroup 1 ----< StoreMarket

It's not possible to have multiple StoreMarket with the same countryCode because it is a unique identifier.

Entity Attributes

StoreGroup

  • id: Unique identifier
  • name: Name of the StoreGroup
  • description: Description of the StoreGroup

StoreMarket

  • countryCode: Country code
  • currencyCode: Currency code
  • storeGroupId: ID of the StoreGroup it belongs to

You can assign your own id to a StoreGroup if you create it through the API. If you create it through Brink Merchant Portal an id is automatically assigned.

Operations

StoreGroup and StoreMarket support the following operations:

  • Create (PUT)
  • Update (PUT/PATCH)
  • Delete (DELETE)
  • List (GET)

StoreGroup also support fetching information regarding a single StoreGroup

  • Get details (GET)

Fields and Descriptions

FieldDescription
idUnique identifier for the StoreGroup
nameName of the StoreGroup
descriptionBrief description of the StoreGroup
legalEntityLegal entity under which the StoreGroup operates
pricingModelThe pricing model applied to the StoreGroup
inventoryModelThe inventory model applied to the StoreGroup
createdAtTimestamp indicating when the StoreGroup was created
updatedAtTimestamp indicating the last update to the StoreGroup

For more details, you can visit the Brink Commerce Store Management Service Documentation.

StoreGroups can be configured using the Brink Merchant Portal for a more streamlined experience.

Related entities

  • Providers
  • Inventory
  • ProductVariantPrice

Relationships

StoreMarket and ProductVariantPrice

A ProductVariantPrice is set to a countryCode and a storeGroupId, making it unique to a StoreMarket.

StoreMarket 1 ----< ProductVariantPrice

StoreMarket and Inventory

Multiple Inventories (identified by inventoryId) can be assigned to multiple StoreMarkets.

StoreMarket >----< Inventory

Related Entity Attributes

ProductVariantPrice

  • countryCode: Country code
  • storeGroupId: ID of the StoreGroup it belongs to
  • price: Price of the product variant

Inventory

  • inventoryId: Unique identifier for the inventory

Related entities diagram

StoreGroup 1 ----< StoreMarket >----< Inventory
                        |
                        |
                        1
                        |
                        |
                        |
                        V
               ProductVariantPrice

This diagram outlines the relationships between the entities within domain management in the Brink Commerce API.