POST v1/PurchaseOrders/{purchaseOrderId}/Rows

Adds the specified order row.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
purchaseOrderId

The order identifier.

integer

Required.

Body Parameters

The order Row.

PurchaseOrderRow
NameDescriptionTypeAdditional information
Id

Gets or sets the identifier.

integer

Must be 0

ProductId

Gets or sets the product identifier.

integer

None.

ItemQuantity

Gets or sets the item quantity.

decimal number

Required

ItemQuantityDelivered

Gets the item quantity delivered.

decimal number

Required

ProductName

Gets or sets the name of the product.

string

Required

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

RowTotalExVat

Gets or sets the row total (exclude VAT).

decimal number

Required

Comment

Gets or sets the comment.

string

Max length: 2147483647

Sequence

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

integer

Required

ExpectedDeliveryDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "ProductId": 1,
  "ItemQuantity": 2.0,
  "ItemQuantityDelivered": 3.0,
  "ProductName": "sample string 4",
  "ProductCode": "sample string 5",
  "ProductDescription": "sample string 6",
  "ItemPriceExVat": 7.0,
  "RowTotalExVat": 8.0,
  "Comment": "sample string 9",
  "Sequence": 1,
  "ExpectedDeliveryDate": "2021-12-02T20:19:37.5134945+01:00"
}

application/xml, text/xml

Sample:
<PurchaseOrderRow xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <ProductId>1</ProductId>
  <ItemQuantity>2</ItemQuantity>
  <ItemQuantityDelivered>3</ItemQuantityDelivered>
  <ProductName>sample string 4</ProductName>
  <ProductCode>sample string 5</ProductCode>
  <ProductDescription>sample string 6</ProductDescription>
  <ItemPriceExVat>7</ItemPriceExVat>
  <RowTotalExVat>8</RowTotalExVat>
  <Comment>sample string 9</Comment>
  <Sequence>1</Sequence>
  <ExpectedDeliveryDate>2021-12-02T20:19:37.5134945+01:00</ExpectedDeliveryDate>
</PurchaseOrderRow>

Response Information

Resource Description

The PurchaseOrderRow object.


PurchaseOrderRow
NameDescriptionTypeAdditional information
Id

Gets or sets the identifier.

integer

Must be 0

ProductId

Gets or sets the product identifier.

integer

None.

ItemQuantity

Gets or sets the item quantity.

decimal number

Required

ItemQuantityDelivered

Gets the item quantity delivered.

decimal number

Required

ProductName

Gets or sets the name of the product.

string

Required

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

RowTotalExVat

Gets or sets the row total (exclude VAT).

decimal number

Required

Comment

Gets or sets the comment.

string

Max length: 2147483647

Sequence

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

integer

Required

ExpectedDeliveryDate

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "ProductId": 1,
  "ItemQuantity": 2.0,
  "ItemQuantityDelivered": 3.0,
  "ProductName": "sample string 4",
  "ProductCode": "sample string 5",
  "ProductDescription": "sample string 6",
  "ItemPriceExVat": 7.0,
  "RowTotalExVat": 8.0,
  "Comment": "sample string 9",
  "Sequence": 1,
  "ExpectedDeliveryDate": "2021-12-02T20:19:37.5134945+01:00"
}

application/xml, text/xml

Sample:
<PurchaseOrderRow xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <ProductId>1</ProductId>
  <ItemQuantity>2</ItemQuantity>
  <ItemQuantityDelivered>3</ItemQuantityDelivered>
  <ProductName>sample string 4</ProductName>
  <ProductCode>sample string 5</ProductCode>
  <ProductDescription>sample string 6</ProductDescription>
  <ItemPriceExVat>7</ItemPriceExVat>
  <RowTotalExVat>8</RowTotalExVat>
  <Comment>sample string 9</Comment>
  <Sequence>1</Sequence>
  <ExpectedDeliveryDate>2021-12-02T20:19:37.5134945+01:00</ExpectedDeliveryDate>
</PurchaseOrderRow>