Optimizely

Optimizely Shipment Packages API

The Shipment Packages API from Optimizely — 6 operation(s) for shipment packages.

GitHub OpenAPI
Business capability
Logistics Operations Management BC-520.50

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/ShipmentPackages List shipment packages · Returns the EntitySet ShipmentPackages #
Ask an LLM
“Which packages have been recorded against my shipments?”
“Can I filter shipment packages by tracking number?”
Tell an agent
List all shipment packages.
List shipment packages matching {filter}.
POST /api/v1/admin/ShipmentPackages Add a package to a shipment · Post a new entity to EntitySet ShipmentPackages #
Ask an LLM
“How do I record a new package with its carrier and tracking number?”
“Can I add freight cost when creating a shipment package?”
Tell an agent
Add package {packageNumber} shipped by {carrier} via {shipVia} with tracking number {trackingNumber}.
Create a package on shipment {shipmentId} with tracking {trackingNumber}.
GET /api/v1/admin/ShipmentPackages({id}) Get a shipment package · Returns the entity with the key from ShipmentPackages #
Ask an LLM
“What tracking number and carrier does a specific package have?”
“Can I look up one shipment package by its ID?”
Tell an agent
Get shipment package {id}.
Show the tracking details of package {id}.
PUT /api/v1/admin/ShipmentPackages({id}) Replace a shipment package · Replace entity in EntitySet ShipmentPackages #
Ask an LLM
“How do I overwrite a shipment package record entirely?”
“Does replacing a package reset the fields I omit?”
Tell an agent
Replace shipment package {id} with package number {packageNumber}, carrier {carrier}, ship via {shipVia} and tracking {trackingNumber}.
Overwrite all fields of shipment package {id}.
DELETE /api/v1/admin/ShipmentPackages({id}) Delete a shipment package · Delete entity in EntitySet ShipmentPackages #
Ask an LLM
“Can I delete one package from a shipment by its ID?”
“Is it possible to delete a package only if its ETag matches?”
Tell an agent destructive · confirm first
Delete shipment package {id}.
Delete shipment package {id} if its ETag is {etag}.
PATCH /api/v1/admin/ShipmentPackages({id}) Update a shipment package · Update entity in EntitySet ShipmentPackages #
Ask an LLM
“How do I correct the tracking number on an existing package?”
“Can I update just the freight on a shipment package?”
Tell an agent
Change the tracking number of package {id} to {trackingNumber}.
Set the freight on shipment package {id} to {freight}.
GET /api/v1/admin/ShipmentPackages/Default.Default() Get a blank shipment package template · Call operation Default #
Ask an LLM
“What default values does a new shipment package have?”
“Can I fetch an empty shipment package template?”
Tell an agent
Fetch the default shipment package template.
Show the starting values for a new shipment package.
DELETE /api/v1/admin/shipmentpackages/delete Bulk delete shipment packages · Shipment packages delete route #
Ask an LLM
“Can I delete several shipment packages at once?”
“How do I remove a batch of packages by ID?”
Tell an agent destructive · confirm first
Bulk delete shipment packages {ids}.
Remove these shipment packages together: {ids}.
GET /api/v1/admin/shipmentpackages({key})/customproperties({custompropertyKey}) Get a custom property on a shipment package · Shipment packages get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a shipment package?”
“What extra custom values does a package record carry?”
Tell an agent
Get custom property {custompropertyKey} on shipment package {key}.
Show package {key}'s custom property {custompropertyKey}.
GET /api/v1/admin/shipmentpackages({key})/shipmentpackagelines({shipmentpackagelineKey}) Get a line item inside a shipment package · Shipment packages get shipment package line by key and shipmentpackagelinekey #
Ask an LLM
“Which items were packed into a particular shipment package?”
“Can I look up one package line within a shipment package?”
Tell an agent
Get package line {shipmentpackagelineKey} in shipment package {key}.
Show line {shipmentpackagelineKey} packed in package {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-shipment-packages-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-shipment-packages-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-shipment-packages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Shipment Packages API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Shipment Packages
paths:
  /api/v1/admin/ShipmentPackages:
    get:
      tags:
      - Shipment Packages
      summary: Returns the EntitySet ShipmentPackages
      operationId: ShipmentPackages_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 Packages
      summary: Post a new entity to EntitySet ShipmentPackages
      operationId: ShipmentPackages_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ShipmentPackage'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipmentPackages({id}):
    get:
      tags:
      - Shipment Packages
      summary: Returns the entity with the key from ShipmentPackages
      operationId: ShipmentPackages_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 Packages
      summary: Replace entity in EntitySet ShipmentPackages
      operationId: ShipmentPackages_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.ShipmentPackage'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Shipment Packages
      summary: Delete entity in EntitySet ShipmentPackages
      operationId: ShipmentPackages_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 Packages
      summary: Update entity in EntitySet ShipmentPackages
      operationId: ShipmentPackages_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.ShipmentPackage'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipmentPackages/Default.Default():
    get:
      tags:
      - Shipment Packages
      summary: Call operation Default
      operationId: ShipmentPackages_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/shipmentpackages/delete:
    delete:
      tags:
      - Shipment Packages
      operationId: ShipmentPackages_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 packages delete route
      x-summary-source: derived
  /api/v1/admin/shipmentpackages({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Shipment Packages
      operationId: ShipmentPackages_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 packages get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/shipmentpackages({key})/shipmentpackagelines({shipmentpackagelineKey}):
    get:
      tags:
      - Shipment Packages
      operationId: ShipmentPackages_GetShipmentPackageLineByKeyAndShipmentpackagelinekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: shipmentpackagelineKey
        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 packages get shipment package line by key and shipmentpackagelinekey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.ShipmentPackage:
      required:
      - packageNumber
      - carrier
      - trackingNumber
      - shipVia
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        shipmentId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        packageNumber:
          maxLength: 100
          minLength: 0
          type: string
        carrier:
          maxLength: 100
          minLength: 0
          type: string
        trackingNumber:
          maxLength: 50
          minLength: 0
          type: string
        freight:
          format: decimal
          type: number
        shipVia:
          maxLength: 100
          minLength: 0
          type: string
        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