Genero Public API - General management
The Genero Public API contains CRUD enpoints and batch endpoints for each entity. General principles for updating entities are described in a section below. Settings related to list gets (paging settings) and batch endpoints are listed below.
General settings in the Genero Public API
| Setting | Value |
|---|---|
| PageSize Min | 1 |
| PageSize Max | 1000 |
| BatchSize NoOfItems | 5000 |
| BatchSize NoOfItems | 30 |
Some domains may offer additional settings to regulate the behaviour of the imports. See the Import configuration page for more info.
Updating entities in the Public API
The payload consists of required fields and optional fields. Required fields must be provided in the payload. Optional fields can be excluded from the request body, and will in that case not be updated in the database. Null values are not allowed in the request body for any field.
Delete behaviour
An entity that is upserted with the delete property set to true, or deleted using the delete operation, will be soft deleted. This means that the object will remain in the database, but will be marked as deleted. All related data is kept for the deleted entity.
If an entity that is already marked as deleted is upserted and deleted (in the payload) is set to:
- True: the operation will report a failure with the IsDeleted code
- False: the entity will be revived
Entities that do not exist in the database and is upserted with Deleted = true will not be imported.
Customer Domain - Address and Payment lists
Address and payment lists must not be null, but may be empty. If lists are empty, no fields will be updated for addresser nor payments respectively.
Optional fields
| Class (dto) | Field |
|---|---|
| UndertakingByChainDto | chainId |
| UndertakingByChainDto | chainIntegrationId |
| UndertakingByChainDto | notes |
| UndertakingByChainDto | assortmentDescription |
| UndertakingByChainDto | activeInAssortment |
| ProductGroupDto | notes |
| PriceListConnectionDto | customerId |
| PriceListConnectionDto | chainId |
| PriceListConnectionDto | chainIntegrationId |
| PriceListConnectionDto | wholesalerId |
| PriceListConnectionDto | wholesalerIntegrationId |
| PriceListConnectionDto | salesForceId |
| PriceListConnectionDto | connectionReferenceType |
| PriceListDto | priceListItems |
| PriceListDto | priceListConnections |
| PriceListDto | currency |
| ManufacturerDto | ean |
| ManufacturerDto | address |
| ManufacturerDto | zipCode |
| ManufacturerDto | region |
| ManufacturerDto | phone |
| ManufacturerDto | |
| CampaignDto | campaignName |
| CampaignDto | note |
| CampaignDto | salesCycleId |
| CampaignDto | campaignTypeId |
| CampaignDto | startDate |
| CampaignDto | stopDate |
| CampaignDto | manufacturerId |
| CampaignDto | enableGrouping |
| CampaignDto | enableMandatoryToDos |
| CampaignTypeDto | note |
| SalesCycleDto | notes |
| CampaignProductDto | note |
| CampaignProductDto | quantity |
| CampaignProductDto | discountPercent |
| CampaignProductDto | discountFixed |
| CampaignProductDto | discountType |
| CampaignProductDto | consumerPrice |
| ProductAssortmentRowDto | notes |
| ProductAssortmentRowDto | assortmentDescription |
| ProductAssortmentRowDto | activeInAssortment |
| ProductDto | productNumber |
| ProductDto | gtin |
| ProductDto | gtinDistributionPgk |
| ProductDto | descriptionLong |
| ProductDto | vat |
| ProductDto | price |
| ProductDto | consumerPrice |
| ProductDto | costPrice |
| ProductDto | stock |
| ProductDto | volumeOrder |
| ProductDto | dfpOrder |
| ProductDto | kfpOrder |
| ProductDto | unitDescription |
| ProductDto | pricedUnit |
| ProductDto | unitSize |
| ProductDto | unitsPerDistributionPkg |
| ProductDto | consumerPkgPerDistributionPkg |
| ProductDto | distributionPkgPerPallet |
| ProductDto | palletLevels |
| ProductDto | distributionPkgSize |
| ProductDto | distributionPkgUnit |
| ProductDto | productGroupId |
| ProductDto | sortOrder |
| ProductDto | manufacturerId |
| ProductDto | field1 |
| ProductDto | field2 |
| ProductDto | field3 |
| ProductDto | field4 |
| ProductDto | active |
| ProductDto | isEquipment |
| SalesRegionDto | salesRegionId |
| SalesRegionDto | salesForceId |
| SalesForceDto | salesForceId |
| SalesDistrictDto | salesDistrictId |
| SalesDistrictDto | salesRegionId |
| WholesalerDto | wholesalerId |
| WholesalerDto | wholesalerIntegrationId |
| WholesalerDto | blockId |
| WholesalerDto | fax |
| WholesalerDto | phone |
| WholesalerDto | |
| WholesalerDto | organizationNumber |
| WholesalerDto | eanlocationCode |
| WholesalerDto | iaid |
| RouteDto | wholesalerId |
| RouteDto | wholesalerIntegrationId |
| CustomerContactDto | |
| CustomerContactDto | firstName |
| CustomerContactDto | lastName |
| CustomerContactDto | phoneMobile |
| CustomerContactDto | phoneWork |
| CustomerContactDto | workPosition |
| CustomerContactDto | title |
| CustomerContactDto | notes |
| CustomerContactDto | priority |
| CustomerContactDto | appointmentDays |
| CustomerDto | description |
| CustomerDto | customerNumber |
| CustomerDto | phone |
| CustomerDto | fax |
| CustomerDto | organizationNumber |
| CustomerDto | |
| CustomerDto | primaryContact |
| CustomerDto | eanlocationCode |
| CustomerDto | chainId |
| CustomerDto | chainIntegrationId |
| CustomerDto | wholesalerId |
| CustomerDto | wholesalerIntegrationId |
| CustomerDto | priority |
| CustomerDto | customerCategoryId |
| CustomerDto | customerCategoryIntegrationId |
| CustomerDto | salesDistrictId |
| CustomerDto | aRegionId |
| CustomerDto | field1 |
| CustomerDto | field2 |
| CustomerDto | field3 |
| CustomerDto | field4 |
| CustomerDto | deliveryDays |
| CustomerDto | countryCode |
| CustomerDto | municipalityCode |
| CustomerDto | creditLimit |
| CustomerDto | turnOver |
| CustomerDto | storeArea |
| CustomerDto | cashRegisters |
| CustomerDto | companyName |
| CustomerDto | creditDenied |
| CustomerDto | visitingFrequency |
| CustomerDto | municipality |
| CustomerDto | homepage |
| CustomerDto | turnOverCategory |
| CustomerDto | latitude |
| CustomerDto | longitude |
| CustomerDto | additionalInfoRows |
| CustomerCategoryDto | customerCategoryId |
| CustomerCategoryDto | customerCategoryIntegrationId |
| CustomerCategoryDto | name |
| ChainDto | chainId |
| ChainDto | chainIntegrationId |
| ChainDto | blockId |