Optimizely

Optimizely Customer Carriers API

The Customer Carriers API from Optimizely — 5 operation(s) for customer 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/CustomerCarriers List customer shipping carrier assignments · Returns the EntitySet CustomerCarriers #
Ask an LLM
“Which shipping carriers are assigned to which customers?”
“Can I filter customer carrier assignments to a single customer?”
Tell an agent
List all customer carrier assignments.
List customer carriers matching {filter}.
POST /api/v1/admin/CustomerCarriers Assign a shipping carrier to a customer · Post a new entity to EntitySet CustomerCarriers #
Ask an LLM
“How do I restrict a customer to ship with a particular carrier?”
“Can I link a carrier to a customer account through the admin API?”
Tell an agent
Assign carrier {carrierId} to customer {customerId}.
Let customer {customerId} ship using carrier {carrierId}.
GET /api/v1/admin/CustomerCarriers({id}) Get a customer carrier assignment · Returns the entity with the key from CustomerCarriers #
Ask an LLM
“Can I look up a single customer carrier link by its id?”
“Which customer and carrier does a given assignment connect?”
Tell an agent
Get customer carrier assignment {id}.
Show the customer and carrier on assignment {id}.
PUT /api/v1/admin/CustomerCarriers({id}) Replace a customer carrier assignment · Replace entity in EntitySet CustomerCarriers #
Ask an LLM
“Can I fully rewrite a customer carrier assignment in one request?”
“Does replacing a customer carrier record clear omitted fields?”
Tell an agent
Replace customer carrier assignment {id} with customer {customerId} and carrier {carrierId}.
Overwrite the complete customer carrier record {id}.
DELETE /api/v1/admin/CustomerCarriers({id}) Remove a carrier from a customer · Delete entity in EntitySet CustomerCarriers #
Ask an LLM
“How do I stop a customer from using a carrier they were assigned?”
“Can I make the customer carrier delete conditional on an ETag?”
Tell an agent destructive · confirm first
Delete customer carrier assignment {id}.
Remove customer carrier link {id} only if its ETag is {etag}.
PATCH /api/v1/admin/CustomerCarriers({id}) Change the carrier on a customer assignment · Update entity in EntitySet CustomerCarriers #
Ask an LLM
“Can I swap the carrier on an existing customer assignment without recreating it?”
“Is a partial update allowed on customer carrier records?”
Tell an agent
Change the carrier on assignment {id} to {carrierId}.
Patch customer carrier {id} to belong to customer {customerId}.
GET /api/v1/admin/CustomerCarriers/Default.Default() Call the customer carriers Default function · Call operation Default #
Ask an LLM
“What does the Default function on customer carriers return?”
“Is there a default customer carrier entry to fetch?”
Tell an agent
Call the Default function on customer carriers.
Fetch the default customer carrier result.
DELETE /api/v1/admin/customercarriers/delete Bulk delete customer carrier assignments · Customer carriers delete route #
Ask an LLM
“Can I drop several customer carrier assignments at once?”
“Is there a bulk delete by id list for customer carriers?”
Tell an agent destructive · confirm first
Delete customer carrier assignments {ids}.
Bulk remove the customer carrier links {ids}.
GET /api/v1/admin/customercarriers({key})/customproperties({custompropertyKey}) Get a custom property of a customer carrier · Customer carriers get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a customer carrier assignment?”
“Where do custom values for a customer's carrier link live?”
Tell an agent
Get custom property {custompropertyKey} of customer carrier {key}.
Show custom value {custompropertyKey} on customer carrier assignment {key}.

Specifications

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