Change of description

This endpoint is deprecated.
POST/api/RPC.common.Api.Offer.changeDescription?token=<TOKEN>

Key Offer.changeDescription · API version 2.0.0

Parameters

4 body parameters inside data[]
FieldTypeDescription
idStringOffer ID
numrequiredStringOffer #
descriptionrequiredStringDescription
internal_descriptionrequiredStringInternal description

Request example

Change Description By Num:
{
   "data" : [
      {
         "internal_description" : "Lorem Ipsum Internal Description",
         "description" : "Lorem Ipsum Description",
         "num" : "OFF0000026"
      }
   ]
}
Change Description By Id:
{
   "data" : [
      {
         "id" : 1130206756,
         "description" : "Lorem Ipsum Description",
         "internal_description" : "Lorem Ipsum Internal Description"
      }
   ]
}

cURL

Change Description By Num:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "internal_description" : "Lorem Ipsum Internal Description",         "description" : "Lorem Ipsum Description",         "num" : "OFF0000026"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Offer.changeDescription?token=<TOKEN>"
Change Description By Id:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "id" : 1130206756,         "description" : "Lorem Ipsum Description",         "internal_description" : "Lorem Ipsum Internal Description"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Offer.changeDescription?token=<TOKEN>"

Response example

    HTTP/1.1 200 OK
{
   "result" : [
      {
         "pos_name" : "Magento",
         "for_date" : "2024-01-24",
         "for_date_formated" : "24.01.2024",
         "type_action" : "offer",
         "internal_description" : null,
         "num" : "OFF0000026",
         "id" : 1130206756,
         "updatedon" : "2026-01-01 09:22:28",
         "description" : null,
         "createdon" : "2024-01-24 16:30:23",
         "type" : "offer"
      }
   ]
}