Optimizely Restriction Group Products API

The Restriction Group Products API from Optimizely — 5 operation(s) for restriction group products.

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/RestrictionGroupProducts List products in restriction groups · Returns the EntitySet RestrictionGroupProducts #
Ask an LLM
“Which products are covered by our product restriction groups?”
“Can I filter restricted products to a single restriction group?”
Tell an agent
List all restriction group products.
List restriction group products where {filter}.
POST /api/v1/admin/RestrictionGroupProducts Add a product to a restriction group · Post a new entity to EntitySet RestrictionGroupProducts #
Ask an LLM
“How do I restrict who can buy a product by adding it to a restriction group?”
“Can I put a product into a restriction group through the admin API?”
Tell an agent
Add product {productId} to restriction group {restrictionGroupId}.
Restrict product {productId} under group {restrictionGroupId}.
GET /api/v1/admin/RestrictionGroupProducts({id}) Get a restriction group product entry · Returns the entity with the key from RestrictionGroupProducts #
Ask an LLM
“Which product and restriction group does a given entry link?”
“Can I fetch one restriction group product record by its id?”
Tell an agent
Get restriction group product {id}.
Show the product and group on restriction entry {id}.
PUT /api/v1/admin/RestrictionGroupProducts({id}) Replace a restriction group product entry · Replace entity in EntitySet RestrictionGroupProducts #
Ask an LLM
“Can I rewrite a restriction group product entry in full?”
“Does a full replace of a restricted product entry clear fields I omit?”
Tell an agent
Replace restriction entry {id} with product {productId} in group {restrictionGroupId}.
Overwrite the complete restriction group product record {id}.
DELETE /api/v1/admin/RestrictionGroupProducts({id}) Remove a product from a restriction group · Delete entity in EntitySet RestrictionGroupProducts #
Ask an LLM
“How do I lift a restriction on a product by removing it from its group?”
“Can I make the removal conditional on an ETag?”
Tell an agent destructive · confirm first
Delete restriction group product {id}.
Remove restriction entry {id} only if its ETag is {etag}.
PATCH /api/v1/admin/RestrictionGroupProducts({id}) Move a restricted product to another group · Update entity in EntitySet RestrictionGroupProducts #
Ask an LLM
“Can I move a restricted product into a different restriction group?”
“Is a partial update supported on restriction group product entries?”
Tell an agent
Move restriction entry {id} to group {restrictionGroupId}.
Patch restriction entry {id} to cover product {productId}.
GET /api/v1/admin/RestrictionGroupProducts/Default.Default() Call the restriction group products Default function · Call operation Default #
Ask an LLM
“What does the Default function on restriction group products return?”
“Is there a default restricted product entry?”
Tell an agent
Call the Default function on restriction group products.
Fetch the default restriction group product result.
DELETE /api/v1/admin/restrictiongroupproducts/delete Bulk remove products from restriction groups · Restriction group products delete route #
Ask an LLM
“Can I unrestrict many products at once by deleting their entries?”
“Is there a bulk delete by id list for restriction group products?”
Tell an agent destructive · confirm first
Delete restriction group products {ids}.
Bulk remove the restriction entries with ids {ids}.
GET /api/v1/admin/restrictiongroupproducts({key})/customproperties({custompropertyKey}) Get a custom property of a restricted product entry · Restriction group products get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a restriction group product?”
“Where is a custom value for a restricted product entry kept?”
Tell an agent
Get custom property {custompropertyKey} of restriction group product {key}.
Show custom value {custompropertyKey} on restriction entry {key}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/optimizely:optimizely-restriction-group-products-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-restriction-group-products-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Restriction Group Products API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Restriction Group Products
paths:
  /api/v1/admin/RestrictionGroupProducts:
    get:
      tags:
      - Restriction Group Products
      summary: Returns the EntitySet RestrictionGroupProducts
      operationId: RestrictionGroupProducts_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Restriction Group Products
      summary: Post a new entity to EntitySet RestrictionGroupProducts
      operationId: RestrictionGroupProducts_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.RestrictionGroupProduct'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RestrictionGroupProducts({id}):
    get:
      tags:
      - Restriction Group Products
      summary: Returns the entity with the key from RestrictionGroupProducts
      operationId: RestrictionGroupProducts_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Restriction Group Products
      summary: Replace entity in EntitySet RestrictionGroupProducts
      operationId: RestrictionGroupProducts_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.RestrictionGroupProduct'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Restriction Group Products
      summary: Delete entity in EntitySet RestrictionGroupProducts
      operationId: RestrictionGroupProducts_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Restriction Group Products
      summary: Update entity in EntitySet RestrictionGroupProducts
      operationId: RestrictionGroupProducts_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.RestrictionGroupProduct'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RestrictionGroupProducts/Default.Default():
    get:
      tags:
      - Restriction Group Products
      summary: Call operation Default
      operationId: RestrictionGroupProducts_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/restrictiongroupproducts/delete:
    delete:
      tags:
      - Restriction Group Products
      operationId: RestrictionGroupProducts_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Restriction group products delete route
      x-summary-source: derived
  /api/v1/admin/restrictiongroupproducts({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Restriction Group Products
      operationId: RestrictionGroupProducts_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Restriction group products get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.RestrictionGroupProduct:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        restrictionGroupId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query