Optimizely

Optimizely Carriers API

The Carriers API from Optimizely — 12 operation(s) for carriers.

GitHub OpenAPI
Business capability
Logistics Operations Management BC-520.50

Operations 16

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/Carriers List shipping carriers · Returns the EntitySet Carriers #
Ask an LLM
“Which shipping carriers are configured in Optimizely Commerce?”
“Can I narrow the carrier list to only enabled, live carriers?”
Tell an agent
List all shipping carriers.
Show carriers matching {filter}.
POST /api/v1/admin/Carriers Add a shipping carrier · Post a new entity to EntitySet Carriers #
Ask an LLM
“What credentials and URLs do I need to register a new carrier?”
“Can a new carrier authenticate with OAuth client credentials instead of a password?”
Tell an agent
Create carrier {name} with account number {accountNumber} and rating service {ratingService}.
Add carrier {name} using tracking URL {trackingUrl} and contact email {contactEmail}.
GET /api/v1/admin/Carriers({id}) Get one shipping carrier · Returns the entity with the key from Carriers #
Ask an LLM
“What settings are stored for a single carrier?”
“Can I look up a carrier's live and test URLs by its id?”
Tell an agent
Fetch carrier {id}.
Show the configuration of carrier {id}.
PUT /api/v1/admin/Carriers({id}) Replace a shipping carrier's full setup · Replace entity in EntitySet Carriers #
Ask an LLM
“Can I overwrite a carrier's entire configuration in one call?”
“Does replacing a carrier mean resending every required credential field?”
Tell an agent
Replace carrier {id} with name {name} and live URL {liveUrl}.
Overwrite the whole record of carrier {id}.
DELETE /api/v1/admin/Carriers({id}) Delete one shipping carrier · Delete entity in EntitySet Carriers #
Ask an LLM
“How do I remove a single shipping carrier?”
“Can deleting a carrier be guarded by an ETag check?”
Tell an agent destructive · confirm first
Delete carrier {id}.
Delete carrier {id} only if its ETag is {etag}.
PATCH /api/v1/admin/Carriers({id}) Update selected carrier settings · Update entity in EntitySet Carriers #
Ask an LLM
“Can I switch a carrier from test to live mode without resending everything?”
“Is there a way to set a backup carrier for an existing one?”
Tell an agent
Set carrier {id} live flag to {isLive}.
Make {backUpCarrierId} the backup for carrier {id}.
GET /api/v1/admin/Carriers/Default.Default() Get default values for a new carrier · Call operation Default #
Ask an LLM
“What defaults does a new carrier record start with?”
“Is there a blank carrier template to fill in?”
Tell an agent
Get the default field values for a new carrier.
Show the empty carrier template.
DELETE /api/v1/admin/carriers/delete Bulk delete shipping carriers · Carriers delete route #
Ask an LLM
“Can I remove several carriers in one request?”
“Is there a batch delete for carriers by a list of ids?”
Tell an agent destructive · confirm first
Bulk delete carriers {ids}.
Permanently delete every carrier in {ids}.
GET /api/v1/admin/carriers({key})/carrierpackages({carrierpackageKey}) Get a package type offered by a carrier · Carriers get carrier package by key and carrierpackagekey #
Ask an LLM
“Which package definitions belong to a carrier?”
“Can I read one carrier package record through its carrier?”
Tell an agent
Get package {carrierpackageKey} of carrier {key}.
Show carrier package {carrierpackageKey} under carrier {key}.
GET /api/v1/admin/carriers({key})/carrierzones({carrierzoneKey}) Get a shipping zone of a carrier · Carriers get carrier zone by key and carrierzonekey #
Ask an LLM
“What shipping zones has a carrier been set up with?”
“Can I fetch a single carrier zone by key?”
Tell an agent
Get zone {carrierzoneKey} of carrier {key}.
Show carrier zone {carrierzoneKey} for carrier {key}.
GET /api/v1/admin/carriers({key})/customers({customerKey}) Get a customer assigned to a carrier · Carriers get customer by key and customerkey #
Ask an LLM
“Which customers are linked to a particular carrier?”
“Can I check one customer's association with a carrier?”
Tell an agent
Get customer {customerKey} assigned to carrier {key}.
Show customer {customerKey} linked to carrier {key}.
GET /api/v1/admin/carriers({key})/customproperties({custompropertyKey}) Get a custom property on a carrier · Carriers get custom property by key and custompropertykey #
Ask an LLM
“How can I read a custom property stored on a carrier?”
“Can I fetch one custom field value from a carrier record?”
Tell an agent
Get custom property {custompropertyKey} of carrier {key}.
Show the {custompropertyKey} custom property on carrier {key}.
GET /api/v1/admin/carriers({key})/shipcharges({shipchargeKey}) Get a shipping charge of a carrier · Carriers get ship charge by key and shipchargekey #
Ask an LLM
“What shipping charges are defined for a carrier?”
“Can I look up one ship charge entry through its carrier?”
Tell an agent
Get ship charge {shipchargeKey} of carrier {key}.
Show shipping charge {shipchargeKey} for carrier {key}.
GET /api/v1/admin/carriers({key})/shiprules({shipruleKey}) Get a shipping rule of a carrier · Carriers get ship rule by key and shiprulekey #
Ask an LLM
“Which shipping rules apply to a carrier?”
“Can I read one ship rule attached to a carrier?”
Tell an agent
Get ship rule {shipruleKey} of carrier {key}.
Show shipping rule {shipruleKey} under carrier {key}.
GET /api/v1/admin/carriers({key})/shipvias({shipviaKey}) Get a ship via service of a carrier · Carriers get ship via by key and shipviakey #
Ask an LLM
“What ship via service levels does a carrier offer?”
“Can I fetch one ship via option, like ground or overnight, for a carrier?”
Tell an agent
Get ship via {shipviaKey} of carrier {key}.
Show ship via service {shipviaKey} offered by carrier {key}.
GET /api/v1/admin/carriers({key})/websites({websiteKey}) Get a website that uses a carrier · Carriers get website by key and websitekey #
Ask an LLM
“Which storefront websites is a carrier enabled on?”
“Can I check whether one website is linked to a carrier?”
Tell an agent
Get website {websiteKey} linked to carrier {key}.
Show website {websiteKey} that uses carrier {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-carriers-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-carriers-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-carriers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Carriers API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Carriers
paths:
  /api/v1/admin/Carriers:
    get:
      tags:
      - Carriers
      summary: Returns the EntitySet Carriers
      operationId: Carriers_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:
      - Carriers
      summary: Post a new entity to EntitySet Carriers
      operationId: Carriers_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Carrier'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Carriers({id}):
    get:
      tags:
      - Carriers
      summary: Returns the entity with the key from Carriers
      operationId: Carriers_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:
      - Carriers
      summary: Replace entity in EntitySet Carriers
      operationId: Carriers_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.Carrier'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Carriers
      summary: Delete entity in EntitySet Carriers
      operationId: Carriers_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:
      - Carriers
      summary: Update entity in EntitySet Carriers
      operationId: Carriers_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.Carrier'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Carriers/Default.Default():
    get:
      tags:
      - Carriers
      summary: Call operation Default
      operationId: Carriers_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/carriers/delete:
    delete:
      tags:
      - Carriers
      operationId: Carriers_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: Carriers delete route
      x-summary-source: derived
  /api/v1/admin/carriers({key})/carrierpackages({carrierpackageKey}):
    get:
      tags:
      - Carriers
      operationId: Carriers_GetCarrierPackageByKeyAndCarrierpackagekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: carrierpackageKey
        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: Carriers get carrier package by key and carrierpackagekey
      x-summary-source: derived
  /api/v1/admin/carriers({key})/carrierzones({carrierzoneKey}):
    get:
      tags:
      - Carriers
      operationId: Carriers_GetCarrierZoneByKeyAndCarrierzonekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: carrierzoneKey
        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: Carriers get carrier zone by key and carrierzonekey
      x-summary-source: derived
  /api/v1/admin/carriers({key})/customers({customerKey}):
    get:
      tags:
      - Carriers
      operationId: Carriers_GetCustomerByKeyAndCustomerkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: customerKey
        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: Carriers get customer by key and customerkey
      x-summary-source: derived
  /api/v1/admin/carriers({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Carriers
      operationId: Carriers_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: Carriers get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/carriers({key})/shipcharges({shipchargeKey}):
    get:
      tags:
      - Carriers
      operationId: Carriers_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: Carriers get ship charge by key and shipchargekey
      x-summary-source: derived
  /api/v1/admin/carriers({key})/shiprules({shipruleKey}):
    get:
      tags:
      - Carriers
      operationId: Carriers_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: Carriers get ship rule by key and shiprulekey
      x-summary-source: derived
  /api/v1/admin/carriers({key})/shipvias({shipviaKey}):
    get:
      tags:
      - Carriers
      operationId: Carriers_GetShipViaByKeyAndShipviakey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: shipviaKey
        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: Carriers get ship via by key and shipviakey
      x-summary-source: derived
  /api/v1/admin/carriers({key})/websites({websiteKey}):
    get:
      tags:
      - Carriers
      operationId: Carriers_GetWebsiteByKeyAndWebsitekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: websiteKey
        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: Carriers get website by key and websitekey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.Carrier:
      required:
      - name
      - description
      - imagePath
      - userName
      - password
      - accountNumber
      - accessKey
      - clientId
      - clientSecret
      - liveUrl
      - testUrl
      - trackingUrl
      - ratingService
      - contactName
      - contactPhone
      - contactEmail
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 100
          minLength: 0
          type: string
        description:
          maxLength: 255
          minLength: 0
          type: string
        imagePath:
          maxLength: 1024
          minLength: 0
          type: string
        userName:
          maxLength: 100
          minLength: 0
          type: string
        password:
          maxLength: 100
          minLength: 0
          type: string
        accountNumber:
          maxLength: 100
          minLength: 0
          type: string
        accessKey:
          maxLength: 255
          minLength: 0
          type: string
        useOAuth:
          type: boolean
        clientId:
          maxLength: 255
          minLength: 0
          type: string
        clientSecret:
          maxLength: 255
          minLength: 0
          type: string
        enable:
          type: boolean
        isLive:
          type: boolean
        liveUrl:
          maxLength: 1024
          minLength: 0
          type: string
        testUrl:
          maxLength: 1024
          minLength: 0
          type: string
        trackingUrl:
          maxLength: 1024
          minLength: 0
          type: string
        isPrimaryCarrier:
          type: boolean
        ratingService:
          maxLength: 500
          minLength: 0
          type: string
        contactName:
          maxLength: 100
          minLength: 0
          type: string
        contactPhone:
          maxLength: 50
          minLength: 0
          type: string
        contactEmail:
          maxLength: 100
          minLength: 0
          type: string
        backUpCarrierId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        currencyId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        ruleManagerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        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