All pages
Powered by GitBook
1 of 5

Loading...

Loading...

Loading...

Loading...

Loading...

Pricelist Items

The Pricelist Item object represents pricing information for a particular Product Item.

Field
Type
Description

id

string

The business identifier of the price list Item.

Example: PRI-1234-5678-9012-0001

status

enum

The status of the pricelist item.

Possible values: Draft, Private (can be used in subscription, but not for sale), or For sale (available for assignment on a subscription and sale).

unitLP

decimal

The unit list price of the product item, also known as the Manufacturer's Suggested Retail Price.

Only SoftwareOne operations or vendors can edit the field. Clients can see the field in the Marketplace, but cannot edit it.

Example: 39.95

unitPP

decimal

The unit purchase price of the Product Item. Only SoftwareOne operations or vendors can see the field.

Example: 19.95

markup

decimal

The markup that has been applied to the item price. Optional on request: if omitted, the price list default markup is used. Only SoftwareOne Operations can view the field.

Example: 0.5013

margin

decimal

The margin of the item price, calculated from the purchase price and the markup. Only SoftwareOne operations can view the field.

Example: 0.3339

unitSP

decimal

The unit sales price of the Product Item, calculated from the purchase price and the markup.

Only SoftwareOne operations and clients can view the field.

Example: 29.95

PPx1

decimal

The purchase price. Only SoftwareOne operations and vendors can view the field.

Example: 3

PPxM

decimal

The purchase price per month. Only SoftwareOne operations and vendors can view the field.

Example: 19.95

PPxY

decimal

The purchase price per year. Only SoftwareOne operations and vendors can view the field.

Example: 239.40

SPx1

decimal

The sales price. Only SoftwareOne operations and clients can view the field.

Example: 3.45

SPxM

decimal

The sales price value per month. Only SoftwareOne operations and clients can view the field.

Example: 29.95

SPxY

decimal

The sales price per year. Only SoftwareOne operations and clients can view the field.

Example: 359.40

LPx1

decimal

The estimated list price value per. Only SoftwareOne Operations and Clients can view the field.

Example: 4.45

LPxM

decimal

The estimated list price per month. Only SoftwareOne operations and clients can view the field.

Example: 20.99

LPxY

decimal

The estimated list price per year. Only SoftwareOne operations and clients can view the field.

Example: 300.89

priceList

priceList

The price list that this item belongs to.

item

item

A reference to the Item object.

audit

audit

A reference to the Audit object.

List Pricelist Items

List of items in a price list.

Get Pricelist Item

Gets a price item within a price list.

State Diagram

The following diagram shows the possible states for the Pricelist Item object and the transition between these states:

The state transition diagram of a pricelist item.

Update Pricelist Item

Updates a price item within a price list.

This object contains the following attributes:

get
Path parameters
priceListIdstringRequired
Responses
200

OK

application/json
get
/public/v1/catalog/price-lists/{priceListId}/items
200

OK

get
Path parameters
idstringRequired
priceListIdstringRequired
Query parameters
selectstringOptional
Responses
200

OK

application/json
404

Not Found

application/json
get
/public/v1/catalog/price-lists/{priceListId}/items/{id}
put
Path parameters
priceListIdstringRequired
idstringRequired
Body
statusstringOptional
reasonForChangestring | nullableOptional
descriptionstring | nullableOptional
unitPPnumber · doubleOptional
unitLPnumber · doubleOptional
unitSPnumber · doubleOptional
markupnumber · doubleOptional
Responses
200

OK

application/json
400

Bad Request

application/json
403

Forbidden

application/json
404

Not Found

application/json
put
/public/v1/catalog/price-lists/{priceListId}/items/{id}
GET /public/v1/catalog/price-lists/{priceListId}/items/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
GET /public/v1/catalog/price-lists/{priceListId}/items HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {},
        "updated": {},
        "published": {},
        "unpublished": {}
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "status": "Draft",
      "description": "text",
      "reasonForChange": "text",
      "unitLP": 1,
      "unitPP": 1,
      "markup": 1,
      "margin": 1,
      "unitSP": 1,
      "PPx1": 1,
      "PPxM": 1,
      "PPxY": 1,
      "SPx1": 1,
      "SPxM": 1,
      "SPxY": 1,
      "LPx1": 1,
      "LPxM": 1,
      "LPxY": 1,
      "priceList": {
        "id": "text",
        "currency": "text"
      },
      "item": {
        "id": "text",
        "name": "text",
        "externalIds": {
          "vendor": "text",
          "operations": "text"
        }
      }
    }
  ]
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-12-14T07:59:46.564Z",
      "by": {}
    },
    "updated": {
      "at": "2025-12-14T07:59:46.564Z",
      "by": {}
    },
    "published": {
      "at": "2025-12-14T07:59:46.564Z",
      "by": {}
    },
    "unpublished": {
      "at": "2025-12-14T07:59:46.564Z",
      "by": {}
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "status": "Draft",
  "description": "text",
  "reasonForChange": "text",
  "unitLP": 1,
  "unitPP": 1,
  "markup": 1,
  "margin": 1,
  "unitSP": 1,
  "PPx1": 1,
  "PPxM": 1,
  "PPxY": 1,
  "SPx1": 1,
  "SPxM": 1,
  "SPxY": 1,
  "LPx1": 1,
  "LPxM": 1,
  "LPxY": 1,
  "priceList": {
    "id": "text",
    "currency": "text"
  },
  "item": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "vendor": "text",
      "operations": "text"
    }
  }
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-12-14T07:59:46.564Z",
      "by": {}
    },
    "updated": {
      "at": "2025-12-14T07:59:46.564Z",
      "by": {}
    },
    "published": {
      "at": "2025-12-14T07:59:46.564Z",
      "by": {}
    },
    "unpublished": {
      "at": "2025-12-14T07:59:46.564Z",
      "by": {}
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "status": "Draft",
  "description": "text",
  "reasonForChange": "text",
  "unitLP": 1,
  "unitPP": 1,
  "markup": 1,
  "margin": 1,
  "unitSP": 1,
  "PPx1": 1,
  "PPxM": 1,
  "PPxY": 1,
  "SPx1": 1,
  "SPxM": 1,
  "SPxY": 1,
  "LPx1": 1,
  "LPxM": 1,
  "LPxY": 1,
  "priceList": {
    "id": "text",
    "currency": "text"
  },
  "item": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "vendor": "text",
      "operations": "text"
    }
  }
}
PUT /public/v1/catalog/price-lists/{priceListId}/items/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "status": "text",
  "reasonForChange": "text",
  "description": "text",
  "unitPP": 1,
  "unitLP": 1,
  "unitSP": 1,
  "markup": 1
}