DdD Retail Web API Help Page

Parameterconfig to ensure that you are using the correct style and sourceVariant properties for the correct type of information: style => (season, brand, ect.), sourceVariant => (color, size, etc.)

IMPORTANT! use the parameter config you get from GET: /api/article/parameterconfig to ensure that you are using the correct style property for the correct type of information(season, brand, ect.). This does not create a style, but its creates a job that BackOffice executes. This means that the style is not created instantly but can be delayed.

IMPORTANT!: See /api/article/parameterconfig for correct parameter value assignment. This runs in a batch process and the articles are not created instantly and will be delayed.

Inserts a barcode with reference to a variant, given variant id and barcode.

Provides an Article, given a barocde.

Provides an Article, given a barocde. Looks in multi barcode variant table.

DEPRECATED use GET /api/article/page/{page}/pagesize/{pagesize} instead. Gets all styles in your Group. Header containes next page number and how many is remaning

Provides all articles, as PAGED.

Provides all articles created since, given timestamp, page and pagesize, as PAGED.

Provides all articles modified since, given timestamp, page and pagesize, as PAGED.

Provides all articles, by supplier id, as PAGED.

Get a style and all its variants.

Updates a style intersection A ∩ B (everthing but the list of variants)

IMPORTANT! use the parameterconfig you get from GET: /api/article/parameterconfig to ensure that you are using the correct style property for the correct type of information(season, brand, ect.).

Updates Variant with targetId with the given sourceVariant model.

Updates Variant with targetId with the given sourceVariant model.

Gets the sourceVariant + its style flattened(articel) matching the Id with the VariantId

Searches for a flattned sourceVariant + its style(articel) matching the EAN provided to the Variant EAN

Provides a list of articles, given list of style parameter key and values for matching.

Method for testing if access is granted and connection can be made. Remember token in header. "Authorization ddd_token [token]".

Provide true/false on creation of a clerk, given shop id and a clerk model. Give clerk model in body. More information regarding language and userRights can be found in the documentation

Provides a clerk model, given a clerk id, a shop id and a teminal id.

Provides all clerks for a shop

Please use the route shop/update/{shopId:int} instead. If return value is false use route shop/{shopId:int} Provide true/false on update of a clerk, given a clerk model. Give clerk model in body.

Provide true/false on update of a clerk, given a clerk model. Give clerk model in body. More information regarding language and userRights can be found in the documentation

Provide true/false on deletion of a clerk, given a clerk id, a shop id and a teminal id.

Provides all issued credit notes in a given timespan, regardless of current state.

Provides all redeemed credit notes in a given timespan.

Creates debtor.

Bulk creates debtors.

Provides debtor.

Provides list of debtors.

Provides list of debtors, created since timestamp.

No documentation available.

Provides list of debtors, modified since timestamp.

Updates debtor.

Deletes debtor.

Generates unique GiftCertificate number NOTE: This is only generation. Persistence occurs when sold.

Validates a GiftCertificate. Returns true for valid and false for not valid.

Provides gift certificate information.

Provides all issued gift certificates in a given timespan, regardless of current state.

Provides all redeemed gift certificates in a given timespan.

Provides the current setup for transactionTypes

Provides a single transactiontype description given TransactionNumber

Provide information for which area of the API can be accessed and for which Group/Club/Webshop, given only the token.

Provides group information, given a group token.

Provides a list of shops, given a group token.

Provides a list of shops in the webshop, given a webshop token.

Provides a list of shops in the club, given a loyalty token.

Method for testing if access is granted and connection can be made. Remember token in header. "Authorization ddd_token [token]"

Provides a list of item groups

Creates a Stock Keeping Unit (SKU)Item Group. This type of item group is used as a grouping of articles. All articles belonging an item group inherits it's VAT configuration and barcode label setup.

Update an existing Stock Keeping Unit (SKU)Item Group.

Creates a Non Stock Keeping Unit (NonSKU)Item Group. This type of item group is used when selling something where the shop is not interesteded in keeping stock and linking the sale to specific articles. No articles are associated with this type of item group.

Update an existing Stock Keeping Unit (SKU)Item Group.

Gets the different VAT configuration options for item groups.

Get the different barcode configuration options for item groups.

Method for testing if access is granted and connection can be made. Remember token in header. "Authorization ddd_loyalty_token [token]. A token is club specific."

Provides club id, given shop id.

Provides club id, given group id.

Provides shops for club.

Provides a shop, given shop id.

Provides iso-currency code for club.

Gets transaction of a club. Important: Transactions can consist of multiple transaction lines. Because of this, it's possible that the returned results do not contain all lines of the last transaction, due to being cut-off by "maxResults". Therefore it's essential to fetch until no more results are returned, to ensure that all lines of all transactions are being obtained.

Provides all types of Loyalty engines.

Provides the engine(s) of a club.

Provides the engine id, given an engine type identifier.

Provides the engine id, given a shop id and type identifier.

Provides active level rule(s) for club, given engine type identifier.

Provides active level rule(s) for shop, given engine type identifier and shop id.

Provides the used/returned "bonus money" for each provided transaction line id. This method only applies on "LevelEngines" (DiscountLevelEngine, BonusLevelEngine..). Give loyalty transaction line id(s) in body.

Provides all static discount rules of a club. The club needs to have a StaticDiscountEngine assigned!

Provides all static discount rules of a club, by a shop. The club to which the shop belongs, needs to have a StaticDiscountEngine assigned!

Gets the total money to use of all members of a "Level-Engine" within a Club. Note: This is an expensive call, which might take some time to return. Avoid high frequency usage.

Gets the total points of all members of a "Level-Engine" within a Club. Note: This is an expensive call, which might take some time to return. Avoid high frequency usage.

Provides all members that have changes to: profile, transactions and point logs, since given datetime, as PAGED. NOTE: When total number of records is exceeding one page, the total number of records does NOT reflect the true number of members. As this request is a consolidation of multiple look-ups, consider the total an approximation of a total. Members can occur across multiple pages.

Provides club id, given member id.

Creates and provides member. Give member in body. If the given member has a CustomerNumber assigned, this number will be used.

Creates and provides member. Give member in body. If the given member has a CustomerNumber assigned, this number will be used.

Creates and provides member, given shop id. Give member in body. If the given member has a CustomerNumber assigned, this number will be used.

Creates and provides member, given shop id. Give member in body. If the given member has a CustomerNumber assigned, this number will be used.

Provides member, given member id.

Provides member, given shop id and user name.

Provides member, given shop id and customer number.

Provides member, given group id and customer number.

Updates member. Note: This does NOT update the Login of a member (User/Password)!

Updates member. Note: This does NOT update the Login of a member (User/Password)!

Patches member. NOTE: Will only update optional properties that are not omitted and hold valid data.

Updates user name, given member id and new user name.

Updates the password, given member id and new password. Attention: Use this only when you know, that it is valid to change the password, without having the original password. Note: use "api/loyalty2/member/{memberId:int}/update/password/newonly" instead.

Updates the password, given member id, existing password and new password. Note: use "api/loyalty2/member/{memberId:int}/update/password" instead.

Updates the password, given member id and new password. Attention: Use this only when you know, that it is valid to change the password, without having the original password.

Updates the password, given member id, existing password and new password.

Deletes member, given member id.

Checks the existance of a member and provides a result, given user name and shop id.

Validates username and password and provides member, given user name, password and shop id. Note: use "api/loyalty2/member/shop/{shopId:int}/validate/user/{userName}/password" instead.

Validates username and password and provides member, given user name, password and shop id.

Validates password and provides member, given member id and password. Note: use "api/loyalty2/member/{memberId:int}/validate/password" instead.

Validates password and provides member, given member id and password.

Provides member(s) of a club as PAGED, given page and size.

Provides member(s) of a club paged.

Provides member(s) of a club as PAGED, given page, size and search term. The search is run against the properties of a member. It's possible to have a concatenated search term, containing multiple property-values of a member, seperated by space (' '). Properties can be omitted, but in case of multiple values they must be present in the order CustomerNumber, FirstName, LastName, Address, PostalCode, City, Country ,Phone, Email.

Provides member(s) of a club as PAGED, given page, size and group id.

Provides member(s) of a club as PAGED, given page, size, search term and group id. The search is run against the properties of a member. It's possible to have a concatenated search term, containing multiple property-values of a member, seperated by space (' '). Properties can be omitted, but in case of multiple values they must be present in the order CustomerNumber, FirstName, LastName, Address, PostalCode, City, Country ,Phone, Email.

Provides member(s) of a club as PAGED, given page, size and shop id.

Provides member(s) of a club as PAGED, given page, size, search term and shop id. The search is run against the properties of a member. It's possible to have a concatenated search term, containing multiple property-values of a member, seperated by space (' '). Properties can be omitted, but in case of multiple values they must be present in the order CustomerNumber, FirstName, LastName, Address, PostalCode, City, Country ,Phone, Email.

Provides member(s) of a club, given shop id and search term. The search is run against the properties of a member. It's possible to have a concatenated search term, containing multiple property-values of a member, seperated by space (' '). Properties can be omitted, but in case of multiple values they must be present in the order CustomerNumber, FirstName, LastName, Address, PostalCode, City, Country ,Phone, Email.

Provides member(s) of a club, given group id and search term. The search is run against the properties of a member. It's possible to have a concatenated search term, containing multiple property-values of a member, seperated by space (' '). Properties can be omitted, but in case of multiple values they must be present in the order CustomerNumber, FirstName, LastName, Address, PostalCode, City, Country ,Phone, Email.

Provides transaction line(s), given member id.

Provides transaction line(s), given a shop and customer number.

Adds points manually to member, given member id and points.

Adds points manually to member, given member id and points.

Adds money manually to member, given member id and money.

Adds money manually to member, given member id and money.

Provides the engine type identifier of a member, given a member id.

Provides the amount of money to use of a member, given a member id.

Provides the current total points of a member, given a member id.

Provides the pending points of a member, given a member id.

Provides all point log(s) of a member, given a member id.

Provides all point log(s) of a member, given a shop and customer number.

Provides point log(s) of the "BonusLevelEngine", given a member id.

Provides point log(s) of the "BonusLevelEngine", given a shop and customer number.

Provides all active level rule(s) of a member, given a member id.

Provides the current level of a member, given a member id.

Provides the next level of a member, given a member id.

Provides the static discount (rule) of a member, given a member id.

Saves a static discount rule on a member. One of the club's static discount rules can be used as an argument to this call.

Provides all records for specific shopId

Provides all records for specific shopId, within a given timespan

Provides all records for specific shopId.

Provides all records for specific shopId, within a given timespan.

Creates a new record.

Updates the count of a record.

Updates the count of a record if it exists, otherwise it creates a new record.

Method for testing if access is granted and connection can be made. Remember token in header. ATM = "Authorization ddd_token [token]."

Provides true/false on creation of a discount reason code.

Provides true/false on creation of a return reason code.

Provides discount reason code(s).

Provides return reason code(s).

Please use Put: /discount/update and Post: /discount/ instead Provides true if reason code is updated or inserted false otherwise

Provides true if reason code is updated, false otherwise

Please use Put: /return/update and Post: /return/ instead Provides true if reason code is updated or inserted false otherwise

Provides true if reason code is updated, false otherwise

Provides true/false on deletion of the discount reason code.

Provides true/false on deletion of the return reason code.

Generates receipt for gift exchange.

Provides a list of item groups

Provides a list of discount reason codes.

Provides a list of return reason codes.

Provides a list of transaction types. NOTE: Common card types start at 600.

Generates unique gift certificate identifier. NOTE: This is only generation. Persistence occurs when sold.

Provides true/exception on post of sale.

Method for testing if access is granted and connection can be made. Remember token in header. "Authorization ddd_token [token]"

Provides a list of VariantIds, each with a list of stock quantity, per ShopId, given a stock value option and a list of variant ids.

Provides a list of EANs, each with a list of stock quantity, per ShopId, given a stock value option and a list of Eans.

Provides stock quantity, given shop id and variant id.

Provides stock quantity, given shop id and barcode.

Provides combined stock quantity for all variant ids with EAN, as PAGED, given shop id and variant id.

Provides combined non-zero stock quantity, as PAGED, given shop id

Provides combined non-zero stock quantity by supplier, as PAGED, given shop id

Provides the latest used transaction number for the given shop id.

Provides stock quantity for all variant ids with EAN, as PAGED, BEFORE transaction number, given shop id and transaction number. DEPRECATED: Use /api/stocks/{shopId}/{valueOption}/{page}/{pagesize} instead.

Provides stock quantity for all variant ids with EAN, as PAGED, AFTER and including transaction number, given shop id and transaction number. DEPRECATED: Use /api/stocks/{shopId}/{valueOption}/{page}/{pagesize} instead.

Provides stock quantity for all variant ids with EAN, as PAGED, from transaction number, given shop id, transaction number and stock value option. DEPRECATED: Use /api/stocks/{shopId}/{valueOption}/{page}/{pagesize} instead.

Provides stock quantity for all variant ids with EAN, as PAGED, given shop id and stock value option.

Provides stock quantity, since date for all variant ids with EAN, as PAGED, given shop id, stock value option and date.

Provides combined stock quantities, given shop id and variant id. Stock at shop, stock in transfer and stock purchased.

Provides combined stock quantities, given shop id and barcode. Stock at shop, stock in transfer and stock purchased.

Provides combined stock quantities, given shop id and variant id. Stock at shop, stock in transfer and stock purchased.

Provides combined stock quantities, given shop id and barcode. Stock at shop, stock in transfer and stock purchased.

Provides item transfer draft(s), given shop id.

Provides list of item transfer drafts, given shop id and shop selection.

Provides item transfer draft(s), given shop id and receipt number.

Provides purchase drafts(s), given shop id.

Provides purchase draft(s), given shop id and invoice number.

Provides a Dictionary(VaiantId, Ean), of stock movements in a timespan, for a the given shop id and supplier id. Maximum timespan is 14 days.

Initiates a receipt of goods.

Updates a receipt of goods draft, to a fully approved state. NOTE: All lines, which have not been approved yet, will be affected. This can lead to approving a remainder of the draft.

Initiates an item transfer of item quantities, from sender ShopId to recipient ShopId.

Updates an item transfer draft, to a fully approved state. NOTE: All lines, which have not been approved yet, will be affected. This can lead to approving a remainder of the draft.

Method for testing if access is granted and connection can be made. Remember token in header. "Authorization ddd_token [token]"

Creates a new Supplier. Note: Include only properties which hold information.

Please use Post: /create/ instead

Updates a Supplier. Note: Include only properties which hold information.

Method for testing if access is granted and connection can be made. Remember token in header. "Authorization ddd_token [token]"

Provides multi model of transaction lists, given a shop id, a from date and a to date.

Provides a multi model of transaction lists, given a shop id and a from date. Will provide up to 31 days of data.

Provides a multi model of transaction lists, given a shop id and a transaction number. NOTE: This route can give lists that are skewed, relative to each other.

Provides a list of transfer transactions, given a shop id and a transaction number.

Provides a list of purchase transactions, given a shop id and a transaction number.

Provides a list of correction transactions, given a shop id and a transaction number.

Provides a list of sales transactions, given a shop id and a transaction number.

Provides a list of sales item transactions, given a shop id and a transaction number.

Provides a list of sales payment transactions, given a shop id and a transaction number.

Provides a list of correction transactions, given a shop id, a from date and a to date.

Provides a list of correction transactions, given a shop id and a from date. Will provide up to 31 days of data.

Provides a list of manual correction transactions, given a shop id, a from date and a to date.

Provides a list of manual correction transactions, given a shop id and a from date. Will provide up to 31 days of data.

Provides a list of status correction transactions, given a shop id, a from date and a to date.

Provides a list of status correction transactions, given a shop id and a from date. Will provide up to 31 days of data.

Provides a list of purchase transactions, given a shop id, a from date and a to date.

Provides a list of purchase transactions, given a shop id and a from date. Will provide up to 31 days of data.

Provides a list of transfer transactions, given a shop id, a from date and a to date.

Provides a list of transfer transactions, given a recipient shop id, a from date and a to date.

Provides a list of transfer transactions, given a shop id and a from date. Will provide up to 31 days of data.

Provides a list of sales transactions, given a shop id, a from date and a to date.

Provides a list of sales transactions, given a shop id and a from date. Will provide up to 31 days of data.

Provides a list of sales item transactions, given a shop id, a from date and a to date.

Provides a list of sales item transactions, given a shop id and a from date. Will provide up to 31 days of data.

Provides a list of sales payment transactions, given a shop id, a from date and a to date.

Provides a list of sales payment transactions, given a shop id and a from date. Will provide up to 31 days of data.

Method for testing if access is granted and connection can be made. Remember token in header. ATM = "Authorization ddd_token [token]". Will change to "Authorization ddd_webshop_token [token]" a some point.

DEPRECATED - Provides a true/false on creation of a web order, given a web order create model. Use "api/weborder/clickandcollect" instead

Provides a true/false on creation of a web order, given an alternative web order create model.

Provides a true/false on creation of a Click'n'Collect web order, given a web order create model.

Provides a true/false on creation of a Order In Store web order, given a web order create model.

Provides a true/false on creation of a Click'n'Collect web order, given an alternative web order create model, using Ean instead of VariantId.

Provides a true/false on creation of an Order In Store web order, given an alternative web order create model, using Ean instead of VariantId.

Provides a true/false on update of a web order, given a web order update model.

DEPRECATED - Provides the matching web order, given a web order number. Use "fetch/orderNo/{orderNo}"

DEPRECATED - Provides the matching web order, given a web order id. Use "fetch/{orderId:int}"

Provides the matching web order, given a web order number.

Provides the matching web order, given a web order id (this is not OrderNo, but Id).

Provides the matching web order, given an WebOrder 'OrderNo'.

Provides a true/false on deletion of a web order, given an OrderNo.

Provides a true/false on deletion of a web order, given an id (this is not OrderNo, but Id).

Provides a true/false on deletion of a web order, given an OrderNo.

Updates the status of an order line to "ReturnedPayment", given an order number and a line id. If a line has a status of "ReturnedPayment", it cannot change further.

Updates the status of an order line to "Skipped", given an order number and a line id. If a line has a status of "Skipped", it cannot change further.

DEPRECATED - Provides a list of web orders, given a status code. Use "status/{status}"

DEPRECATED - Provides a list of web orders linked to the webshop, for which the used token is bound, given status code. Use "status/{status}/webshop"

DEPRECATED - Provides a list of web orders for a shop, given a shop id and a status code. Use "status/{status}/shop/{shopId:int}"

DEPRECATED - Provides a list of web orders, given status code and DateTime. Use "get/status/{status}/since"

DEPRECATED - Provides a list of web orders linked to the webshop, for which the used token is bound, given status code and a DateTime. Use "status/{status}/since/webshop"

DEPRECATED - Provides a list of web orders for a shop, given a shop id, a status code and a DateTime. Use "status/{status}/since/shop/{shopId:int}"

Provides a list of web orders, given a status code.

Provides a list of web orders linked to the webshop, for which the used token is bound, given status code.

Provides a list of web orders for a shop, given a shop id and a status code.

Provides a list of web orders, given status code and DateTime.

Provides a list of web orders linked to the webshop, for which the used token is bound, given status code and a DateTime.

Provides a list of web orders for a shop, given a shop id, a status code and a DateTime.

Provides a list of sales transactions, given a web order number.

Method for testing if access is granted and connection can be made. Remember token in header. "Authorization ddd_webshop_token [token]".

Provides a list of the participating shops in the webshop.

Provides the latest transaction numbers, for all participating shops in the webshop.

Provides web shop stock for one shop, given page, page size, shop id and transaction number, as PAGED. NOTE: Stock is on items that have changed, since transaction number.

Provides web shop styles with variants for all shops, for the given page and page size, as PAGED. NOTE: Use the 'api/webshop/article/{page:int}/{pagesize:int}' endpoint instead

Provides web shop articles, given page and page size, as PAGED.

Provides web shop articles modified since, given timestamp, page and page size, as PAGED.

Provides web shop styles with variants for all shops, according to parameter config, for the given page and page size, as PAGED.

Provides a list of web shop stock for all shops, given a variant id.

Provides a list of VariantIds, each with a list of stock quantity, per ShopId, given a stock value option and a list of variant ids.

Provides a list of EANs, each with a list of stock quantity, per ShopId, given a stock value option and a list of Eans.

Provides a web shop article with stock for one shop, given a variant id and a shop id.

Provides web shop stock for all shops, for the given page and page size, as PAGED.

Provides web shop stock, of stock movements in a timespan. Maximum timespan is 7 days. I.e. Start: 2017-06-01T00:00:00, End: 2017-06-02T23:59:59 for two full days.

Provides web shop stock for one shop, for the given page, page size and shop id, as PAGED.

Provides list of suppliers.

Provides list of itemgroups.

Provides a parameter config model for the group.

Provides list of parameter choices for the fixed parameter route config.

Provides list of parameter names for the fixed parameter route config.

Provides list of parameter configs for the fixed parameter route config.

Provides boolean, upon creation of a fixed parameter config, given a fixed parameter config model.

Provides fixed parameter config, given an id.

Provides boolean, upon update of a fixed parameter config ordering, given an id and an order number. Order numbers are positive integers. 1 being first.

Provides boolean, upon deletion of a fixed parameter config, given an id.