POST v1/Offers/{offerId}/Rows

Adds the specified Offer row.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
offerId

The Offer identifier.

integer

Required.

Body Parameters

The Offer Row.

OfferRow
NameDescriptionTypeAdditional information
Id

Gets or sets the identifier.

integer

Must be 0 (for insert operations)

ProductSelectionProductId

Gets or sets the product selection product identifier.

integer

None.

ItemQuantity

Gets or sets the item quantity. When a credit is made, the value must be smaller than 0.

decimal number

Required

ProductName

Gets or sets the name of the product.

string

Max length: 500

ProductCode

Gets or sets the product code.

string

Required

Max length: 100

ProductDescription

Gets or sets the product description.

string

Max length: 2147483647

ItemPriceExVat

Gets or sets the item price (exclude VAT).

decimal number

Required

ItemPriceIncVat

Gets or sets the item price (include VAT).

decimal number

Required

ItemDiscountExVat

Gets or sets the item discount (exclude VAT). ItemDiscount takes precedence on RowDiscount.

decimal number

Required

ItemDiscountIncVat

Gets or sets the item discount (include VAT). ItemDiscount takes precedence on RowDiscount.

decimal number

Required

RowDiscountExVat

Gets or sets the row discount (exclude VAT).

decimal number

Required

RowDiscountIncVat

Gets or sets the row discount (include VAT).

decimal number

Required

Vatperc

Gets or sets the VAT percent.

decimal number

Required

VATTariffId

Gets or sets the vat tariff identifier.

integer

None.

VATTariffCode

Gets or sets the vat tariff code.

string

None.

RowTotalExVat

Gets or sets the row total (exclude VAT).

decimal number

Required

RowTotalIncVat

Gets or sets the row total (include VAT).

decimal number

Required

Comment

Gets or sets the comment.

string

Max length: 2147483647

ItemPurchasePrice

Gets or sets the item purchase price.

decimal number

None.

Sequence

The display sequence. If not specified ShopCtrl will determine the sequence.

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "ProductSelectionProductId": 1,
  "ItemQuantity": 2.0,
  "ProductName": "sample string 3",
  "ProductCode": "sample string 4",
  "ProductDescription": "sample string 5",
  "ItemPriceExVat": 6.0,
  "ItemPriceIncVat": 7.0,
  "ItemDiscountExVat": 8.0,
  "ItemDiscountIncVat": 9.0,
  "RowDiscountExVat": 10.0,
  "RowDiscountIncVat": 11.0,
  "Vatperc": 1.0,
  "VATTariffId": 1,
  "VATTariffCode": "sample string 12",
  "RowTotalExVat": 13.0,
  "RowTotalIncVat": 14.0,
  "Comment": "sample string 15",
  "ItemPurchasePrice": 1.0,
  "Sequence": 1
}

application/xml, text/xml

Sample:
<OfferRow xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <ProductSelectionProductId>1</ProductSelectionProductId>
  <ItemQuantity>2</ItemQuantity>
  <ProductName>sample string 3</ProductName>
  <ProductCode>sample string 4</ProductCode>
  <ProductDescription>sample string 5</ProductDescription>
  <ItemPriceExVat>6</ItemPriceExVat>
  <ItemPriceIncVat>7</ItemPriceIncVat>
  <ItemDiscountExVat>8</ItemDiscountExVat>
  <ItemDiscountIncVat>9</ItemDiscountIncVat>
  <RowDiscountExVat>10</RowDiscountExVat>
  <RowDiscountIncVat>11</RowDiscountIncVat>
  <Vatperc>1</Vatperc>
  <VATTariffId>1</VATTariffId>
  <VATTariffCode>sample string 12</VATTariffCode>
  <RowTotalExVat>13</RowTotalExVat>
  <RowTotalIncVat>14</RowTotalIncVat>
  <Comment>sample string 15</Comment>
  <ItemPurchasePrice>1</ItemPurchasePrice>
  <Sequence>1</Sequence>
</OfferRow>

Response Information

Resource Description

The HttpResponseMessage object.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.