Optimizely Carriers API
The Carriers API from Optimizely — 12 operation(s) for carriers.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/optimizely-carriers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
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: []
/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: []
/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: []
/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: []
/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: []
/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: []
/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: []
/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: []
/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: []
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