POST api/LinkProducts
Method to link central products with own products
Request Information
URI Parameters
None.
URI Example
api/LinkProducts
Body Parameters
The product information
Oresto.API.Models.POST.LinkProducts.Product| Name | Description | Type | Additional information |
|---|---|---|---|
| Active |
Active or not |
boolean |
Required |
| EanCode |
EAN-code of the product |
string |
Primary key if: Supplier is null or empty Required if: Supplier is null or empty EAN code Max length: 250 |
| OnOrder |
Product is only available on order |
boolean |
Required |
| OrderQuantity |
Step size of order. All orders must be a multiple of this. Only available for products with units that support partial amounts (eg: kg). 0 means all amounts are allowed. Defaults to 1. |
decimal number |
Range: inclusive between 0 and 1E+15 |
| PromoValidFrom |
Starting date when a promo becomes active (TimeZone BE), if not provided UTC will be used |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
| PromoValidFromUtc |
Starting date when a promo becomes active (TimeZone UTC/GMT) |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
| PromoValidUntil |
Date when the promo should be void (TimeZone BE), if not provided UTC will be used |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
| PromoValidUntilUtc |
Date when the promo should be void (TimeZone UTC/GMT) |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
| SalesPriceList |
The list sales price |
decimal number |
Range: inclusive between 0 and 1E+16 |
| SalesPriceListPromo |
The list sales price during a promotion |
decimal number |
Range: inclusive between 0 and 1E+16 |
| Supplier |
Supplier information |
Oresto.API.Models.POST.LinkProducts.Supplier |
Primary key if: EanCode is null or empty Required if: EanCode is null or empty |
| TemporarilyUnavailable |
Whether or not the product is temporarily unavailable. If you wish to provide more information about this unavailability, use the field in the property. |
boolean |
None. |
| TemporaryReplacementArticleCode |
Article code of the optional replacement product for a temporarily unavailable product. |
string |
None. |
| UnitSalesPriceAbbreviation |
The ID for the unit sales price. ex. kg, L, pc |
string |
Primary key field Required Max length: 25 |
| WholesalerArticleNumber |
Article code for the product defined by the wholesaler |
string |
Primary key field Required Max length: 50 |
| WholesalerProductLocalizations |
Localizations for the product specific for the wholesaler |
Collection of Oresto.API.Models.POST.LinkProducts.Product+WholesalerProductLocalization |
None. |
Request Formats
application/json, text/json
{
"EanCode": "sample string 1",
"Supplier": {
"Id": 1,
"ArticleCode": "sample string 2",
"IsPackageProduct": true
},
"WholesalerArticleNumber": "sample string 2",
"SalesPriceList": 1.0,
"SalesPriceListPromo": 1.0,
"UnitSalesPriceAbbreviation": "sample string 3",
"OnOrder": true,
"PromoValidFrom": "2025-12-05T06:52:19.3414522+01:00",
"PromoValidFromUtc": "2025-12-05T06:52:19.3414522+01:00",
"PromoValidUntil": "2025-12-05T06:52:19.3414522+01:00",
"PromoValidUntilUtc": "2025-12-05T06:52:19.3414522+01:00",
"Active": true,
"WholesalerProductLocalizations": [
{
"LanguageCode": "sample string 1",
"PromoDescription": "sample string 2",
"Information": "sample string 3"
},
{
"LanguageCode": "sample string 1",
"PromoDescription": "sample string 2",
"Information": "sample string 3"
}
],
"TemporarilyUnavailable": true,
"TemporaryReplacementArticleCode": "sample string 7",
"OrderQuantity": 8.0
}
application/xml, text/xml
<Product xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.POST.LinkProducts">
<Active>true</Active>
<EanCode>sample string 1</EanCode>
<OnOrder>true</OnOrder>
<OrderQuantity>8</OrderQuantity>
<PromoValidFrom>2025-12-05T06:52:19.3414522+01:00</PromoValidFrom>
<PromoValidFromUtc>2025-12-05T06:52:19.3414522+01:00</PromoValidFromUtc>
<PromoValidUntil>2025-12-05T06:52:19.3414522+01:00</PromoValidUntil>
<PromoValidUntilUtc>2025-12-05T06:52:19.3414522+01:00</PromoValidUntilUtc>
<SalesPriceList>1</SalesPriceList>
<SalesPriceListPromo>1</SalesPriceListPromo>
<Supplier>
<ArticleCode>sample string 2</ArticleCode>
<Id>1</Id>
<IsPackageProduct>true</IsPackageProduct>
</Supplier>
<TemporarilyUnavailable>true</TemporarilyUnavailable>
<TemporaryReplacementArticleCode>sample string 7</TemporaryReplacementArticleCode>
<UnitSalesPriceAbbreviation>sample string 3</UnitSalesPriceAbbreviation>
<WholesalerArticleNumber>sample string 2</WholesalerArticleNumber>
<WholesalerProductLocalizations>
<Product.WholesalerProductLocalization>
<Information>sample string 3</Information>
<LanguageCode>sample string 1</LanguageCode>
<PromoDescription>sample string 2</PromoDescription>
</Product.WholesalerProductLocalization>
<Product.WholesalerProductLocalization>
<Information>sample string 3</Information>
<LanguageCode>sample string 1</LanguageCode>
<PromoDescription>sample string 2</PromoDescription>
</Product.WholesalerProductLocalization>
</WholesalerProductLocalizations>
</Product>
application/x-www-form-urlencoded
EanCode=value&Supplier=value&WholesalerArticleNumber=value&SalesPriceList=value&SalesPriceListPromo=value&UnitSalesPriceAbbreviation=value&OnOrder=value&PromoValidFrom=value&PromoValidFromUtc=value&PromoValidUntil=value&PromoValidUntilUtc=value&Active=value&WholesalerProductLocalizations=value&TemporarilyUnavailable=value&TemporaryReplacementArticleCode=value&OrderQuantity=value
Response Information
Resource Description
Oresto.API.Models.POST.LinkProducts.ProductData| Name | Description | Type | Additional information |
|---|---|---|---|
| Errors |
Possible errors that were experienced when processing the request |
Collection of string |
None. |
| ModelStateErrors |
Possible model errors that were experienced when validating the data |
Collection of Oresto.API.Models.Shared.ModelStateError |
None. |
| RequestInformation |
Additional information about the request |
Oresto.API.Models.Shared.RequestInformation |
None. |
Response Formats
application/json, text/json
{
"RequestInformation": {
"RequestDuration": 1,
"WholesalerId": 2,
"UserId": 3
},
"ModelStateErrors": [
{
"Key": "sample string 1",
"Message": "sample string 2",
"Exception": "sample string 3"
},
{
"Key": "sample string 1",
"Message": "sample string 2",
"Exception": "sample string 3"
}
],
"Errors": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
<ProductData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.POST.LinkProducts">
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<ModelStateErrors xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<ModelStateError>
<Exception>sample string 3</Exception>
<Key>sample string 1</Key>
<Message>sample string 2</Message>
</ModelStateError>
<ModelStateError>
<Exception>sample string 3</Exception>
<Key>sample string 1</Key>
<Message>sample string 2</Message>
</ModelStateError>
</ModelStateErrors>
<RequestInformation xmlns="http://schemas.datacontract.org/2004/07/Oresto.API.Models.Shared">
<RequestDuration>1</RequestDuration>
<UserId>3</UserId>
<WholesalerId>2</WholesalerId>
</RequestInformation>
</ProductData>