PATCH Pricelist/{id}

• 5 minutes to read

PATCH /api/v1/Pricelist/{id}

Update a PriceList with changes, as described in a JSON Patch or a JSON Merge Patch document.

See RFC6902 and RFC 7396. Update the Department field to "foo" can be done either as a JSON PATCH:


[ { "op": "replace", "path": "/Department", "value": "foo" } ]

or as a JSON MERGE PATCH, which describes the change directly:


{ "Department": "foo" }

JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'. The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.

Calls the {SuperOffice.CRM.Services.IQuoteAgent} service SavePriceList.

Path Part	Type	Description
id	int32	The PriceList id to update. Required

Query String Parameters

Parameter Name	Type	Description
$select	string	Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields.

PATCH /api/v1/Pricelist/{id}?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type	Content-type of the request body:
Accept	Content-type(s) you would like the response in: `application/json`, `text/json`, `application/xml`, `text/xml`, `application/json-patch+json`, `application/merge-patch+json`
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: changes

JSON-Patch array of operations+path+value, or a MERGE-PATCH object (which will be converted to a list of JSON-PATCH operations).

Property Name	Type	Description
op	String	"add", "replace", "remove", "test" "move" and "copy" not supported
path	String	The property names to modify. "/users/0/email", "/users/-",
value	Object	New/Replaced value - string or object.

Response:

PriceList updated.

Response	Description
200	PriceList updated.
404	PriceList with given id does not exist in the db.
409	Update blocked because a 'test' operation has detected a conflict with the entity value.
412	Update aborted because PriceList has changed since the requested If-Unmodified-Since timestamp.

Response body: PriceListWithLinks

Property Name	Type	Description
PriceListId	int32	Primary key
ERPPriceListKey	string	The key that uniquely identifies this pricelist in the ERP system
QuoteConnectionId	int32	(Reserved for future use) The connection to the ERP system used for this pricelist
Name	string	Name of this pricelist to use in the user interface.
Description	string	Description of this pricelist , will be used as tool-tip in the user interface.
Currency	string	The iso currency code, like 'USD' or 'NOK'.
CurrencyName	string	The name to use in the user interface, like perhaps 'US dollar' or '$'
ValidFrom	date-time	The date (inclusive) the pricelist start to be valid. This can be DateTime.MinValue to signal that it doesn't have a specific start date.
ValidTo	date-time	The date (inclusive) the pricelist ends to be valid. This can be DateTime.MaxValue to signal that it doesn't have a specific end date.
IsActive	bool	Is the list active (as opposed to being worked on, suddenly canceled, etc.
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.
_Links	object

Sample request

PATCH /api/v1/Pricelist/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

[
  {
    "op": "add",
    "path": "alias",
    "value": {}
  },
  {
    "op": "add",
    "path": "alias",
    "value": {}
  }
]

Sample response

HTTP/1.1 200 PriceList  updated.
Content-Type: application/json; charset=utf-8

{
  "PriceListId": 828,
  "ERPPriceListKey": "quia",
  "QuoteConnectionId": 748,
  "Name": "Jast-Brown",
  "Description": "Robust attitude-oriented circuit",
  "Currency": "non",
  "CurrencyName": "Kris, Feeney and Wisozk",
  "ValidFrom": "2024-11-24T14:13:50.0562893+01:00",
  "ValidTo": "1999-02-05T14:13:50.0562893+01:00",
  "IsActive": false,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 929
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}