POST v1/CustomerContracts/{customerContractId}/Products
Adds the specified CustomerContract product.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| customerContractId |
The CustomerContract identifier. |
integer |
Required. |
Body Parameters
The CustomerContract Product.
CustomerContractProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The unique Id of the CustomerContractProduct. |
integer |
Must be 0 (for insert operations) |
| ProductId |
The ProductId to add to Orders to generate. |
integer |
None. |
| ProductCode |
The Unique Product Code/SKU. |
string |
None. |
| ProductName |
The name of the Product. |
string |
None. |
| ProductSelectionProductId |
The Id of the ProductSelectionProduct to use (Product specifications per Shop). |
integer |
Required |
| DefaultQty |
The Default Qty to use for Orders to generate. |
integer |
None. |
| PriceMode |
Defines how the Price is being determined. |
PriceModeEnum |
None. |
| QuantityMode |
Defines how the Quantity is being determined. |
QuantityModeEnum |
None. |
| IncludeToOrderMode |
Defines when the Product is added to the Order to generate. |
IncludeToOrderModeEnum |
None. |
| IncludeDateRepeatsMode |
Specify at what frequency the Product is added to the Order. Note IncludeToOrderMode must be equal to 'WhenDateInBillingPeriodAddToOrder'. |
RepeatsModeEnum |
None. |
| IncludeDateEndsMode |
Indicates when to stop adding the Product to the Orders to generate. |
EndsModeEnum |
None. |
| Comment |
Comment which will be added to the OrderRow in the Order to generate. |
string |
Max length: 2147483647 |
| IncludeDateRepeatEvery |
What moment in the RepeatsMode. |
integer |
Required |
| IncludeDateEndsOccurrences |
When specified, the Product will only be added to the Order after the given nr of occurrences. |
integer |
None. |
| IncludeDateStart |
If specified, only include the Product to the order when after provided start date. |
date |
None. |
| IncludeDateEndsDate |
If specified, only include the Product to the order when end date is not yet passed. |
date |
None. |
| InternalComment |
Internal comment. |
string |
Max length: 2147483647 |
| Sequence |
The sequence to add the Product to the Order. |
integer |
Required |
| VattariffId |
The VAT tariff to use for the order to generate. |
integer |
None. |
| TierPriceValues |
The TierPrice values. |
Collection of ProductTierPriceValue |
None. |
Request Formats
application/json, text/json
Sample not available.
Response Information
Resource Description
The HttpResponseMessage object.
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |