Optimizely Order Lines API

The Order Lines API from Optimizely — 6 operation(s) for order lines.

Operations 10

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/OrderLines List order lines · Returns the EntitySet OrderLines #
Ask an LLM
“What line items are on my customer orders in Optimizely Commerce?”
“Can I filter order lines by status or product?”
Tell an agent
List all order lines.
List order lines where {filter}, sorted by {orderby}.
POST /api/v1/admin/OrderLines Add a line to a customer order · Post a new entity to EntitySet OrderLines #
Ask an LLM
“How do I add a new product line to an existing customer order?”
“Can I set quantity and unit price when creating an order line?”
Tell an agent
Add product {productId} to order {customerOrderId} with quantity {qtyOrdered}.
Create an order line on order {customerOrderId} at unit net price {unitNetPrice} per {unitOfMeasure}.
GET /api/v1/admin/OrderLines({id}) Get an order line by id · Returns the entity with the key from OrderLines #
Ask an LLM
“Can I look up a single order line and its pricing by id?”
“How many units of one order line have shipped?”
Tell an agent
Get order line {id}.
Fetch order line {id} with {expand} expanded.
PUT /api/v1/admin/OrderLines({id}) Replace an order line · Replace entity in EntitySet OrderLines #
Ask an LLM
“How do I overwrite every field of an order line in one call?”
“What does fully replacing an order line record require?”
Tell an agent
Replace order line {id} with status {status} and quantity {qtyOrdered}.
Overwrite the full order line record {id}.
DELETE /api/v1/admin/OrderLines({id}) Delete an order line · Delete entity in EntitySet OrderLines #
Ask an LLM
“Can I remove one line item from an order by its id?”
“Does deleting a single order line accept an If-Match ETag?”
Tell an agent destructive · confirm first
Delete order line {id}.
Delete order line {id} only if its ETag is {etag}.
PATCH /api/v1/admin/OrderLines({id}) Update fields on an order line · Update entity in EntitySet OrderLines #
Ask an LLM
“How do I change just the quantity on an existing order line?”
“Can I update an order line's promise date without resending everything?”
Tell an agent
Change the quantity on order line {id} to {qtyOrdered}.
Set the promise date of order line {id} to {promiseDate}.
GET /api/v1/admin/OrderLines/Default.Default() Get a blank order line template · Call operation Default #
Ask an LLM
“What default values does a new order line start with?”
“Is there an empty order line template to fill in?”
Tell an agent
Get the default order line template.
Show the defaults for a new order line.
DELETE /api/v1/admin/orderlines/delete Bulk delete order lines · Order lines delete route #
Ask an LLM
“Can I delete several order lines by id in one request?”
“How do I clear a batch of order line items at once?”
Tell an agent destructive · confirm first
Bulk delete order lines {ids}.
Remove the order lines with ids {ids}.
GET /api/v1/admin/orderlines({key})/customerorderpromotions({customerorderpromotionKey}) Get a promotion applied to an order line · Order lines get customer order promotion by key and customerorderpromotionkey #
Ask an LLM
“Which promotion was applied to a specific order line?”
“Can I read one order promotion through the line it discounted?”
Tell an agent
Get order promotion {customerorderpromotionKey} on order line {key}.
Show promotion {customerorderpromotionKey} applied to line {key} with {expand} expanded.
GET /api/v1/admin/orderlines({key})/customproperties({custompropertyKey}) Get a custom property of an order line · Order lines get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on an order line?”
“Can I read one extension field from an order line?”
Tell an agent
Get custom property {custompropertyKey} of order line {key}.
Read custom field {custompropertyKey} on order line {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-order-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.

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

OpenAPI Specification

optimizely-order-lines-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Order Lines API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Order Lines
paths:
  /api/v1/admin/OrderLines:
    get:
      tags:
      - Order Lines
      summary: Returns the EntitySet OrderLines
      operationId: OrderLines_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 Lines
      summary: Post a new entity to EntitySet OrderLines
      operationId: OrderLines_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.OrderLine'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/OrderLines({id}):
    get:
      tags:
      - Order Lines
      summary: Returns the entity with the key from OrderLines
      operationId: OrderLines_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 Lines
      summary: Replace entity in EntitySet OrderLines
      operationId: OrderLines_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.OrderLine'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Order Lines
      summary: Delete entity in EntitySet OrderLines
      operationId: OrderLines_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 Lines
      summary: Update entity in EntitySet OrderLines
      operationId: OrderLines_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.OrderLine'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/OrderLines/Default.Default():
    get:
      tags:
      - Order Lines
      summary: Call operation Default
      operationId: OrderLines_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/orderlines/delete:
    delete:
      tags:
      - Order Lines
      operationId: OrderLines_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 lines delete route
      x-summary-source: derived
  /api/v1/admin/orderlines({key})/customerorderpromotions({customerorderpromotionKey}):
    get:
      tags:
      - Order Lines
      operationId: OrderLines_GetCustomerOrderPromotionByKeyAndCustomerorderpromotionkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: customerorderpromotionKey
        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 lines get customer order promotion by key and customerorderpromotionkey
      x-summary-source: derived
  /api/v1/admin/orderlines({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Order Lines
      operationId: OrderLines_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 lines get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.OrderLine:
      required:
      - status
      - description
      - notes
      - unitOfMeasure
      - taxCode1
      - taxCode2
      - shipSite
      - customerPOLine
      - costCode
      - smartPart
      - configurationViewModel
      - configDataSet
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerOrderId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        line:
          format: int32
          type: integer
        release:
          format: int32
          type: integer
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        websiteId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        status:
          maxLength: 50
          minLength: 0
          type: string
        description:
          maxLength: 2048
          minLength: 0
          type: string
        notes:
          type: string
        qtyOrdered:
          format: decimal
          type: number
        unitRegularPrice:
          format: decimal
          type: number
        unitNetPrice:
          format: decimal
          type: number
        unitOfMeasure:
          maxLength: 50
          minLength: 0
          type: string
        qtyShipped:
          format: decimal
          type: number
        taxCode1:
          maxLength: 50
          minLength: 0
          type: string
        taxCode2:
          maxLength: 50
          minLength: 0
          type: string
        dueDate:
          format: date-time
          type: string
        promiseDate:
          format: date-time
          type: string
        shipSite:
          maxLength: 50
          minLength: 0
          type: string
        shipDate:
          format: date-time
          type: string
        isPromotionItem:
          type: boolean
        promotionResultId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerPOLine:
          maxLength: 50
          minLength: 0
          type: string
        costCode:
          maxLength: 100
          minLength: 0
          type: string
        orderLineOtherCharges:
          format: decimal
          type: number
        taxAmount:
          format: decimal
          type: number
        totalRegularPrice:
          format: decimal
          type: number
        totalNetPrice:
          format: decimal
          type: number
        warehouseId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        unitListPrice:
          format: decimal
          type: number
        unitCost:
          format: decimal
          type: number
        smartPart:
          maxLength: 256
          minLength: 0
          type: string
        configurationViewModel:
          type: string
        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