Optimizely

Optimizely Ship Rules API

The Ship Rules API from Optimizely — 5 operation(s) for ship rules.

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/ShipRules List shipping rules · Returns the EntitySet ShipRules #
Ask an LLM
“How do I see all the rules that decide which carriers and ship methods apply to an order?”
“Can I filter shipping rules by country or rule type?”
Tell an agent
List all ship rules.
List ship rules matching {filter}, ordered by {orderby}.
POST /api/v1/admin/ShipRules Create a shipping rule · Post a new entity to EntitySet ShipRules #
Ask an LLM
“How do I add a rule that restricts a ship method by postal code range or order amount?”
“What rule type, condition and terms code does a new ship rule need?”
Tell an agent
Create a {shipRuleType} ship rule with condition {condition} and terms code {termsCode}.
Add a ship rule for carrier {carrierId} covering postal codes {postalCodeLowerRange} to {postalCodeUpperRange}.
GET /api/v1/admin/ShipRules({id}) Get one shipping rule · Returns the entity with the key from ShipRules #
Ask an LLM
“How do I look up the conditions on a single ship rule?”
“Can I fetch a shipping rule by its ID?”
Tell an agent
Get ship rule {id}.
Show the condition and limits set on ship rule {id}.
PUT /api/v1/admin/ShipRules({id}) Replace a shipping rule · Replace entity in EntitySet ShipRules #
Ask an LLM
“How do I overwrite a whole ship rule definition?”
“Is there a way to fully replace a shipping rule instead of patching it?”
Tell an agent
Replace ship rule {id} with type {shipRuleType}, condition {condition} and terms {termsCode}.
Overwrite shipping rule {id} with a complete new definition.
DELETE /api/v1/admin/ShipRules({id}) Delete a shipping rule · Delete entity in EntitySet ShipRules #
Ask an LLM
“How do I remove one shipping rule?”
“Can I delete a ship rule only if its ETag still matches?”
Tell an agent destructive · confirm first
Delete ship rule {id}.
Remove shipping rule {id} if its ETag is still {etag}.
PATCH /api/v1/admin/ShipRules({id}) Adjust limits on a shipping rule · Update entity in EntitySet ShipRules #
Ask an LLM
“How do I change the minimum or maximum order amount on a ship rule?”
“Can I change the execution order of an existing shipping rule?”
Tell an agent
Set the order amount range of ship rule {id} to {minimumAmount} through {maximumAmount}.
Move ship rule {id} to execution order {executionOrder}.
GET /api/v1/admin/ShipRules/Default.Default() Get a blank shipping rule template · Call operation Default #
Ask an LLM
“What default values does a new ship rule start with?”
“Can I fetch an empty shipping rule template before creating one?”
Tell an agent
Fetch the default ship rule template.
Show me the starting values for a new shipping rule.
DELETE /api/v1/admin/shiprules/delete Bulk delete shipping rules · Ship rules delete route #
Ask an LLM
“How do I delete several ship rules at once?”
“Can I clear out a batch of shipping rules by ID?”
Tell an agent destructive · confirm first
Bulk delete the ship rules with IDs {ids}.
Remove these shipping rules in one call: {ids}.
GET /api/v1/admin/shiprules({key})/customproperties({custompropertyKey}) Get a custom property on a shipping rule · Ship rules get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a ship rule?”
“Can I fetch one extra field value from a shipping rule?”
Tell an agent
Get custom property {custompropertyKey} on ship rule {key}.
Show the custom property {custompropertyKey} of shipping rule {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-ship-rules-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-rules-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-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Ship Rules API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Ship Rules
paths:
  /api/v1/admin/ShipRules:
    get:
      tags:
      - Ship Rules
      summary: Returns the EntitySet ShipRules
      operationId: ShipRules_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 Rules
      summary: Post a new entity to EntitySet ShipRules
      operationId: ShipRules_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ShipRule'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipRules({id}):
    get:
      tags:
      - Ship Rules
      summary: Returns the entity with the key from ShipRules
      operationId: ShipRules_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 Rules
      summary: Replace entity in EntitySet ShipRules
      operationId: ShipRules_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.ShipRule'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Ship Rules
      summary: Delete entity in EntitySet ShipRules
      operationId: ShipRules_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 Rules
      summary: Update entity in EntitySet ShipRules
      operationId: ShipRules_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.ShipRule'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ShipRules/Default.Default():
    get:
      tags:
      - Ship Rules
      summary: Call operation Default
      operationId: ShipRules_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/shiprules/delete:
    delete:
      tags:
      - Ship Rules
      operationId: ShipRules_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 rules delete route
      x-summary-source: derived
  /api/v1/admin/shiprules({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Ship Rules
      operationId: ShipRules_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 rules get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.ShipRule:
      required:
      - shipRuleType
      - condition
      - termsCode
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        carrierId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        shipViaId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        shipRateId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        postalCode:
          maxLength: 50
          minLength: 0
          type: string
        stateId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        countryId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        minimumAmount:
          format: double
          type: number
        maximumAmount:
          format: double
          type: number
        postalCodeLowerRange:
          maxLength: 50
          minLength: 0
          type: string
        postalCodeUpperRange:
          maxLength: 50
          minLength: 0
          type: string
        customerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        shipRuleType:
          maxLength: 255
          minLength: 0
          type: string
        executionGroup:
          format: int32
          type: integer
        executionOrder:
          format: int32
          type: integer
        condition:
          maxLength: 50
          minLength: 0
          type: string
        categoryId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dayOfWeek:
          format: int32
          type: integer
        termsCode:
          maxLength: 150
          minLength: 0
          type: string
        customerType:
          maxLength: 50
          minLength: 0
          type: string
        customRuleName:
          maxLength: 255
          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