Here you will find a description of typical usage patterns for the Export API.
Get NOBB Category structure
Use the GET productgroups to get the whole NOBB Category structure. This structure changes quite rarely, so we have not implemented a “get changes” method for this resource. Our recommendation is to do a complete sync at regular intervals (e.g. once a week) or on demand (e.g. when you receive an item that belongs to a new NOBB Category)
Get information on a single item
When needing information on a single item, you will get most information through the GET items endpoint. This includes the following:
Basic information - all data stored directly on the item
Supplier information - Participant number, name and supplier item number for all suppliers for the item
Package information, for all suppliers of the item
Some media information
If you want all data related to the item, you will also need to use the following endpoints:
GET modules, using the module number you received from the items endpoint as a request parameter in order to get module information
GET media/relations to get detailed information on all media for the item
GET media/image/items to get different variants for images for the item
GET prices to get all prices for the item
Get changed items in a specific period
If you want to maintain a local “copy” of the NOBB database, you have several options:
If you want changes on all items, use the GET items endpoint, with only from/to parameters set
If you want changes on all items for a set of suppliers, use the GET items endpoint, with suppliers and from/to parameters set
If you want changes on a list of items, use the POST items endpoint, posting the NOBB numbers for the items in the request body and from/to request parameters set
If you want changes on a specific assortment, use the GET items/assortment endpoint with assortment name and from/to parameters set
Note that when querying for changes for items, you will receive items that have changes to the API response in a specific period. That means that items that have module or price changes are not necessarily included. You may also from time to time find items that have no changed attributes in the period you are querying for (i.e. items with a new change date but with no apparent changes). This is not considered a bug, as the “lastupdateddate” for an item may be changed by other processes.
Get new/changed prices in a specific period
In order to get price changes in a specific period, use the similar methods as for described above for items, using prices endpoints.
Note: A price itself can not change, only the toDate can be updated on an exisiting price.
Get changed media in a specific period
If you want to get all media changes in a specific period, use the similar methods as for described above for items, using media/relations endpoints.
Get media content
In order to get the content of a media file, use either GET media/image or GET media/image/items
Find items based on GTINs
If you need to find items based on GTIN number(s), use the POST items/search. This method will return only limited information on the item, so it is most useful for identifying items based on GTINs. For full details on the item(s), combine this method with GET items.