Change of description

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

Key So.changeDescription · API version 2.0.0

Parameters

4 body parameters inside data[]
FieldTypeDescription
idIntegerSales Order ID
numrequiredStringSales Order ID
descriptionrequiredStringDescription
internal_descriptionrequiredStringInternal description

Request example

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

cURL

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

Response example

    HTTP/1.1 200 OK
{
   "result" : [
      {
         "internal_description" : null,
         "type_action" : "so",
         "for_date_formated" : "06.01.2021",
         "for_date" : "2021-01-06",
         "pos_name" : "London",
         "type" : "so",
         "updatedon" : "2026-01-01 09:22:28",
         "createdon" : "2021-10-06 15:36:59",
         "description" : null,
         "rel_trans" : [
            {
               "num" : "0000001440",
               "trans_id" : 3268154,
               "type" : "invoice",
               "rel_trans_id" : 3268159,
               "for_date" : "2021-01-06"
            }
         ],
         "id" : 3268154,
         "num" : "CO10001440"
      }
   ]
}