Optimizely

Optimizely Shipments API

The Shipments API from Optimizely — 6 operation(s) for shipments.

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/Shipments List order shipments · Returns the EntitySet Shipments #
Ask an LLM
“Which shipments have gone out for my commerce orders?”
“Can I filter shipments by web order number or shipment date?”
Tell an agent
List all shipments.
Find shipments matching {filter}.
POST /api/v1/admin/Shipments Record a shipment for an order · Post a new entity to EntitySet Shipments #
Ask an LLM
“How do I record a new shipment against an order?”
“What is required to create a shipment, web and ERP order numbers?”
Tell an agent
Create shipment {shipmentNumber} for web order {webOrderNumber} and ERP order {erpOrderNumber}.
Record shipment {shipmentNumber} shipped on {shipmentDate} for ERP order {erpOrderNumber}.
GET /api/v1/admin/Shipments({id}) Get a shipment by ID · Returns the entity with the key from Shipments #
Ask an LLM
“When did a specific shipment go out and was the ASN sent?”
“Can I look up one shipment record by its ID?”
Tell an agent
Get shipment {id}.
Show the shipment and ASN dates for shipment {id}.
PUT /api/v1/admin/Shipments({id}) Replace a shipment record · Replace entity in EntitySet Shipments #
Ask an LLM
“Can I overwrite an entire shipment record in one request?”
“Does fully replacing a shipment require the order numbers again?”
Tell an agent
Replace shipment {id} with shipment number {shipmentNumber}, web order {webOrderNumber}, ERP order {erpOrderNumber}.
Overwrite the whole shipment record {id} using a full PUT.
DELETE /api/v1/admin/Shipments({id}) Delete a shipment by ID · Delete entity in EntitySet Shipments #
Ask an LLM
“How do I delete a shipment record entered in error?”
“Does deleting a shipment accept an If-Match ETag?”
Tell an agent destructive · confirm first
Delete shipment {id}.
Delete shipment {id} only if its ETag matches {ifMatch}.
PATCH /api/v1/admin/Shipments({id}) Update a shipment · Update entity in EntitySet Shipments #
Ask an LLM
“How do I mark the shipment email or ASN as sent on an existing shipment?”
“Can I correct just the shipment date on a shipment?”
Tell an agent
Set the ASN sent date on shipment {id} to {asnSentDate}.
Update the shipment date of shipment {id} to {shipmentDate}.
GET /api/v1/admin/Shipments/Default.Default() Get a default shipment template · Call operation Default #
Ask an LLM
“What default values does a new shipment start with?”
“Is there a blank shipment template to fetch before creating one?”
Tell an agent
Fetch the default shipment template.
Show me the default values for a new shipment.
DELETE /api/v1/admin/shipments/delete Bulk delete shipments · Shipments delete route #
Ask an LLM
“How do I delete several shipment records at once?”
“Can I pass a list of IDs to remove many shipments?”
Tell an agent destructive · confirm first
Bulk delete the shipments with IDs {ids}.
Remove all of these shipment records in one call: {ids}.
GET /api/v1/admin/shipments({key})/customproperties({custompropertyKey}) Get a custom property on a shipment · Shipments get custom property by key and custompropertykey #
Ask an LLM
“Where do I read a custom property stored on a shipment?”
“Can I fetch one extra property value from a shipment record?”
Tell an agent
Get custom property {custompropertyKey} on shipment {key}.
Show the custom property {custompropertyKey} of shipment {key}.
GET /api/v1/admin/shipments({key})/shipmentpackages({shipmentpackageKey}) Get a package within a shipment · Shipments get shipment package by key and shipmentpackagekey #
Ask an LLM
“What tracking details does one package in a shipment have?”
“Can I fetch a single package that belongs to a shipment?”
Tell an agent
Get package {shipmentpackageKey} of shipment {key}.
Show shipment package {shipmentpackageKey} inside shipment {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-shipments-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-shipments-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-shipments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Shipments API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Shipments
paths:
  /api/v1/admin/Shipments:
    get:
      tags:
      - Shipments
      summary: Returns the EntitySet Shipments
      operationId: Shipments_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:
      - Shipments
      summary: Post a new entity to EntitySet Shipments
      operationId: Shipments_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Shipment'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Shipments({id}):
    get:
      tags:
      - Shipments
      summary: Returns the entity with the key from Shipments
      operationId: Shipments_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:
      - Shipments
      summary: Replace entity in EntitySet Shipments
      operationId: Shipments_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.Shipment'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Shipments
      summary: Delete entity in EntitySet Shipments
      operationId: Shipments_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:
      - Shipments
      summary: Update entity in EntitySet Shipments
      operationId: Shipments_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.Shipment'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Shipments/Default.Default():
    get:
      tags:
      - Shipments
      summary: Call operation Default
      operationId: Shipments_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/shipments/delete:
    delete:
      tags:
      - Shipments
      operationId: Shipments_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: Shipments delete route
      x-summary-source: derived
  /api/v1/admin/shipments({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Shipments
      operationId: Shipments_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: Shipments get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/shipments({key})/shipmentpackages({shipmentpackageKey}):
    get:
      tags:
      - Shipments
      operationId: Shipments_GetShipmentPackageByKeyAndShipmentpackagekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: shipmentpackageKey
        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: Shipments get shipment package by key and shipmentpackagekey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.Shipment:
      required:
      - shipmentNumber
      - webOrderNumber
      - erpOrderNumber
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        shipmentNumber:
          maxLength: 50
          minLength: 0
          type: string
        shipmentDate:
          format: date-time
          type: string
        emailSentDate:
          format: date-time
          type: string
        asnSentDate:
          format: date-time
          type: string
        webOrderNumber:
          maxLength: 50
          minLength: 0
          type: string
        erpOrderNumber:
          maxLength: 50
          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