Optimizely

Optimizely Ship Vias API

The Ship Vias API from Optimizely — 11 operation(s) for ship vias.

GitHub OpenAPI

Operations 15

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/ShipVias List shipping methods · Returns the EntitySet ShipVias #
Ask an LLM
“Which ship vias (shipping methods) are configured in my commerce store?”
“Can I filter shipping methods to only the pickup options?”
Tell an agent
List all ship vias.
List ship vias matching the filter {filter}.
POST /api/v1/admin/ShipVias Create a shipping method · Post a new entity to EntitySet ShipVias #
Ask an LLM
“How do I add a new shipping method with its ERP ship code?”
“Can I give a new ship via a flat fee and a minimum fee?”
Tell an agent
Create ship via {description} with ship code {shipCode} and ERP code {erpShipCode}.
Add a shipping method {shipCode} for carrier {carrierId} with a flat fee of {flatFee}.
GET /api/v1/admin/ShipVias({id}) Get a shipping method · Returns the entity with the key from ShipVias #
Ask an LLM
“What fees and carrier does one ship via use?”
“Can I look up a single shipping method by its ID?”
Tell an agent
Get ship via {id}.
Show the settings of shipping method {id}.
PUT /api/v1/admin/ShipVias({id}) Replace a shipping method · Replace entity in EntitySet ShipVias #
Ask an LLM
“How do I overwrite a ship via with a completely new definition?”
“Does replacing a shipping method clear the fields I don't send?”
Tell an agent
Replace ship via {id} with ship code {shipCode}, ERP code {erpShipCode} and description {description}.
Overwrite all fields of shipping method {id}.
DELETE /api/v1/admin/ShipVias({id}) Delete a shipping method · Delete entity in EntitySet ShipVias #
Ask an LLM
“Can I permanently delete one ship via by its ID?”
“Is it possible to delete a shipping method only when its ETag matches?”
Tell an agent destructive · confirm first
Delete ship via {id}.
Delete shipping method {id} if its ETag is {etag}.
PATCH /api/v1/admin/ShipVias({id}) Update a shipping method · Update entity in EntitySet ShipVias #
Ask an LLM
“How do I disable a single shipping method without resending all of it?”
“Can I make an existing ship via the default option?”
Tell an agent
Set enable to {enable} on ship via {id}.
Change the minimum fee of shipping method {id} to {minimumFee}.
GET /api/v1/admin/ShipVias/Default.Default() Get a blank shipping method template · Call operation Default #
Ask an LLM
“What default values does a new ship via start with?”
“Can I fetch an empty shipping method template?”
Tell an agent
Fetch the default ship via template.
Show me the default values for a new shipping method.
POST /api/v1/admin/ShipVias/Default.archive Archive shipping methods · Call operation archive #
Ask an LLM
“Can I archive shipping methods instead of deleting them?”
“How do I retire several ship vias with the archive action?”
Tell an agent destructive · confirm first
Archive the ship vias {ids} using the Default.archive action.
Run the archive operation on shipping methods {ids}.
DELETE /api/v1/admin/shipvias/archive Archive shipping methods via the route · Ship vias archive route #
Ask an LLM
“Is there a DELETE route that archives ship vias rather than removing them?”
“What does the shipvias/archive route do with the IDs I pass?”
Tell an agent destructive · confirm first
Archive ship vias {ids} through the shipvias/archive route.
Use the archive route to retire shipping methods {ids}.
DELETE /api/v1/admin/shipvias/delete Bulk delete shipping methods · Ship vias delete route #
Ask an LLM
“Can I permanently delete several ship vias at once?”
“How do I remove a batch of shipping methods by ID?”
Tell an agent destructive · confirm first
Bulk delete the ship vias {ids}.
Permanently remove these shipping methods: {ids}.
GET /api/v1/admin/shipvias({key})/customerorders({customerorderKey}) Get an order shipped with a ship via · Ship vias get customer order by key and customerorderkey #
Ask an LLM
“Was a specific customer order shipped with a given shipping method?”
“Can I look up one customer order under a ship via?”
Tell an agent
Get customer order {customerorderKey} under ship via {key}.
Show order {customerorderKey} that used shipping method {key}.
GET /api/v1/admin/shipvias({key})/customproperties({custompropertyKey}) Get a custom property on a ship via · Ship vias get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a shipping method?”
“What extra custom field values does a ship via carry?”
Tell an agent
Get custom property {custompropertyKey} on ship via {key}.
Show shipping method {key}'s custom property {custompropertyKey}.
GET /api/v1/admin/shipvias({key})/shipcharges({shipchargeKey}) Get a ship charge for a ship via · Ship vias get ship charge by key and shipchargekey #
Ask an LLM
“What ship charge is defined for a particular shipping method?”
“Can I look up one shipping charge row under a ship via?”
Tell an agent
Get ship charge {shipchargeKey} on ship via {key}.
Show the charge {shipchargeKey} configured for shipping method {key}.
GET /api/v1/admin/shipvias({key})/shiprates({shiprateKey}) Get a ship rate for a ship via · Ship vias get ship rate by key and shipratekey #
Ask an LLM
“Which rate tier applies to a given shipping method?”
“Can I fetch a single ship rate belonging to a ship via?”
Tell an agent
Get ship rate {shiprateKey} on ship via {key}.
Show rate {shiprateKey} for shipping method {key}.
GET /api/v1/admin/shipvias({key})/shiprules({shipruleKey}) Get a ship rule for a ship via · Ship vias get ship rule by key and shiprulekey #
Ask an LLM
“What shipping rule restricts when a ship via can be used?”
“Can I look up one ship rule attached to a shipping method?”
Tell an agent
Get ship rule {shipruleKey} on ship via {key}.
Show rule {shipruleKey} applied to shipping method {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-ship-vias-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-ship-vias-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-ship-vias-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Ship Vias API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Ship Vias
paths:
  /api/v1/admin/ShipVias:
    get:
      tags:
      - Ship Vias
      summary: Returns the EntitySet ShipVias
      operationId: ShipVias_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:
      - Ship Vias
      summary: Post a new entity to EntitySet ShipVias
      operationId: ShipVias_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ShipVia'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipVias({id}):
    get:
      tags:
      - Ship Vias
      summary: Returns the entity with the key from ShipVias
      operationId: ShipVias_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:
      - Ship Vias
      summary: Replace entity in EntitySet ShipVias
      operationId: ShipVias_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.ShipVia'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Ship Vias
      summary: Delete entity in EntitySet ShipVias
      operationId: ShipVias_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:
      - Ship Vias
      summary: Update entity in EntitySet ShipVias
      operationId: ShipVias_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.ShipVia'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipVias/Default.Default():
    get:
      tags:
      - Ship Vias
      summary: Call operation Default
      operationId: ShipVias_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipVias/Default.archive:
    post:
      tags:
      - Ship Vias
      summary: Call operation archive
      operationId: ShipVias_Archive
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      requestBody:
        $ref: '#/components/requestBodies/Affiliates_ArchiveParameters'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/shipvias/archive:
    delete:
      tags:
      - Ship Vias
      operationId: ShipVias_ArchiveRoute
      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: Ship vias archive route
      x-summary-source: derived
  /api/v1/admin/shipvias/delete:
    delete:
      tags:
      - Ship Vias
      operationId: ShipVias_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: Ship vias delete route
      x-summary-source: derived
  /api/v1/admin/shipvias({key})/customerorders({customerorderKey}):
    get:
      tags:
      - Ship Vias
      operationId: ShipVias_GetCustomerOrderByKeyAndCustomerorderkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: customerorderKey
        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: Ship vias get customer order by key and customerorderkey
      x-summary-source: derived
  /api/v1/admin/shipvias({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Ship Vias
      operationId: ShipVias_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: Ship vias get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/shipvias({key})/shipcharges({shipchargeKey}):
    get:
      tags:
      - Ship Vias
      operationId: ShipVias_GetShipChargeByKeyAndShipchargekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: shipchargeKey
        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: Ship vias get ship charge by key and shipchargekey
      x-summary-source: derived
  /api/v1/admin/shipvias({key})/shiprates({shiprateKey}):
    get:
      tags:
      - Ship Vias
      operationId: ShipVias_GetShipRateByKeyAndShipratekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: shiprateKey
        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: Ship vias get ship rate by key and shipratekey
      x-summary-source: derived
  /api/v1/admin/shipvias({key})/shiprules({shipruleKey}):
    get:
      tags:
      - Ship Vias
      operationId: ShipVias_GetShipRuleByKeyAndShiprulekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: shipruleKey
        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: Ship vias get ship rule by key and shiprulekey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.ShipVia:
      required:
      - description
      - erpShipCode
      - shipCode
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        activateOn:
          format: date-time
          type: string
        allowScheduledShipDate:
          type: boolean
        carrierId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        chargeAmount:
          format: decimal
          type: number
        deactivateOn:
          format: date-time
          type: string
        description:
          maxLength: 100
          minLength: 0
          type: string
        enable:
          type: boolean
        erpShipCode:
          maxLength: 50
          minLength: 0
          type: string
        flatFee:
          format: decimal
          type: number
        isDefault:
          type: boolean
        minimumFee:
          format: decimal
          type: number
        shipCode:
          maxLength: 50
          minLength: 0
          type: string
        ruleManagerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        isPickup:
          type: boolean
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  requestBodies:
    Affiliates_ArchiveParameters:
      content:
        application/json:
          schema:
            type: object
            properties: {}
      description: archive action parameters
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query