Add

[POST] .../v1/wholesaleoperation/add

Creates a new operation partner shipment document. Use this method to add one or more item lines to a DocWholeSale shipment document before the document is posted. The request body is a JSON array batch; every operation must contain document_id, item_id and positive quantity up to 999999999, may include price and price2 values from 0 to 99999999999, optional order, optional VAT value and optional description up to 300 characters and all array items must reference the same document_id. When price or price2 is omitted or set to 0, the server uses the document price type when available. The parent DocWholeSale must be locked by the current user and eligible for editing, no discount/allowance rows may already exist on the document and the item must be an active non-compound leaf item; null, empty or oversized arrays, invalid values, mixed document_ids, denied access or document/item state conflicts are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
description String Optional Operation note. Maximum length is 300 characters.
document_id Int64 Required Shipment-to-partner document ID.
item_id Int64 Required Item ID.
order Int64 Optional Operation order. NULL means not set and is stored as NULL in the database. Ignored for database versions earlier than 363.
price Decimal Optional Discounted sale price. Optional; omitted or zero uses the document price type when available, negative values are rejected and the value must be no greater than 99999999999.
price2 Decimal Optional Sale price before discount. Optional; omitted or zero uses the document price type when available, negative values are rejected and the value must be no greater than 99999999999.
quantity Decimal Required Item quantity to ship. Must be greater than zero and no greater than 999999999.
vat_value Decimal Optional VAT rate value. Null uses the item's VAT rate; -1 is accepted for document/default VAT behavior.

Request Example

[
  {
    "document_id": 4601,
    "item_id": 1001,
    "quantity": 3,
    "order": 10,
    "price": 50000,
    "price2": 52000,
    "vat_value": 12,
    "description": "Shipment to partner warehouse"
  }
]

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1,
    "ids": [
      8601
    ]
  }
}