POST api/stockadjustment/receipt/of/goods/initiate

Initiates a receipt of goods.

Request Information

URI Parameters

None.

Body Parameters

PublicAPI.Models.ItemPurchaseDraftPostModel
NameDescriptionTypeAdditional information
InvoiceIdentifier

Receipt of goods identifier.

 string

String length: inclusive between 0 and 10
ShopIdOwner

Draft owner.

 integer

Range: inclusive between 1001 and 999999
ShopIdRecipient

Recipient shop id.

 integer

Range: inclusive between 1001 and 999999
OrderReference

Order reference.

 string

String length: inclusive between 0 and 30
DeliveryDate

Delivery date.

 date

None.
ImportListId

Import list id.

 integer

Range: inclusive between 0 and 999
MatchItemsOnEan

Match items on EAN for updates.

 boolean

None.
IncludeZeroQuantityLinesInDraft

Include zero quantity lines.

 boolean

None.
ItemLines

List if items.

 Collection of PublicAPI.Models.ItemPurchaseDraftLinePostModel

None.

Request Formats

application/json, text/json

Sample: 
{
  "InvoiceIdentifier": "sample string 1",
  "ShopIdOwner": 2,
  "ShopIdRecipient": 3,
  "OrderReference": "sample string 4",
  "DeliveryDate": "2025-05-04T06:56:10.2596254+02:00",
  "ImportListId": 6,
  "MatchItemsOnEan": true,
  "IncludeZeroQuantityLinesInDraft": true,
  "ItemLines": [
    {
      "Barcode": "sample string 1",
      "SupplierId": 2,
      "ItemGroupId": 3,
      "StyleParameter1": "sample string 4",
      "StyleParameter2": "sample string 5",
      "StyleParameter3": "sample string 6",
      "StyleParameter4": "sample string 7",
      "StyleParameter5": "sample string 8",
      "VariantParameter1": "sample string 9",
      "VariantParameter2": "sample string 10",
      "VariantParameter3": "sample string 11",
      "VariantParameter4": "sample string 12",
      "VariantParameter5": "sample string 13",
      "Quantity": 14,
      "SalesPricePerItem": 15.0,
      "CostPricePerItem": 16.0
    },
    {
      "Barcode": "sample string 1",
      "SupplierId": 2,
      "ItemGroupId": 3,
      "StyleParameter1": "sample string 4",
      "StyleParameter2": "sample string 5",
      "StyleParameter3": "sample string 6",
      "StyleParameter4": "sample string 7",
      "StyleParameter5": "sample string 8",
      "VariantParameter1": "sample string 9",
      "VariantParameter2": "sample string 10",
      "VariantParameter3": "sample string 11",
      "VariantParameter4": "sample string 12",
      "VariantParameter5": "sample string 13",
      "Quantity": 14,
      "SalesPricePerItem": 15.0,
      "CostPricePerItem": 16.0
    }
  ]
}

application/xml, text/xml

Sample: 
<ItemPurchaseDraftPostModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <DeliveryDate>2025-05-04T06:56:10.2596254+02:00</DeliveryDate>
  <ImportListId>6</ImportListId>
  <IncludeZeroQuantityLinesInDraft>true</IncludeZeroQuantityLinesInDraft>
  <InvoiceIdentifier>sample string 1</InvoiceIdentifier>
  <ItemLines>
    <ItemPurchaseDraftLinePostModel>
      <Barcode>sample string 1</Barcode>
      <CostPricePerItem>16</CostPricePerItem>
      <ItemGroupId>3</ItemGroupId>
      <Quantity>14</Quantity>
      <SalesPricePerItem>15</SalesPricePerItem>
      <StyleParameter1>sample string 4</StyleParameter1>
      <StyleParameter2>sample string 5</StyleParameter2>
      <StyleParameter3>sample string 6</StyleParameter3>
      <StyleParameter4>sample string 7</StyleParameter4>
      <StyleParameter5>sample string 8</StyleParameter5>
      <SupplierId>2</SupplierId>
      <VariantParameter1>sample string 9</VariantParameter1>
      <VariantParameter2>sample string 10</VariantParameter2>
      <VariantParameter3>sample string 11</VariantParameter3>
      <VariantParameter4>sample string 12</VariantParameter4>
      <VariantParameter5>sample string 13</VariantParameter5>
    </ItemPurchaseDraftLinePostModel>
    <ItemPurchaseDraftLinePostModel>
      <Barcode>sample string 1</Barcode>
      <CostPricePerItem>16</CostPricePerItem>
      <ItemGroupId>3</ItemGroupId>
      <Quantity>14</Quantity>
      <SalesPricePerItem>15</SalesPricePerItem>
      <StyleParameter1>sample string 4</StyleParameter1>
      <StyleParameter2>sample string 5</StyleParameter2>
      <StyleParameter3>sample string 6</StyleParameter3>
      <StyleParameter4>sample string 7</StyleParameter4>
      <StyleParameter5>sample string 8</StyleParameter5>
      <SupplierId>2</SupplierId>
      <VariantParameter1>sample string 9</VariantParameter1>
      <VariantParameter2>sample string 10</VariantParameter2>
      <VariantParameter3>sample string 11</VariantParameter3>
      <VariantParameter4>sample string 12</VariantParameter4>
      <VariantParameter5>sample string 13</VariantParameter5>
    </ItemPurchaseDraftLinePostModel>
  </ItemLines>
  <MatchItemsOnEan>true</MatchItemsOnEan>
  <OrderReference>sample string 4</OrderReference>
  <ShopIdOwner>2</ShopIdOwner>
  <ShopIdRecipient>3</ShopIdRecipient>
</ItemPurchaseDraftPostModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ItemPurchaseDraftPostModel'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample: 
true

application/xml, text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>