View on GitHub

documentation

Documentation for DdD products

This is the main page for Web Shop

In DdD Retail context, a web-shop is a grouping of shop ids, for which some or all items, are marked as available, for web-shop. Each web-shop has a unique WebshopId.

Note: Not all shops within a group need to participate in a web-shop. A group can have multiple web-shops and shops can participate in more than one web-shop, or none.

The PublicAPI offers routes to provide information on these articles marked for a web-shop.

Stock

This section contains information on how to keep stock for a web-shop.

Stock update using transaction numbers

This strategy uses transaction numbers to GET delta stock, on web-shop articles that have changed, for shop ids participating in a web-shop.

The following two steps are performed at the start-up of this web-shop stock strategy
  1. GET complete stock for a web-shop.
    • For a single shop id, using this route.
    • For all shop ids, using this route.
  2. GET latest transaction numbers for each participating shop id, using this route.
For every updated needed, the following two steps are performed

NOTE: The first call must use the transaction number acquired from previous iteration/update.

  1. GET stock since transaction number per shop id, using this route.
  2. GET latest transaction numbers for each participating shop id, using this route.

Save the transaction number from call no: 2, for next iteration/update. Repeat final two steps when needed.

Stock update using a time span

This strategy uses a time span to GET the delta stock, on web-shop articles that have changed, for shop ids participating in a web-shop. NOTE: If, for any reason, a transaction is delayed in committing to database, the stock is not chronologially sound and the stock cannot be 100% relied on. Use Stock update using transaction numbers instead.

The following two steps are performed at the start-up of this web-shop stock strategy
  1. GET complete stock for a web-shop.
    • For a single shop id, using this route.
    • For all shop ids, using this route.
  2. Save the current DateTime when calling 1.
For every updated needed, the following steps are performed

NOTE: The first call must use the DateTime acquired from previous iteration/update, in timespanStart and current DateTime in timespanEnd. Maximum time span at present time is 7 days.

  1. GET stock in time span, using this route.
  2. Save the current DateTime, for next iteration/update.

Repeat final two steps when needed.

Fixed routes

The fixed routes are used in conjunction with the parameterconfig/fixed to setup an custom output on the /fixed routes. The output on the /fixed routes for web-shop articles has no parameter fields, but eight standard fields(parameternames), which can be populated with information from any in the parameterchoices list, in any order and multiple times.

Parameter choices for /fixed can be found here.

Parameter names for /fixed can be found here.

You can see your current parameterconfig/fixed setup here.