Optimizely Shipment Package Lines API

The Shipment Package Lines API from Optimizely — 5 operation(s) for shipment package lines.

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/ShipmentPackageLines List shipment package lines · Returns the EntitySet ShipmentPackageLines #
Ask an LLM
“Which products were packed in each shipment package?”
“Can I filter shipment package lines to one package?”
Tell an agent
List all shipment package lines.
Show shipment package lines matching {filter}.
POST /api/v1/admin/ShipmentPackageLines Add a product line to a shipment package · Post a new entity to EntitySet ShipmentPackageLines #
Ask an LLM
“How do I record what was packed in a shipment package?”
“Can I note quantity shipped versus ordered on a package line?”
Tell an agent
Add {productName} ({productCode}, {productDescription}) to shipment package {shipmentPackageId}.
Create a package line for {productCode} {productName}, {productDescription}, shipped qty {qtyShipped}.
GET /api/v1/admin/ShipmentPackageLines({id}) Get a shipment package line · Returns the entity with the key from ShipmentPackageLines #
Ask an LLM
“How many units of a product shipped on a given package line?”
“Can I look up one shipment package line by ID?”
Tell an agent
Get shipment package line {id}.
Show quantities shipped on package line {id}.
PUT /api/v1/admin/ShipmentPackageLines({id}) Replace a shipment package line · Replace entity in EntitySet ShipmentPackageLines #
Ask an LLM
“How do I overwrite every field of a shipment package line?”
“Can I fully replace a package line record?”
Tell an agent
Replace package line {id} with {productName} ({productCode}), {productDescription}.
Overwrite all fields of shipment package line {id}: code {productCode}, name {productName}, description {productDescription}.
DELETE /api/v1/admin/ShipmentPackageLines({id}) Delete a shipment package line · Delete entity in EntitySet ShipmentPackageLines #
Ask an LLM
“How do I remove one line from a shipment package?”
“Does deleting a package line honor an If-Match header?”
Tell an agent destructive · confirm first
Delete shipment package line {id}.
Remove package line {id} if its ETag is {ifMatch}.
PATCH /api/v1/admin/ShipmentPackageLines({id}) Correct the shipped quantity on a package line · Update entity in EntitySet ShipmentPackageLines #
Ask an LLM
“How do I fix the quantity shipped on an existing package line?”
“Can I update the price recorded on a shipment package line?”
Tell an agent
Set qty shipped to {qtyShipped} on existing package line {id} ({productCode}, {productName}, {productDescription}).
Update the price on package line {id} to {price} for {productCode} {productName}, {productDescription}.
GET /api/v1/admin/ShipmentPackageLines/Default.Default() Get defaults for a new shipment package line · Call operation Default #
Ask an LLM
“What defaults does a new shipment package line start with?”
“Is there a blank package line template?”
Tell an agent
Get the default field values for a new shipment package line.
Show a blank shipment package line record.
DELETE /api/v1/admin/shipmentpackagelines/delete Delete several shipment package lines · Shipment package lines delete route #
Ask an LLM
“How do I bulk delete shipment package lines?”
“Can I remove many package lines in one request?”
Tell an agent destructive · confirm first
Bulk delete shipment package lines {ids}.
Permanently delete every package line in {ids}.
GET /api/v1/admin/shipmentpackagelines({key})/customproperties({custompropertyKey}) Get a custom property on a package line · Shipment package lines get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property on a shipment package line?”
“Can I fetch one custom field value from a package line?”
Tell an agent
Get custom property {custompropertyKey} of shipment package line {key}.
Show the {custompropertyKey} custom property on package 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-shipment-package-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-shipment-package-lines-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Shipment Package Lines API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Shipment Package Lines
paths:
  /api/v1/admin/ShipmentPackageLines:
    get:
      tags:
      - Shipment Package Lines
      summary: Returns the EntitySet ShipmentPackageLines
      operationId: ShipmentPackageLines_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:
      - Shipment Package Lines
      summary: Post a new entity to EntitySet ShipmentPackageLines
      operationId: ShipmentPackageLines_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ShipmentPackageLine'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipmentPackageLines({id}):
    get:
      tags:
      - Shipment Package Lines
      summary: Returns the entity with the key from ShipmentPackageLines
      operationId: ShipmentPackageLines_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:
      - Shipment Package Lines
      summary: Replace entity in EntitySet ShipmentPackageLines
      operationId: ShipmentPackageLines_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.ShipmentPackageLine'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Shipment Package Lines
      summary: Delete entity in EntitySet ShipmentPackageLines
      operationId: ShipmentPackageLines_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:
      - Shipment Package Lines
      summary: Update entity in EntitySet ShipmentPackageLines
      operationId: ShipmentPackageLines_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.ShipmentPackageLine'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipmentPackageLines/Default.Default():
    get:
      tags:
      - Shipment Package Lines
      summary: Call operation Default
      operationId: ShipmentPackageLines_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/shipmentpackagelines/delete:
    delete:
      tags:
      - Shipment Package Lines
      operationId: ShipmentPackageLines_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: Shipment package lines delete route
      x-summary-source: derived
  /api/v1/admin/shipmentpackagelines({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Shipment Package Lines
      operationId: ShipmentPackageLines_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: Shipment package lines get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.ShipmentPackageLine:
      required:
      - productName
      - productDescription
      - productCode
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        shipmentPackageId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productName:
          maxLength: 100
          minLength: 0
          type: string
        productDescription:
          maxLength: 1024
          minLength: 0
          type: string
        productCode:
          maxLength: 50
          minLength: 0
          type: string
        qtyOrdered:
          format: decimal
          type: number
        qtyShipped:
          format: decimal
          type: number
        price:
          format: decimal
          type: number
        orderLineId:
          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