Skip to content

patchArticle

Request

Path
idinteger, (int32)required
Bodyapplication/jsonrequired
property name*anyadditional property
PATCH
/api/v1/article/{id}
curl -i -X PATCH \
  'https://api.prana.software/api/v1/article/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "property1": null,
    "property2": null
  }'

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

Default:""
codestring, [ 0 .. 20 ] charactersrequired

Article code.

Default:""
Example:"ART001"
descriptionstring

Article description.

Default:""
Example:"Blue T-Shirt"
vatTypestring, non-emptyrequired

VAT type.

Default:""
Example:"Standard VAT"
purchaseVatTypestring, non-emptyrequired

Purchase VAT type.

Default:""
Example:"Standard VAT"
heightnumber

Height.

Default:""
Example:10
widthnumber

Width.

Default:""
Example:5
depthnumber

Depth.

Default:""
Example:3
grossWeightnumber

Gross weight.

Default:""
Example:1.5
netWeightnumber

Net weight.

Default:""
Example:1.2
warehouseobject(ApiWarehouseListReadDto)required

Warehouse information.

Default:""
accumulateWarehouseboolean

Indicates if warehouse is accumulated.

Default:false
Example:false
unitWarehouseobject(ApiUnitTypeListReadDto)

Unit of measure for warehouse.

Default:""
salesAccountobject(ApiChartAccountListReadDto)

Sales chart of account.

Default:""
purchasingAccountobject(ApiChartAccountListReadDto)

Purchasing chart of account.

Default:""
baseCombinationobject(ApiArticleCombinationDefaultReadDto)

Base article combination.

Default:""
familyobject(ApiFamilyReadDto)

Article family.

Default:""
articleCombinationsArray of objects(ApiArticleCombinationReadDto)

List of article combinations.

Default:""
observationsArray of objects(ApiArticleObservationListReadDto)

List of observations.

Default:""
filesArray of objects(ApiArticleFileListReadDto)

List of associated files.

Default:""
tagsArray of strings

List of associated tags.

Default:""
showAttribute1boolean

Flag to show attribute 1.

Default:false
Example:true
showAttribute2boolean

Flag to show attribute 2.

Default:false
Example:true
showAttribute3boolean

Flag to show attribute 3.

Default:false
Example:false
showAttribute4boolean

Flag to show attribute 4.

Default:false
Example:false
showAttribute5boolean

Flag to show attribute 5.

Default:false
Example:false
stockQuantitynumber

Current stock quantity.

Default:""
Example:50
salesQuantitynumber

Sales quantity.

Default:""
Example:30
cancelledQuantitynumber

Cancelled quantity.

Default:""
Example:2
outboundQuantitynumber

Outbound quantity.

Default:""
Example:10
pendingDeliveryQuantitynumber

Pending delivery quantity.

Default:""
Example:5
purchaseQuantitynumber

Purchase quantity.

Default:""
Example:100
providerCancelledQuantitynumber

Provider cancelled quantity.

Default:""
Example:1
inboundQuantitynumber

Inbound quantity.

Default:""
Example:80
pendingReceiptQuantitynumber

Pending receipt quantity.

Default:""
Example:20
articleSizeRangesArray of objects(ApiArticleSizeRangeReadDto)

List of associated article size ranges.

Default:""
description2string, [ 0 .. 100 ] characters

Secondary description.

Default:""
Example:"Premium cotton"
articleTypestring(ApiArticleTypeEnum)required

Article type.

Default:""
Enum:"PACKAGING""EXPENSE""RAW_MATERIAL""MERCHANDISE""OTHERS""FINISHED_PRODUCT""SEMI_FINISHED""SERVICE""ADVERTISING"
phytosanitaryProductobject(ApiPhytosanitaryProductListReadDto)

Phytosanitary product information.

Default:""
batchControlboolean

Indicates if batch control is active for this article.

Default:false
Example:true
serialNumberControlboolean

Indicates if serial number control is active for this article.

Default:false
Example:true
showBatchExpirationDateboolean

Indicates if batch expiration date should be shown.

Default:false
Example:true
batchExpirationDaysAlertinteger, (int32)

Number of days before expiration to show an alert.

Default:""
Example:30
usesPresentationsboolean

Indicate whether presentations are allowed

Default:false
Example:false
presentationsCountinteger, (int32)

Number of related presentations

Default:""
Example:4
articlePresentationsArray of objects(ApiArticlePresentationReadDto)

List of article presentations.

Default:""
category1object(ApiCategoryListReadDto)

Category 1.

Default:""
category2object(ApiCategoryListReadDto)

Category 2.

Default:""
category3object(ApiCategoryListReadDto)

Category 3.

Default:""
category4object(ApiCategoryListReadDto)

Category 4.

Default:""
packboolean

Indicates whether this article is a pack (bundle of other articles).

Default:false
Example:false
Response
{
  "id": "",
  "code": "ART001",
  "description": "Blue T-Shirt",
  "vatType": "Standard VAT",
  "purchaseVatType": "Standard VAT",
  "height": 10,
  "width": 5,
  "depth": 3,
  "grossWeight": 1.5,
  "netWeight": 1.2,
  "warehouse": {
    "id": "",
    "code": "ALM01",
    "description": "Central warehouse",
    "population": "Madrid",
    "active": true
  },
  "accumulateWarehouse": false,
  "unitWarehouse": {
    "id": "",
    "code": "KG",
    "description": "Kilogram",
    "isoCode": "DMK"
  },
  "salesAccount": {
    "id": "",
    "code": "1000",
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": "100",
    "parentDescription": "Assets"
  },
  "purchasingAccount": {
    "id": "",
    "code": "1000",
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": "100",
    "parentDescription": "Assets"
  },
  "baseCombination": {
    "id": "",
    "defaultArticleCombinationSupplier": { … },
    "defaultItemSaleRate": { … },
    "defaultEan": null,
    "article": "string",
    "articleId": 0,
    "articleType": "PACKAGING",
    "unitWarehouseId": 0,
    "articleDescription": "string",
    "attribute1": null,
    "attribute2": null,
    "attribute3": null,
    "attribute4": null,
    "attribute5": null,
    "seasonId": 0,
    "season": "string",
    "category1": "string",
    "category2": "string",
    "category3": "string",
    "category4": "string",
    "description": "string",
    "active": true,
    "articleVatType": "string",
    "purchaseArticleVatType": "string",
    "assortment": null,
    "sizeRange": null,
    "serialNumberControl": true,
    "batchControl": true
  },
  "family": null,
  "articleCombinations": "",
  "observations": "",
  "files": "",
  "tags": "",
  "showAttribute1": true,
  "showAttribute2": true,
  "showAttribute3": false,
  "showAttribute4": false,
  "showAttribute5": false,
  "stockQuantity": 50,
  "salesQuantity": 30,
  "cancelledQuantity": 2,
  "outboundQuantity": 10,
  "pendingDeliveryQuantity": 5,
  "purchaseQuantity": 100,
  "providerCancelledQuantity": 1,
  "inboundQuantity": 80,
  "pendingReceiptQuantity": 20,
  "articleSizeRanges": "",
  "description2": "Premium cotton",
  "articleType": "PACKAGING",
  "phytosanitaryProduct": {
    "id": "",
    "code": "PHYT-001",
    "description": "Herbicide type A",
    "headline": "Active Ingredient",
    "form": "Liquid",
    "cancellationDate": "2025-12-31",
    "saleDeadline": "2025-11-30"
  },
  "batchControl": true,
  "serialNumberControl": true,
  "showBatchExpirationDate": true,
  "batchExpirationDaysAlert": 30,
  "usesPresentations": false,
  "presentationsCount": 4,
  "articlePresentations": "",
  "category1": null,
  "category2": null,
  "category3": null,
  "category4": null,
  "pack": false
}