Optimizely

Optimizely Punch Out Setup Requests API

The Punch Out Setup Requests API from Optimizely — 5 operation(s) for punch out setup requests.

GitHub OpenAPI

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/PunchOutSetupRequests List PunchOut setup requests · Returns the EntitySet PunchOutSetupRequests #
Ask an LLM
“Which cXML PunchOut setup requests have procurement systems sent to my store?”
“Can I filter PunchOut setup requests by the IP address they came from?”
Tell an agent
List all PunchOut setup requests.
Find PunchOut setup requests matching {filter}, newest first by {orderby}.
POST /api/v1/admin/PunchOutSetupRequests Record a PunchOut setup request · Post a new entity to EntitySet PunchOutSetupRequests #
Ask an LLM
“How do I store a new cXML PunchOut setup request with its response?”
“Can I log which PunchOut session and IP a setup request belongs to?”
Tell an agent
Record a PunchOut setup request from IP {ipAddress} with cXML {punchOutSetupRequestCXml} and response {setupRequestResponse}.
Log a setup request for PunchOut session {punchOutSessionId}.
GET /api/v1/admin/PunchOutSetupRequests({id}) Get one PunchOut setup request · Returns the entity with the key from PunchOutSetupRequests #
Ask an LLM
“What cXML and response were recorded for a specific PunchOut setup request?”
“How do I look up a single PunchOut setup request by ID?”
Tell an agent
Get PunchOut setup request {id}.
Show the cXML of PunchOut setup request {id}.
PUT /api/v1/admin/PunchOutSetupRequests({id}) Replace a PunchOut setup request record · Replace entity in EntitySet PunchOutSetupRequests #
Ask an LLM
“How do I overwrite a stored PunchOut setup request entirely?”
“Can I fully replace the cXML and response saved for a setup request?”
Tell an agent
Replace PunchOut setup request {id} with cXML {punchOutSetupRequestCXml}.
Overwrite the whole PunchOut setup request record {id}.
DELETE /api/v1/admin/PunchOutSetupRequests({id}) Delete a PunchOut setup request · Delete entity in EntitySet PunchOutSetupRequests #
Ask an LLM
“How do I remove one logged PunchOut setup request?”
“Can I delete a setup request only if its ETag still matches?”
Tell an agent destructive · confirm first
Delete PunchOut setup request {id}.
Delete setup request {id} if the ETag is {ifMatch}.
PATCH /api/v1/admin/PunchOutSetupRequests({id}) Partially update a PunchOut setup request · Update entity in EntitySet PunchOutSetupRequests #
Ask an LLM
“Can I change only the response stored on a PunchOut setup request?”
“How do I attach a setup request to a different PunchOut session?”
Tell an agent
Update the response of setup request {id} to {setupRequestResponse}.
Link setup request {id} to PunchOut session {punchOutSessionId}.
GET /api/v1/admin/PunchOutSetupRequests/Default.Default() Get the default PunchOut setup request template · Call operation Default #
Ask an LLM
“What default values does a new PunchOut setup request record start with?”
“Is there a blank PunchOut setup request template?”
Tell an agent
Fetch the default PunchOut setup request template.
Get default values for a new setup request record.
DELETE /api/v1/admin/punchoutsetuprequests/delete Bulk delete PunchOut setup requests · Punch out setup requests delete route #
Ask an LLM
“How do I purge many PunchOut setup requests in one call?”
“Can I delete several setup requests by listing their IDs?”
Tell an agent destructive · confirm first
Bulk delete PunchOut setup requests {ids}.
Remove all these setup requests at once: {ids}.
GET /api/v1/admin/punchoutsetuprequests({key})/customproperties({custompropertyKey}) Get a custom property of a PunchOut setup request · Punch out setup requests get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property on a PunchOut setup request?”
“Can I fetch one custom field from a setup request record?”
Tell an agent
Get custom property {custompropertyKey} of setup request {key}.
Show custom field {custompropertyKey} on PunchOut setup request {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-punch-out-setup-requests-api-openapi.yml

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-punch-out-setup-requests-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.

GitHub Google LinkedIn

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

OpenAPI Specification

optimizely-punch-out-setup-requests-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Punch Out Setup Requests API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Punch Out Setup Requests
paths:
  /api/v1/admin/PunchOutSetupRequests:
    get:
      tags:
      - Punch Out Setup Requests
      summary: Returns the EntitySet PunchOutSetupRequests
      operationId: PunchOutSetupRequests_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:
      - Punch Out Setup Requests
      summary: Post a new entity to EntitySet PunchOutSetupRequests
      operationId: PunchOutSetupRequests_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PunchOutSetupRequest'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PunchOutSetupRequests({id}):
    get:
      tags:
      - Punch Out Setup Requests
      summary: Returns the entity with the key from PunchOutSetupRequests
      operationId: PunchOutSetupRequests_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:
      - Punch Out Setup Requests
      summary: Replace entity in EntitySet PunchOutSetupRequests
      operationId: PunchOutSetupRequests_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.PunchOutSetupRequest'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Punch Out Setup Requests
      summary: Delete entity in EntitySet PunchOutSetupRequests
      operationId: PunchOutSetupRequests_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:
      - Punch Out Setup Requests
      summary: Update entity in EntitySet PunchOutSetupRequests
      operationId: PunchOutSetupRequests_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.PunchOutSetupRequest'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PunchOutSetupRequests/Default.Default():
    get:
      tags:
      - Punch Out Setup Requests
      summary: Call operation Default
      operationId: PunchOutSetupRequests_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/punchoutsetuprequests/delete:
    delete:
      tags:
      - Punch Out Setup Requests
      operationId: PunchOutSetupRequests_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: Punch out setup requests delete route
      x-summary-source: derived
  /api/v1/admin/punchoutsetuprequests({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Punch Out Setup Requests
      operationId: PunchOutSetupRequests_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: Punch out setup requests get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.PunchOutSetupRequest:
      required:
      - punchOutSetupRequestCXml
      - ipAddress
      - setupRequestResponse
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        punchOutSetupRequestCXml:
          type: string
        punchOutSessionId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        ipAddress:
          maxLength: 50
          minLength: 0
          type: string
        setupRequestResponse:
          type: string
        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