Get Pricelist

Retrieve a price list using its ID.

get

Path parameters

idstringRequired

Query parameters

selectstringOptional

Responses

200

OK

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /public/v1/catalog/price-lists/{id} HTTP/1.1
Host: api.s1.today
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-09-17T12:28:40.964Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2025-09-17T12:28:40.964Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "currency": "text",
  "precision": 1,
  "defaultMarkup": 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",
    "audit": {
      "created": {
        "at": "2025-09-17T12:28:40.964Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2025-09-17T12:28:40.964Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "published": {
        "at": "2025-09-17T12:28:40.964Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "pending": {
        "at": "2025-09-17T12:28:40.964Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "unpublished": {
        "at": "2025-09-17T12:28:40.964Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "shortDescription": "text",
    "longDescription": "text",
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "website": "text",
    "status": "text",
    "vendor": {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active"
    },
    "settings": {
      "productOrdering": true,
      "productRequests": {
        "enabled": true,
        "name": "text",
        "label": "text"
      },
      "itemSelection": true,
      "orderQueueChanges": true,
      "preValidation": {
        "purchaseOrderDraft": true,
        "purchaseOrderQuerying": true,
        "changeOrderDraft": true,
        "configurationOrderDraft": true,
        "terminationOrder": true,
        "productRequest": true
      },
      "splitBilling": {
        "enabled": true,
        "type": "text"
      },
      "subscriptionCessation": {
        "enabled": true,
        "mode": "Termination"
      }
    },
    "statistics": {
      "itemCount": 1,
      "ordersPlacedCount": 1,
      "agreementCount": 1,
      "subscriptionCount": 1,
      "requestCount": 1
    }
  },
  "vendor": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-09-17T12:28:40.964Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2025-09-17T12:28:40.964Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "[email protected]",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "revision": 1,
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    }
  }
}