Optimizely

Optimizely Punch Out Order Request Messages API

The Punch Out Order Request Messages API from Optimizely — 5 operation(s) for punch out order request messages.

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/PunchOutOrderRequestMessages List punchout order validation messages · Returns the EntitySet PunchOutOrderRequestMessages #
Ask an LLM
“What validation errors and warnings were logged for punchout orders?”
“Can I filter punchout validation messages by message type?”
Tell an agent
List all punchout order validation messages.
Find punchout validation messages matching {filter}.
POST /api/v1/admin/PunchOutOrderRequestMessages Log a punchout order validation message · Post a new entity to EntitySet PunchOutOrderRequestMessages #
Ask an LLM
“How do I record a validation warning against a punchout order request?”
“Can I attach a validation message to one specific item line of a punchout order?”
Tell an agent
Log a {validationMessageType} message {message} on punchout order request {punchOutOrderRequestId}.
Record validation message {message} of type {validationMessageType} against punchout item line {punchOutOrderRequestItemOutId}.
GET /api/v1/admin/PunchOutOrderRequestMessages({id}) Get a punchout validation message by ID · Returns the entity with the key from PunchOutOrderRequestMessages #
Ask an LLM
“What does a particular punchout validation message say?”
“Which punchout order does a given validation message ID belong to?”
Tell an agent
Get punchout validation message record {id}.
Show the text and type of punchout message {id}.
PUT /api/v1/admin/PunchOutOrderRequestMessages({id}) Replace a punchout validation message · Replace entity in EntitySet PunchOutOrderRequestMessages #
Ask an LLM
“How do I overwrite a punchout validation message record in full?”
“Does replacing a punchout message drop its item link if I omit it?”
Tell an agent
Replace punchout message {id} with type {validationMessageType} and text {message}.
Overwrite punchout validation message {id} in full, linking order request {punchOutOrderRequestId}.
DELETE /api/v1/admin/PunchOutOrderRequestMessages({id}) Delete a punchout validation message · Delete entity in EntitySet PunchOutOrderRequestMessages #
Ask an LLM
“How do I clear one punchout validation message once it is resolved?”
“Can deleting a punchout message be conditional on its ETag?”
Tell an agent destructive · confirm first
Delete punchout validation message {id}.
Delete punchout message {id} only if its ETag is {etag}.
PATCH /api/v1/admin/PunchOutOrderRequestMessages({id}) Update a punchout validation message · Update entity in EntitySet PunchOutOrderRequestMessages #
Ask an LLM
“Can I change just the wording of a punchout validation message?”
“How do I downgrade a punchout message from error to warning?”
Tell an agent
Change the text of punchout message {id} to {message}.
Set the validation type of punchout message {id} to {validationMessageType}.
GET /api/v1/admin/PunchOutOrderRequestMessages/Default.Default() Get a blank punchout message template · Call operation Default #
Ask an LLM
“What default values does a new punchout validation message start with?”
“Is there an empty punchout message template I can fetch?”
Tell an agent
Fetch the default punchout validation message template.
Show default field values for a new punchout message.
DELETE /api/v1/admin/punchoutorderrequestmessages/delete Bulk delete punchout validation messages · Punch out order request messages delete route #
Ask an LLM
“How do I clear many punchout validation messages in one go?”
“Can I delete a list of punchout messages by ID?”
Tell an agent destructive · confirm first
Bulk delete punchout validation messages {ids}.
Remove these punchout messages together: {ids}.
GET /api/v1/admin/punchoutorderrequestmessages({key})/customproperties({custompropertyKey}) Get a custom property on a punchout message · Punch out order request messages get custom property by key and… #
Ask an LLM
“What value is stored in a custom property on a punchout validation message?”
“Can I read one custom property of a punchout message record?”
Tell an agent
Get custom property {custompropertyKey} on punchout message {key}.
Show punchout validation message {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-punch-out-order-request-messages-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-order-request-messages-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-order-request-messages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Punch Out Order Request Messages API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Punch Out Order Request Messages
paths:
  /api/v1/admin/PunchOutOrderRequestMessages:
    get:
      tags:
      - Punch Out Order Request Messages
      summary: Returns the EntitySet PunchOutOrderRequestMessages
      operationId: PunchOutOrderRequestMessages_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 Order Request Messages
      summary: Post a new entity to EntitySet PunchOutOrderRequestMessages
      operationId: PunchOutOrderRequestMessages_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PunchOutOrderRequestMessage'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PunchOutOrderRequestMessages({id}):
    get:
      tags:
      - Punch Out Order Request Messages
      summary: Returns the entity with the key from PunchOutOrderRequestMessages
      operationId: PunchOutOrderRequestMessages_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 Order Request Messages
      summary: Replace entity in EntitySet PunchOutOrderRequestMessages
      operationId: PunchOutOrderRequestMessages_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.PunchOutOrderRequestMessage'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Punch Out Order Request Messages
      summary: Delete entity in EntitySet PunchOutOrderRequestMessages
      operationId: PunchOutOrderRequestMessages_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 Order Request Messages
      summary: Update entity in EntitySet PunchOutOrderRequestMessages
      operationId: PunchOutOrderRequestMessages_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.PunchOutOrderRequestMessage'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PunchOutOrderRequestMessages/Default.Default():
    get:
      tags:
      - Punch Out Order Request Messages
      summary: Call operation Default
      operationId: PunchOutOrderRequestMessages_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/punchoutorderrequestmessages/delete:
    delete:
      tags:
      - Punch Out Order Request Messages
      operationId: PunchOutOrderRequestMessages_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 order request messages delete route
      x-summary-source: derived
  /api/v1/admin/punchoutorderrequestmessages({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Punch Out Order Request Messages
      operationId: PunchOutOrderRequestMessages_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 order request messages get custom property by key and…
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.PunchOutOrderRequestMessage:
      required:
      - validationMessageType
      - message
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        validationMessageType:
          maxLength: 128
          minLength: 0
          type: string
        message:
          type: string
        punchOutOrderRequestId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        punchOutOrderRequestItemOutId:
          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