Optimizely

Optimizely Website Carriers API

The Website Carriers API from Optimizely — 5 operation(s) for website carriers.

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/WebsiteCarriers List carriers enabled on websites · Returns the EntitySet WebsiteCarriers #
Ask an LLM
“Which shipping carriers are enabled on each website?”
“How do I list all website-carrier assignments?”
Tell an agent
List all website carrier assignments.
Show which carriers each storefront offers.
POST /api/v1/admin/WebsiteCarriers Enable a carrier on a website · Post a new entity to EntitySet WebsiteCarriers #
Ask an LLM
“How do I offer a shipping carrier on a specific website?”
“Can I assign a carrier to a storefront through the admin API?”
Tell an agent
Enable carrier {carrierId} on website {websiteId}.
Assign shipping carrier {carrierId} to storefront {websiteId}.
GET /api/v1/admin/WebsiteCarriers({id}) Get a website carrier assignment · Returns the entity with the key from WebsiteCarriers #
Ask an LLM
“Is there a call to read one website-carrier assignment by ID?”
“Which website and carrier does a given assignment link?”
Tell an agent
Get website carrier assignment {id}.
Show the website and carrier on assignment {id}.
PUT /api/v1/admin/WebsiteCarriers({id}) Replace a website carrier assignment · Replace entity in EntitySet WebsiteCarriers #
Ask an LLM
“What's the call to overwrite a website-carrier assignment entirely?”
“Can I fully replace which site and carrier an assignment covers?”
Tell an agent
Replace assignment {id} with website {websiteId} and carrier {carrierId}.
Overwrite website carrier record {id} in full with carrier {carrierId}.
DELETE /api/v1/admin/WebsiteCarriers({id}) Remove a carrier from a website · Delete entity in EntitySet WebsiteCarriers #
Ask an LLM
“How do I stop offering a carrier on a website?”
“Can I delete a website carrier assignment with an ETag check?”
Tell an agent destructive · confirm first
Delete website carrier assignment {id}.
Delete carrier assignment {id} if ETag is {etag}.
PATCH /api/v1/admin/WebsiteCarriers({id}) Update a website carrier assignment · Update entity in EntitySet WebsiteCarriers #
Ask an LLM
“How do I swap the carrier on an existing website assignment?”
“Can I move a carrier assignment to another website?”
Tell an agent
Switch assignment {id} to carrier {carrierId}.
Move carrier assignment {id} to website {websiteId}.
GET /api/v1/admin/WebsiteCarriers/Default.Default() Get the default website carrier template · Call operation Default #
Ask an LLM
“What does a blank website carrier assignment look like?”
“Where do I get default values for a new carrier assignment?”
Tell an agent
Get the default website carrier template.
Show default fields for a new website carrier link.
DELETE /api/v1/admin/websitecarriers/delete Bulk delete website carrier assignments · Website carriers delete route #
Ask an LLM
“Can I remove many carrier assignments at once?”
“Can I bulk delete website carriers by ID?”
Tell an agent destructive · confirm first
Bulk delete website carrier assignments {ids}.
Remove all these carrier assignments: {ids}.
GET /api/v1/admin/websitecarriers({key})/customproperties({custompropertyKey}) Get a custom property on a website carrier · Website carriers get custom property by key and custompropertykey #
Ask an LLM
“Where would I read a custom property on a website carrier assignment?”
“Can I fetch an extra attribute stored on a website carrier link?”
Tell an agent
Get custom property {prop} on website carrier {key}.
Show custom field {prop} for website carrier {key}.

Specifications

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