All pages
Powered by GitBook
1 of 1

Loading...

List pricelists

Retrieve a list of all price lists.

get
Responses
200

OK

application/json
offsetinteger · int32Optional
limitinteger · int32Optional
totalinteger · int32 · nullableOptional
omittedstring[]Optional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
revisioninteger · int32Optional
currencystringOptional
precisioninteger · int32Optional
defaultMarkupnumber · doubleOptional
defaultMarginnumber · doubleOptional
notesstring · nullableOptional
vendorstring · nullableOptional
sellersinteger · int32Optional
listingsinteger · int32Optional
priceListItemsinteger · int32Optional
purchasePriceItemsinteger · int32Optional
purchasePriceCompletenessinteger · int32Optional
salesPriceItemsinteger · int32Optional
salesPriceCompletenessinteger · int32Optional
averageMarkupnumber · doubleOptional
averageMarginnumber · doubleOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
operationsstring · nullableOptional
defaultErpItemstring · nullableOptional
statusstringOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
get/public/v1/catalog/price-lists
GET /public/v1/catalog/price-lists HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "revision": 1,
      "currency": "text",
      "precision": 1,
      "defaultMarkup": 1,
      "defaultMargin": 1,
      "notes": "text",
      "externalIds": {
        "vendor": "text"
      },
      "statistics": {
        "sellers": 1,
        "listings": 1,
        "priceListItems": 1,
        "purchasePriceItems": 1,
        "purchasePriceCompleteness": 1,
        "salesPriceItems": 1,
        "salesPriceCompleteness": 1,
        "averageMarkup": 1,
        "averageMargin": 1
      },
      "product": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "externalIds": {
          "operations": "text",
          "defaultErpItem": "text"
        },
        "status": "text"
      },
      "vendor": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      }
    }
  ]
}