Optimizely

Optimizely Ship Rates API

The Ship Rates API from Optimizely — 5 operation(s) for ship rates.

GitHub OpenAPI

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/ShipRates List shipping rates · Returns the EntitySet ShipRates #
Ask an LLM
“What shipping charges are set up by order amount?”
“Can I filter ship rates to a single ship via?”
Tell an agent
List all ship rates.
List ship rates matching {filter}, ordered by {orderby}.
POST /api/v1/admin/ShipRates Create a shipping rate · Post a new entity to EntitySet ShipRates #
Ask an LLM
“How do I charge a flat shipping fee above a certain order amount?”
“Can a new ship rate charge per item instead of per order?”
Tell an agent
Create a ship rate for ship via {shipViaId} charging {chargeAmount} on orders of {orderAmount}.
Add a per-each ship rate of {chargeAmount} for ship via {shipViaId}, per each set to {perEach}.
GET /api/v1/admin/ShipRates({id}) Get a shipping rate · Returns the entity with the key from ShipRates #
Ask an LLM
“Can I look up one ship rate by its ID?”
“What charge amount does a particular ship rate apply?”
Tell an agent
Show ship rate {id}.
Get ship rate {id} returning only {select}.
PUT /api/v1/admin/ShipRates({id}) Replace a shipping rate · Replace entity in EntitySet ShipRates #
Ask an LLM
“Can I overwrite a ship rate record completely?”
“What's the full-replace call for a shipping rate?”
Tell an agent
Replace ship rate {id} with charge {chargeAmount} at order amount {orderAmount}.
Overwrite ship rate {id} for ship via {shipViaId}.
DELETE /api/v1/admin/ShipRates({id}) Delete a shipping rate · Delete entity in EntitySet ShipRates #
Ask an LLM
“How do I remove one shipping rate tier?”
“Can I delete a ship rate conditionally on its ETag?”
Tell an agent destructive · confirm first
Delete ship rate {id}.
Delete ship rate {id} if its ETag matches {etag}.
PATCH /api/v1/admin/ShipRates({id}) Change a shipping rate's charge · Update entity in EntitySet ShipRates #
Ask an LLM
“Can I change only the charge amount of a ship rate?”
“Is there a partial update for the order threshold of a rate?”
Tell an agent
Set ship rate {id} charge to {chargeAmount}.
Patch ship rate {id} order amount to {orderAmount}.
GET /api/v1/admin/ShipRates/Default.Default() Get default values for a shipping rate · Call operation Default #
Ask an LLM
“What defaults are pre-filled for a new ship rate?”
“Is there a blank ship rate template?”
Tell an agent
Get the default ship rate template.
Show pre-filled values for a new shipping rate.
DELETE /api/v1/admin/shiprates/delete Delete several shipping rates · Ship rates delete route #
Ask an LLM
“Can I bulk delete ship rates in one request?”
“Which call removes many shipping rates by ID?”
Tell an agent destructive · confirm first
Bulk delete ship rates {ids}.
Remove the shipping rates {ids}.
GET /api/v1/admin/shiprates({key})/customproperties({custompropertyKey}) Get a custom property on a shipping rate · Ship rates get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom field stored on a ship rate?”
“Where are extra attributes of a shipping rate kept?”
Tell an agent
Get custom property {custompropertyKey} on ship rate {key}.
Show ship rate {key}'s custom field {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-ship-rates-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-rates-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-rates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Ship Rates API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Ship Rates
paths:
  /api/v1/admin/ShipRates:
    get:
      tags:
      - Ship Rates
      summary: Returns the EntitySet ShipRates
      operationId: ShipRates_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 Rates
      summary: Post a new entity to EntitySet ShipRates
      operationId: ShipRates_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ShipRate'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipRates({id}):
    get:
      tags:
      - Ship Rates
      summary: Returns the entity with the key from ShipRates
      operationId: ShipRates_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 Rates
      summary: Replace entity in EntitySet ShipRates
      operationId: ShipRates_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.ShipRate'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Ship Rates
      summary: Delete entity in EntitySet ShipRates
      operationId: ShipRates_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 Rates
      summary: Update entity in EntitySet ShipRates
      operationId: ShipRates_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.ShipRate'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipRates/Default.Default():
    get:
      tags:
      - Ship Rates
      summary: Call operation Default
      operationId: ShipRates_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/shiprates/delete:
    delete:
      tags:
      - Ship Rates
      operationId: ShipRates_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 rates delete route
      x-summary-source: derived
  /api/v1/admin/shiprates({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Ship Rates
      operationId: ShipRates_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 rates get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.ShipRate:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        shipViaId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        orderAmount:
          format: decimal
          type: number
        chargeAmount:
          format: decimal
          type: number
        perEach:
          type: boolean
        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