NectaVendorsApi

<back to all web services

GetVendorItemByNumber

Get VendorItem. Use -1 as ID to get sensible default values for new elements.

Requires Authentication
Required permission:view_vi
The following routes are available for this service:
GET/vendoritem/byitemnumber
GetVendorItemByNumber Parameters:
NameParameterData TypeRequiredDescription
VendorIdqueryintNo
ItemNumberquerystringNo
VendorItemDetailDto Parameters:
NameParameterData TypeRequiredDescription
PricesformList<VendorItemPriceDto>No
VendorItemBasicDto Parameters:
NameParameterData TypeRequiredDescription
ItemNumberformstringNo
DescriptionformstringNo
LongDescriptionformstringNo
PackingUnitformstringNo
ContentUnitformstringNo
CuInPuFactorformdecimalNo
AllowCuOrderformboolNo
VariableQuantityformboolNo
ContentAmountformdecimal?No
ContentAmountUnitformUnit?No
EanPuformstringNo
EanCuformstringNo
PointOfOriginformstringNo
CountryOfOriginformCountry?No
IngredientsformstringNo
BrandformstringNo
MarketingNameformstringNo
RegulatedNameformstringNo
ItemGroupformstringNo
PreorderformboolNo
PreorderDaysformint?No
ListedformboolNo
LastModifiedformDateTimeNo
GlutenformLmivValue?No
CrustaceansformLmivValue?No
EggsformLmivValue?No
FishformLmivValue?No
PeanutsformLmivValue?No
SoyformLmivValue?No
MilkformLmivValue?No
NutsformLmivValue?No
CeleryformLmivValue?No
MustardformLmivValue?No
SesameformLmivValue?No
SulfitesformLmivValue?No
LupinsformLmivValue?No
MolluscsformLmivValue?No
WheatformLmivValue?No
RyeformLmivValue?No
BarleyformLmivValue?No
OatformLmivValue?No
SpeltformLmivValue?No
KamutformLmivValue?No
AlmondformLmivValue?No
HazelformLmivValue?No
WalnutformLmivValue?No
CashewformLmivValue?No
PecanformLmivValue?No
BrazilNutformLmivValue?No
PistachioformLmivValue?No
MacadamiaformLmivValue?No
QueenslandNutformLmivValue?No
ColorantformLmivValue?No
PreservativeformLmivValue?No
AntioxidantformLmivValue?No
FlavorEnhancerformLmivValue?No
SulfurizedformLmivValue?No
BlackenedformLmivValue?No
WaxedformLmivValue?No
PhosphateformLmivValue?No
SweetenerformLmivValue?No
PhenylalanineformLmivValue?No
LaxativeformLmivValue?No
ProtectiveAtmosphereformLmivValue?No
BlsCodeformstringNo
NutrKcalformdecimal?No
NutrKjformdecimal?No
NutrProteinformdecimal?No
NutrFatformdecimal?No
NutrFatSaturatedformdecimal?No
NutrCarbformdecimal?No
NutrSugarformdecimal?No
NutrSaltformdecimal?No
NutrFiberformdecimal?No
IdformintNo
VendorIdformintNo
VendorItemPriceDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PricePuformdecimalNo
PriceCuformdecimalNo
ValidFromformDateTime?No
ValidToformDateTime?No
SpecialOfferformboolNo
ScaledQuantityformdecimal?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /vendoritem/byitemnumber HTTP/1.1 
Host: vendor-api.digisupply.klueh.de 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Prices":[{"Id":0,"PricePu":0,"PriceCu":0,"ValidFrom":"0001-01-01T00:00:00.0000000","ValidTo":"0001-01-01T00:00:00.0000000","SpecialOffer":false,"ScaledQuantity":0}],"Id":0,"VendorId":0,"ItemNumber":"String","Description":"String","LongDescription":"String","PackingUnit":"String","ContentUnit":"String","CuInPuFactor":0,"AllowCuOrder":false,"VariableQuantity":false,"ContentAmount":0,"ContentAmountUnit":0,"EanPu":"String","EanCu":"String","PointOfOrigin":"String","CountryOfOrigin":0,"Ingredients":"String","Brand":"String","MarketingName":"String","RegulatedName":"String","ItemGroup":"String","Preorder":false,"PreorderDays":0,"Listed":false,"LastModified":"0001-01-01T00:00:00.0000000","Gluten":0,"Crustaceans":0,"Eggs":0,"Fish":0,"Peanuts":0,"Soy":0,"Milk":0,"Nuts":0,"Celery":0,"Mustard":0,"Sesame":0,"Sulfites":0,"Lupins":0,"Molluscs":0,"Wheat":0,"Rye":0,"Barley":0,"Oat":0,"Spelt":0,"Kamut":0,"Almond":0,"Hazel":0,"Walnut":0,"Cashew":0,"Pecan":0,"BrazilNut":0,"Pistachio":0,"Macadamia":0,"QueenslandNut":0,"Colorant":0,"Preservative":0,"Antioxidant":0,"FlavorEnhancer":0,"Sulfurized":0,"Blackened":0,"Waxed":0,"Phosphate":0,"Sweetener":0,"Phenylalanine":0,"Laxative":0,"ProtectiveAtmosphere":0,"BlsCode":"String","NutrKcal":0,"NutrKj":0,"NutrProtein":0,"NutrFat":0,"NutrFatSaturated":0,"NutrCarb":0,"NutrSugar":0,"NutrSalt":0,"NutrFiber":0}