GET Pricelist/{id}

• 3 minutes to read

GET /api/v1/Pricelist/{id}

Gets a PriceList object.

Calls the Quote agent service GetPriceList. NsApiSlow threshold: 5000 ms.

Path Part	Type	Description
id	int32	The id of the PriceList to return. 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.

GET /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
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.

Response:

PriceList found.

Response	Description
200	PriceList found.
404	Not Found.

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

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

Sample response

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

{
  "PriceListId": 383,
  "ERPPriceListKey": "est",
  "QuoteConnectionId": 507,
  "Name": "Huel Group",
  "Description": "Standard pricing for products",
  "Currency": "explicabo",
  "CurrencyName": "Kertzmann-Kozey",
  "ValidFrom": "2024-04-13T14:34:03.2674693+02:00",
  "ValidTo": "2010-09-19T14:34:03.2674693+02:00",
  "IsActive": false,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 873
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/contact/321",
    "Archive": "https://www.example.com/api/v1/contact"
  }
}