POST v1/PurchaseOrders/{purchaseOrderId}/Rows

Adds the specified order row.

Request Information

URI Parameters

Name	Description	Type	Additional information
purchaseOrderId	The order identifier.	integer	Required.

Body Parameters

The order Row.

AddPurchaseOrderRow

Name	Description	Type	Additional information
ProductId	Gets or sets the product identifier.	integer	None.
ItemQuantity	Gets or sets the item quantity.	decimal number	None.
ItemQuantityDelivered	Gets the item quantity delivered.	decimal number	None.
ProductCode	Gets or sets the product code.	string	None.
ItemPriceExVat	Gets or sets the item price (exclude VAT).	decimal number	None.
RowTotalExVat	Gets or sets the row total (exclude VAT).	decimal number	None.
Comment	Gets or sets the comment.	string	None.
Sequence	The display sequence. If not specified ShopCtrl will determine the sequence.	integer	None.
ExpectedDeliveryDate	Gets or sets the comment.	date	None.
StockItems	Please specify the advanced StockItems for this OrderRow. When updating an OrderRow, it's important to provide a complete list of StockItems. The information you provide will be pre-entered during provisioning in the WEB UI. It's worth noting that these StockItems will have NO effect if you use the API for provisioning.	Collection of StockItemDto	None.

Request Formats

application/json, text/json

Sample:

{
  "ProductId": 1,
  "ItemQuantity": 1.0,
  "ItemQuantityDelivered": 2.0,
  "ProductCode": "sample string 3",
  "ItemPriceExVat": 4.0,
  "RowTotalExVat": 5.0,
  "Comment": "sample string 6",
  "Sequence": 1,
  "ExpectedDeliveryDate": "2026-01-11T16:13:39.2872807+01:00",
  "StockItems": [
    {
      "ProductCode": "sample string 1",
      "LotNumber": "sample string 2",
      "SerialNumber": "sample string 3",
      "ExpiryDate": "2026-01-11T16:13:39.2872807+01:00",
      "Quantity": 1
    },
    {
      "ProductCode": "sample string 1",
      "LotNumber": "sample string 2",
      "SerialNumber": "sample string 3",
      "ExpiryDate": "2026-01-11T16:13:39.2872807+01:00",
      "Quantity": 1
    }
  ]
}

application/xml, text/xml

Sample:

<AddPurchaseOrderRow xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProductId>1</ProductId>
  <ItemQuantity>1</ItemQuantity>
  <ItemQuantityDelivered>2</ItemQuantityDelivered>
  <ProductCode>sample string 3</ProductCode>
  <ItemPriceExVat>4</ItemPriceExVat>
  <RowTotalExVat>5</RowTotalExVat>
  <Comment>sample string 6</Comment>
  <Sequence>1</Sequence>
  <ExpectedDeliveryDate>2026-01-11T16:13:39.2872807+01:00</ExpectedDeliveryDate>
  <StockItems>
    <StockItemDto>
      <ProductCode>sample string 1</ProductCode>
      <LotNumber>sample string 2</LotNumber>
      <SerialNumber>sample string 3</SerialNumber>
      <ExpiryDate>2026-01-11T16:13:39.2872807+01:00</ExpiryDate>
      <Quantity>1</Quantity>
    </StockItemDto>
    <StockItemDto>
      <ProductCode>sample string 1</ProductCode>
      <LotNumber>sample string 2</LotNumber>
      <SerialNumber>sample string 3</SerialNumber>
      <ExpiryDate>2026-01-11T16:13:39.2872807+01:00</ExpiryDate>
      <Quantity>1</Quantity>
    </StockItemDto>
  </StockItems>
</AddPurchaseOrderRow>

Response Information

Resource Description

The PurchaseOrderRow object.

PurchaseOrderRow

Name	Description	Type	Additional information
ProductName	Gets or sets the name of the product.	string	None.
ProductDescription	Gets or sets the product description.	string	None.
Id	Gets or sets the identifier.	integer	None.
ProductId	Gets or sets the product identifier.	integer	None.
ItemQuantity	Gets or sets the item quantity.	decimal number	None.
ItemQuantityDelivered	Gets the item quantity delivered.	decimal number	None.
ProductCode	Gets or sets the product code.	string	None.
ItemPriceExVat	Gets or sets the item price (exclude VAT).	decimal number	None.
RowTotalExVat	Gets or sets the row total (exclude VAT).	decimal number	None.
Comment	Gets or sets the comment.	string	None.
Sequence	The display sequence. If not specified ShopCtrl will determine the sequence.	integer	None.
ExpectedDeliveryDate	Gets or sets the comment.	date	None.
StockItems	Please specify the advanced StockItems for this OrderRow. When updating an OrderRow, it's important to provide a complete list of StockItems. The information you provide will be pre-entered during provisioning in the WEB UI. It's worth noting that these StockItems will have NO effect if you use the API for provisioning.	Collection of StockItemDto	None.

Response Formats

application/json, text/json

Sample:

{
  "ProductName": "sample string 1",
  "ProductDescription": "sample string 2",
  "Id": 3,
  "ProductId": 1,
  "ItemQuantity": 4.0,
  "ItemQuantityDelivered": 5.0,
  "ProductCode": "sample string 6",
  "ItemPriceExVat": 7.0,
  "RowTotalExVat": 8.0,
  "Comment": "sample string 9",
  "Sequence": 1,
  "ExpectedDeliveryDate": "2026-01-11T16:13:39.3029077+01:00",
  "StockItems": [
    {
      "ProductCode": "sample string 1",
      "LotNumber": "sample string 2",
      "SerialNumber": "sample string 3",
      "ExpiryDate": "2026-01-11T16:13:39.3029077+01:00",
      "Quantity": 1
    },
    {
      "ProductCode": "sample string 1",
      "LotNumber": "sample string 2",
      "SerialNumber": "sample string 3",
      "ExpiryDate": "2026-01-11T16:13:39.3029077+01:00",
      "Quantity": 1
    }
  ]
}

application/xml, text/xml

Sample:

<PurchaseOrderRow xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProductId>1</ProductId>
  <ItemQuantity>4</ItemQuantity>
  <ItemQuantityDelivered>5</ItemQuantityDelivered>
  <ProductCode>sample string 6</ProductCode>
  <ItemPriceExVat>7</ItemPriceExVat>
  <RowTotalExVat>8</RowTotalExVat>
  <Comment>sample string 9</Comment>
  <Sequence>1</Sequence>
  <ExpectedDeliveryDate>2026-01-11T16:13:39.3029077+01:00</ExpectedDeliveryDate>
  <StockItems>
    <StockItemDto>
      <ProductCode>sample string 1</ProductCode>
      <LotNumber>sample string 2</LotNumber>
      <SerialNumber>sample string 3</SerialNumber>
      <ExpiryDate>2026-01-11T16:13:39.3029077+01:00</ExpiryDate>
      <Quantity>1</Quantity>
    </StockItemDto>
    <StockItemDto>
      <ProductCode>sample string 1</ProductCode>
      <LotNumber>sample string 2</LotNumber>
      <SerialNumber>sample string 3</SerialNumber>
      <ExpiryDate>2026-01-11T16:13:39.3029077+01:00</ExpiryDate>
      <Quantity>1</Quantity>
    </StockItemDto>
  </StockItems>
  <Id>3</Id>
  <ProductName>sample string 1</ProductName>
  <ProductDescription>sample string 2</ProductDescription>
</PurchaseOrderRow>