openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Punch Out Sessions API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Punch Out Sessions
paths:
  /api/v1/admin/PunchOutSessions:
    get:
      tags:
      - Punch Out Sessions
      summary: Returns the EntitySet PunchOutSessions
      operationId: PunchOutSessions_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 Sessions
      summary: Post a new entity to EntitySet PunchOutSessions
      operationId: PunchOutSessions_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PunchOutSession'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PunchOutSessions({id}):
    get:
      tags:
      - Punch Out Sessions
      summary: Returns the entity with the key from PunchOutSessions
      operationId: PunchOutSessions_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 Sessions
      summary: Replace entity in EntitySet PunchOutSessions
      operationId: PunchOutSessions_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.PunchOutSession'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Punch Out Sessions
      summary: Delete entity in EntitySet PunchOutSessions
      operationId: PunchOutSessions_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 Sessions
      summary: Update entity in EntitySet PunchOutSessions
      operationId: PunchOutSessions_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.PunchOutSession'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PunchOutSessions/Default.Default():
    get:
      tags:
      - Punch Out Sessions
      summary: Call operation  Default
      operationId: PunchOutSessions_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/punchoutsessions/delete:
    delete:
      tags:
      - Punch Out Sessions
      operationId: PunchOutSessions_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: []
  /api/v1/admin/punchoutsessions({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Punch Out Sessions
      operationId: PunchOutSessions_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: []
  /api/v1/admin/punchoutsessions({key})/punchoutorderrequests({punchoutorderrequestKey}):
    get:
      tags:
      - Punch Out Sessions
      operationId: PunchOutSessions_GetPunchOutOrderRequestByKeyAndPunchoutorderrequestkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: punchoutorderrequestKey
        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: []
  /api/v1/admin/punchoutsessions({key})/punchoutsessionaccesses({punchoutsessionaccessKey}):
    get:
      tags:
      - Punch Out Sessions
      operationId: PunchOutSessions_GetPunchOutSessionAccessByKeyAndPunchoutsessionaccesskey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: punchoutsessionaccessKey
        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: []
  /api/v1/admin/punchoutsessions({key})/punchoutsessionextrinsics({punchoutsessionextrinsicKey}):
    get:
      tags:
      - Punch Out Sessions
      operationId: PunchOutSessions_GetPunchOutSessionExtrinsicByKeyAndPunchoutsessionextrinsickey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: punchoutsessionextrinsicKey
        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: []
  /api/v1/admin/punchoutsessions({key})/punchoutsessionitemins({punchoutsessioniteminKey}):
    get:
      tags:
      - Punch Out Sessions
      operationId: PunchOutSessions_GetPunchOutSessionItemInByKeyAndPunchoutsessioniteminkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: punchoutsessioniteminKey
        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: []
  /api/v1/admin/punchoutsessions({key})/punchoutsetuprequests({punchoutsetuprequestKey}):
    get:
      tags:
      - Punch Out Sessions
      operationId: PunchOutSessions_GetPunchOutSetupRequestByKeyAndPunchoutsetuprequestkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: punchoutsetuprequestKey
        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: []
components:
  schemas:
    Insite.Data.Entities.PunchOutSession:
      required:
      - fromIdentity
      - toIdentity
      - senderIdentity
      - fromUserAgent
      - buyerCookie
      - browserFormPost
      - domain
      - punchOutSessionMode
      - toIdentityNode
      - fromIdentityNode
      - senderIdentityNode
      - shipToAddressId
      - shipToName
      - shipToDeliverTo
      - shipToStreet
      - shipToCity
      - shipToState
      - shipToPostalCode
      - shipToIsoCountryCode
      - shipToCountry
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        userProfileId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerOrderId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        fromIdentity:
          maxLength: 255
          minLength: 0
          type: string
        toIdentity:
          maxLength: 255
          minLength: 0
          type: string
        senderIdentity:
          maxLength: 255
          minLength: 0
          type: string
        fromUserAgent:
          maxLength: 255
          minLength: 0
          type: string
        buyerCookie:
          maxLength: 255
          minLength: 0
          type: string
        browserFormPost:
          maxLength: 1024
          minLength: 0
          type: string
        domain:
          maxLength: 1024
          minLength: 0
          type: string
        punchOutSessionMode:
          maxLength: 50
          minLength: 0
          type: string
        toIdentityNode:
          maxLength: 1024
          minLength: 0
          type: string
        fromIdentityNode:
          maxLength: 1024
          minLength: 0
          type: string
        senderIdentityNode:
          maxLength: 1024
          minLength: 0
          type: string
        shipToAddressId:
          maxLength: 1024
          minLength: 0
          type: string
        shipToName:
          maxLength: 1024
          minLength: 0
          type: string
        shipToDeliverTo:
          maxLength: 1024
          minLength: 0
          type: string
        shipToStreet:
          maxLength: 1024
          minLength: 0
          type: string
        shipToCity:
          maxLength: 1024
          minLength: 0
          type: string
        shipToState:
          maxLength: 1024
          minLength: 0
          type: string
        shipToPostalCode:
          maxLength: 1024
          minLength: 0
          type: string
        shipToIsoCountryCode:
          maxLength: 1024
          minLength: 0
          type: string
        shipToCountry:
          maxLength: 1024
          minLength: 0
          type: string
        shipAddressIdResolved:
          type: boolean
        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