Runtime API Examples

This page demonstrates usage of some of the runtime APIs provided by VitePress.

The main useData() API can be used to access site, theme, and page data for the current page. It works in both .md and .vue files:

<script setup>
import { useData } from 'vitepress'

const { theme, page, frontmatter } = useData()
</script>

## Results

### Theme Data
<pre>{{ theme }}</pre>

### Page Data
<pre>{{ page }}</pre>

### Page Frontmatter
<pre>{{ frontmatter }}</pre>

Results

Theme Data

{
  "nav": [
    {
      "text": "Home",
      "link": "/"
    },
    {
      "text": "Getting Started",
      "link": "/getting-started"
    },
    {
      "text": "API Reference",
      "link": "/operations/"
    }
  ],
  "sidebar": [
    {
      "text": "Guide",
      "items": [
        {
          "text": "Getting Started",
          "link": "/getting-started"
        },
        {
          "text": "Authentication",
          "link": "/authentication"
        },
        {
          "text": "Channels",
          "link": "/channels"
        },
        {
          "text": "Errors",
          "link": "/errors"
        }
      ]
    },
    {
      "text": "Channel API",
      "items": [
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find all channels</span> </span>",
          "link": "/operations/ChannelApiController_findAll[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Create new channel</span> </span>",
          "link": "/operations/ChannelApiController_create[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get all active channels</span> </span>",
          "link": "/operations/ChannelApiController_findActive[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get channel by code</span> </span>",
          "link": "/operations/ChannelApiController_findOne[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span> <span class=\"OASidebarItem-text text\">Delete channel</span> </span>",
          "link": "/operations/ChannelApiController_remove[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--patch\">PATCH</span> <span class=\"OASidebarItem-text text\">Update channel</span> </span>",
          "link": "/operations/ChannelApiController_update[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customer groups assigned to channel</span> </span>",
          "link": "/operations/ChannelApiController_findChannelCustomerGroups[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get trade conditions assigned to channel</span> </span>",
          "link": "/operations/ChannelApiController_findChannelTradeConditions[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get promotions assigned to channel</span> </span>",
          "link": "/operations/ChannelApiController_findChannelPromotions[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get pricelist assigned to channel</span> </span>",
          "link": "/operations/ChannelApiController_findChannelPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Assign pricelist to channel</span> </span>",
          "link": "/operations/ChannelApiController_assignPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customers assigned to channel (direct and via group)</span> </span>",
          "link": "/operations/ChannelApiController_findChannelCustomers[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span> <span class=\"OASidebarItem-text text\">Set primary pricelist for channel (auto-assigns if not yet assigned)</span> </span>",
          "link": "/operations/ChannelApiController_setPrimaryPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span> <span class=\"OASidebarItem-text text\">Remove primary pricelist flag from channel</span> </span>",
          "link": "/operations/ChannelApiController_removePrimaryPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span> <span class=\"OASidebarItem-text text\">Unassign pricelist from channel</span> </span>",
          "link": "/operations/ChannelApiController_unassignPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Bulk assign customers to channel by code</span> </span>",
          "link": "/operations/ChannelApiController_assignCustomers[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Bulk unassign customers from channel by code</span> </span>",
          "link": "/operations/ChannelApiController_unassignCustomers[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Bulk assign customer groups to channel by code</span> </span>",
          "link": "/operations/ChannelApiController_assignCustomerGroups[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Bulk unassign customer groups from channel by code</span> </span>",
          "link": "/operations/ChannelApiController_unassignCustomerGroups[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Assign trade condition to channel</span> </span>",
          "link": "/operations/ChannelApiController_assignTradeCondition[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span> <span class=\"OASidebarItem-text text\">Unassign trade condition from channel</span> </span>",
          "link": "/operations/ChannelApiController_unassignTradeCondition[1]_v1"
        }
      ],
      "collapsed": true
    },
    {
      "text": "Customer API",
      "items": [
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find all customers</span> </span>",
          "link": "/operations/CustomerApiController_findAll[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Create new customer</span> </span>",
          "link": "/operations/CustomerApiController_create[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customer by code</span> </span>",
          "link": "/operations/CustomerApiController_findOne[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span> <span class=\"OASidebarItem-text text\">Delete customer</span> </span>",
          "link": "/operations/CustomerApiController_remove[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--patch\">PATCH</span> <span class=\"OASidebarItem-text text\">Update customer</span> </span>",
          "link": "/operations/CustomerApiController_update[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customer trade conditions</span> </span>",
          "link": "/operations/CustomerApiController_findTradeConditions[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customer individual pricelist</span> </span>",
          "link": "/operations/CustomerApiController_getIndividualPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customer assigned pricelist</span> </span>",
          "link": "/operations/CustomerApiController_getPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Assign pricelist to customer</span> </span>",
          "link": "/operations/CustomerApiController_assignPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customer price and their base prices</span> </span>",
          "link": "/operations/CustomerApiController_getPrices[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get products and their catalog prices (included promotions)</span> </span>",
          "link": "/operations/CustomerApiController_getCatalogPrices[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get promotions by code</span> </span>",
          "link": "/operations/CustomerApiController_getPromotions[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get available channels for customer</span> </span>",
          "link": "/operations/CustomerApiController_getChannels[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Unassign pricelist from customer</span> </span>",
          "link": "/operations/CustomerApiController_unassignPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Assign trade condition to customer</span> </span>",
          "link": "/operations/CustomerApiController_assignTradeCondition[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Unassign trade condition from customer</span> </span>",
          "link": "/operations/CustomerApiController_unassignTradeCondition[1]_v1"
        }
      ],
      "collapsed": true
    },
    {
      "text": "Customer Group API",
      "items": [
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find all customer groups</span> </span>",
          "link": "/operations/CustomerGroupApiController_findAll[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Create new customer group</span> </span>",
          "link": "/operations/CustomerGroupApiController_create[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customer group by code</span> </span>",
          "link": "/operations/CustomerGroupApiController_findOne[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span> <span class=\"OASidebarItem-text text\">Delete customer group</span> </span>",
          "link": "/operations/CustomerGroupApiController_remove[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--patch\">PATCH</span> <span class=\"OASidebarItem-text text\">Update customer group</span> </span>",
          "link": "/operations/CustomerGroupApiController_update[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customer group trade conditions</span> </span>",
          "link": "/operations/CustomerGroupApiController_findTradeConditions[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customer group pricelist</span> </span>",
          "link": "/operations/CustomerGroupApiController_getPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Assign pricelist to customer group</span> </span>",
          "link": "/operations/CustomerGroupApiController_assignPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Unassign pricelist from customer group</span> </span>",
          "link": "/operations/CustomerGroupApiController_unassignPricelist[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Assign trade condition to customer group</span> </span>",
          "link": "/operations/CustomerGroupApiController_assignTradeCondition[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Unassign trade condition from customer group</span> </span>",
          "link": "/operations/CustomerGroupApiController_unassignTradeCondition[1]_v1"
        }
      ],
      "collapsed": true
    },
    {
      "text": "Promotion API",
      "items": [
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get promotion list</span> </span>",
          "link": "/operations/PromotionApiController_findAll[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get active promotion list for SKUS/Customer</span> </span>",
          "link": "/operations/active"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get promotion by ID</span> </span>",
          "link": "/operations/PromotionApiController_findOne[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get catalog prices</span> </span>",
          "link": "/operations/getCatalogPricesV1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Get catalog prices</span> </span>",
          "link": "/operations/postCatalogPrices"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Get cart prices</span> </span>",
          "link": "/operations/cartV1"
        }
      ],
      "collapsed": true
    },
    {
      "text": "Product API",
      "items": [
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get products list</span> </span>",
          "link": "/operations/ProductsApiController_listProducts[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">List all products (paginated, searchable by code)</span> </span>",
          "link": "/operations/ProductApiController_findAll[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Create a new product</span> </span>",
          "link": "/operations/ProductApiController_create[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get a product by code (includes attributes and categories)</span> </span>",
          "link": "/operations/ProductApiController_findOne[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span> <span class=\"OASidebarItem-text text\">Delete a product and all related pricing data</span> </span>",
          "link": "/operations/ProductApiController_remove[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--patch\">PATCH</span> <span class=\"OASidebarItem-text text\">Partially update a product (code is immutable)</span> </span>",
          "link": "/operations/ProductApiController_update[1]_v1"
        }
      ],
      "collapsed": true
    },
    {
      "text": "Pricelist API",
      "items": [
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find all pricelists</span> </span>",
          "link": "/operations/PricelistApiController_findAll[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Create a new standard pricelist</span> </span>",
          "link": "/operations/PricelistApiController_create[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find all regular pricelist</span> </span>",
          "link": "/operations/PricelistApiController_findAllRegular[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find all pricelist with customer scope</span> </span>",
          "link": "/operations/PricelistApiController_findAllCustomer[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Create an individual pricelist for a customer</span> </span>",
          "link": "/operations/PricelistApiController_createIndividual[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get a pricelist by ID</span> </span>",
          "link": "/operations/PricelistApiController_find[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span> <span class=\"OASidebarItem-text text\">Delete a DRAFT pricelist</span> </span>",
          "link": "/operations/PricelistApiController_remove[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--patch\">PATCH</span> <span class=\"OASidebarItem-text text\">Partially update a pricelist</span> </span>",
          "link": "/operations/PricelistApiController_update[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get pricelist prices</span> </span>",
          "link": "/operations/PricelistApiController_findAllPrices[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--put\">PUT</span> <span class=\"OASidebarItem-text text\">Strict upsert: all productCodes must exist or request fails with 400</span> </span>",
          "link": "/operations/PricelistApiController_upsertPrices[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--patch\">PATCH</span> <span class=\"OASidebarItem-text text\">Tolerant upsert: unknown productCodes are skipped, rest are saved</span> </span>",
          "link": "/operations/PricelistApiController_tolerantUpsertPrices[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span> <span class=\"OASidebarItem-text text\">Delete an individual (DRAFT) pricelist</span> </span>",
          "link": "/operations/PricelistApiController_removeIndividual[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customers assigned to pricelist</span> </span>",
          "link": "/operations/PricelistApiController_findCustomers[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Assign customers to a pricelist</span> </span>",
          "link": "/operations/PricelistApiController_assignCustomers[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get customer groups assigned to pricelist</span> </span>",
          "link": "/operations/PricelistApiController_findCustomerGroups[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Assign customer groups to a pricelist</span> </span>",
          "link": "/operations/PricelistApiController_assignCustomerGroups[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Unassign customers from a pricelist</span> </span>",
          "link": "/operations/PricelistApiController_unassignCustomers[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Unassign customer groups from a pricelist</span> </span>",
          "link": "/operations/PricelistApiController_unassignCustomerGroups[1]_v1"
        }
      ],
      "collapsed": true
    },
    {
      "text": "Supplier Pricelist API",
      "items": [
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find all supplier pricelists</span> </span>",
          "link": "/operations/SupplierPricelistApiController_findAll[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find single supplier pricelist</span> </span>",
          "link": "/operations/SupplierPricelistApiController_findOne[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Get supplier pricelist products</span> </span>",
          "link": "/operations/SupplierPricelistApiController_findAllPrices[1]_v1"
        }
      ],
      "collapsed": true
    },
    {
      "text": "Trade Conditions API",
      "items": [
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find all trade conditions</span> </span>",
          "link": "/operations/TradeConditionApiController_findAll[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Create trade condition</span> </span>",
          "link": "/operations/TradeConditionApiController_create[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find single trade condition</span> </span>",
          "link": "/operations/TradeConditionApiController_findOne[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--delete\">DELETE</span> <span class=\"OASidebarItem-text text\">Delete trade condition</span> </span>",
          "link": "/operations/TradeConditionApiController_delete[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--patch\">PATCH</span> <span class=\"OASidebarItem-text text\">Partial update trade condition</span> </span>",
          "link": "/operations/TradeConditionApiController_update[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Assign customers to trade condition</span> </span>",
          "link": "/operations/TradeConditionApiController_assignCustomers[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Unassign customers from trade condition</span> </span>",
          "link": "/operations/TradeConditionApiController_unassignCustomers[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Assign customer groups to trade condition</span> </span>",
          "link": "/operations/TradeConditionApiController_assignCustomerGroups[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--post\">POST</span> <span class=\"OASidebarItem-text text\">Unassign customer groups from trade condition</span> </span>",
          "link": "/operations/TradeConditionApiController_unassignCustomerGroups[1]_v1"
        },
        {
          "text": "<span class=\"OASidebarItem group/oaOperationLink\"> <span class=\"OASidebarItem-badge OAMethodBadge--get\">GET</span> <span class=\"OASidebarItem-text text\">Find products assigned to a trade condition</span> </span>",
          "link": "/operations/TradeConditionApiController_findProducts[1]_v1"
        }
      ],
      "collapsed": true
    },
    null
  ]
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "api-examples.md",
  "filePath": "api-examples.md"
}

Page Frontmatter

{
  "outline": "deep"
}

More

Check out the documentation for the full list of runtime APIs.