Optimizely

Optimizely Order History Lines API

The Order History Lines API from Optimizely — 5 operation(s) for order history lines.

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/OrderHistoryLines List order history lines · Returns the EntitySet OrderHistoryLines #
Ask an LLM
“What line items are recorded in past orders from the ERP?”
“Can I filter order history lines by product ERP number or status?”
Tell an agent
List all order history lines.
List order history lines matching {filter}, top {top}.
POST /api/v1/admin/OrderHistoryLines Add a line to an order history record · Post a new entity to EntitySet OrderHistoryLines #
Ask an LLM
“How do I add a line item to a historical order imported from the ERP?”
“What fields are required for a new order history line?”
Tell an agent
Add a line for product {productErpNumber} to order history {orderHistoryId}, qty {qtyOrdered}.
Create order history line {lineNumber} for customer {customerNumber} with status {status} at net price {unitNetPrice}.
GET /api/v1/admin/OrderHistoryLines({id}) Get an order history line · Returns the entity with the key from OrderHistoryLines #
Ask an LLM
“How do I see the quantities and pricing on one historical order line?”
“How much of a specific order line was actually shipped?”
Tell an agent
Get order history line {id}.
Show shipped vs ordered quantity for order line {id}.
PUT /api/v1/admin/OrderHistoryLines({id}) Replace an order history line · Replace entity in EntitySet OrderHistoryLines #
Ask an LLM
“How do I overwrite an entire historical order line from the ERP?”
“Does replacing an order history line need every required field again?”
Tell an agent
Replace order history line {id} for product {productErpNumber} with status {status}.
Fully overwrite order line {id} with quantity ordered {qtyOrdered} and shipped {qtyShipped}.
DELETE /api/v1/admin/OrderHistoryLines({id}) Delete an order history line · Delete entity in EntitySet OrderHistoryLines #
Ask an LLM
“How do I remove a line from a historical order?”
“Can I delete an order history line only if its ETag still matches?”
Tell an agent destructive · confirm first
Delete order history line {id}.
Delete order history line {id} if its ETag is {etag}.
PATCH /api/v1/admin/OrderHistoryLines({id}) Update an order history line · Update entity in EntitySet OrderHistoryLines #
Ask an LLM
“How do I update the shipped quantity on a past order line?”
“Can I change just the status of an order history line?”
Tell an agent
Set shipped quantity of order line {id} to {qtyShipped}.
Change status of order history line {id} to {status}.
GET /api/v1/admin/OrderHistoryLines/Default.Default() Get the default order history line template · Call operation Default #
Ask an LLM
“What default values does a new order history line start with?”
“Where can I get a blank order history line record?”
Tell an agent
Get the default order history line template.
Show default values for a new order history line.
DELETE /api/v1/admin/orderhistorylines/delete Bulk delete order history lines · Order history lines delete route #
Ask an LLM
“How do I delete many order history lines at once?”
“Can I remove a batch of historical order lines by id?”
Tell an agent destructive · confirm first
Delete order history lines {ids}.
Bulk remove order history lines {ids}.
GET /api/v1/admin/orderhistorylines({key})/customproperties({custompropertyKey}) Get an order history line custom property · Order history lines get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property on an order history line?”
“Where is one custom property value for a historical order line?”
Tell an agent
Get custom property {custompropertyKey} of order history line {key}.
Show order history line {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-order-history-lines-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-order-history-lines-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-order-history-lines-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Order History Lines API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Order History Lines
paths:
  /api/v1/admin/OrderHistoryLines:
    get:
      tags:
      - Order History Lines
      summary: Returns the EntitySet OrderHistoryLines
      operationId: OrderHistoryLines_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:
      - Order History Lines
      summary: Post a new entity to EntitySet OrderHistoryLines
      operationId: OrderHistoryLines_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.OrderHistoryLine'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/OrderHistoryLines({id}):
    get:
      tags:
      - Order History Lines
      summary: Returns the entity with the key from OrderHistoryLines
      operationId: OrderHistoryLines_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:
      - Order History Lines
      summary: Replace entity in EntitySet OrderHistoryLines
      operationId: OrderHistoryLines_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.OrderHistoryLine'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Order History Lines
      summary: Delete entity in EntitySet OrderHistoryLines
      operationId: OrderHistoryLines_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:
      - Order History Lines
      summary: Update entity in EntitySet OrderHistoryLines
      operationId: OrderHistoryLines_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.OrderHistoryLine'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/OrderHistoryLines/Default.Default():
    get:
      tags:
      - Order History Lines
      summary: Call operation Default
      operationId: OrderHistoryLines_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/orderhistorylines/delete:
    delete:
      tags:
      - Order History Lines
      operationId: OrderHistoryLines_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: Order history lines delete route
      x-summary-source: derived
  /api/v1/admin/orderhistorylines({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Order History Lines
      operationId: OrderHistoryLines_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: Order history lines get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.OrderHistoryLine:
      required:
      - customerNumber
      - customerSequence
      - lineType
      - status
      - productErpNumber
      - customerProductNumber
      - linePOReference
      - description
      - warehouse
      - notes
      - unitOfMeasure
      - configDataSet
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        orderHistoryId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        lineNumber:
          format: decimal
          type: number
        releaseNumber:
          format: decimal
          type: number
        requiredDate:
          format: date-time
          type: string
        lastShipDate:
          format: date-time
          type: string
        customerNumber:
          maxLength: 50
          minLength: 0
          type: string
        customerSequence:
          maxLength: 50
          minLength: 0
          type: string
        lineType:
          maxLength: 50
          minLength: 0
          type: string
        status:
          maxLength: 50
          minLength: 0
          type: string
        productErpNumber:
          maxLength: 50
          minLength: 0
          type: string
        customerProductNumber:
          maxLength: 50
          minLength: 0
          type: string
        linePOReference:
          maxLength: 50
          minLength: 0
          type: string
        description:
          maxLength: 2048
          minLength: 0
          type: string
        warehouse:
          maxLength: 50
          minLength: 0
          type: string
        notes:
          type: string
        qtyOrdered:
          format: decimal
          type: number
        qtyShipped:
          format: decimal
          type: number
        unitOfMeasure:
          maxLength: 50
          minLength: 0
          type: string
        inventoryQtyOrdered:
          format: decimal
          type: number
        inventoryQtyShipped:
          format: decimal
          type: number
        unitNetPrice:
          format: decimal
          type: number
        discountPercent:
          format: decimal
          type: number
        unitDiscountAmount:
          format: decimal
          type: number
        totalDiscountAmount:
          format: decimal
          type: number
        totalRegularPrice:
          format: decimal
          type: number
        totalNetPrice:
          format: decimal
          type: number
        rmaQtyRequested:
          format: decimal
          type: number
        rmaQtyReceived:
          format: decimal
          type: number
        unitListPrice:
          format: decimal
          type: number
        unitRegularPrice:
          format: decimal
          type: number
        unitCost:
          format: decimal
          type: number
        orderLineOtherCharges:
          format: decimal
          type: number
        taxRate:
          format: decimal
          type: number
        taxAmount:
          format: decimal
          type: number
        configDataSet:
          type: string
        netPriceWithVat:
          format: decimal
          type: number
        unitPriceWithVat:
          format: decimal
          type: number
        vmiBinId:
          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