Optimizely

Optimizely Carrier Zones API

The Carrier Zones API from Optimizely — 7 operation(s) for carrier zones.

GitHub OpenAPI

Operations 11

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/CarrierZones List carrier shipping zones · Returns the EntitySet CarrierZones #
Ask an LLM
“Which shipping zones are set up for my carriers?”
“Can I filter carrier zones by carrier and count how many there are?”
Tell an agent
List all carrier zones.
List carrier zones matching {filter} and include a total count.
POST /api/v1/admin/CarrierZones Add a shipping zone to a carrier · Post a new entity to EntitySet CarrierZones #
Ask an LLM
“How do I define a new shipping zone for a carrier?”
“What does a carrier zone need besides the zone name?”
Tell an agent
Create zone {zone} for carrier {carrierId}.
Add a new carrier zone called {zone}.
GET /api/v1/admin/CarrierZones({id}) Get one carrier zone · Returns the entity with the key from CarrierZones #
Ask an LLM
“How do I look up a single carrier zone by its ID?”
“Can I expand the rates or postal ranges when reading one carrier zone?”
Tell an agent
Get carrier zone {id}.
Show carrier zone {id} with {expand} expanded.
PUT /api/v1/admin/CarrierZones({id}) Replace a carrier zone record · Replace entity in EntitySet CarrierZones #
Ask an LLM
“How do I overwrite a carrier zone with a complete new record?”
“Does a full replace of a carrier zone reset fields I leave out?”
Tell an agent
Replace carrier zone {id} with zone {zone} for carrier {carrierId}.
Fully overwrite carrier zone {id} as {zone}.
DELETE /api/v1/admin/CarrierZones({id}) Delete a carrier zone · Delete entity in EntitySet CarrierZones #
Ask an LLM
“How do I remove one shipping zone from a carrier?”
“Can I make a carrier zone delete conditional on its ETag?”
Tell an agent destructive · confirm first
Delete carrier zone {id}.
Delete carrier zone {id} if its ETag still matches {ifMatch}.
PATCH /api/v1/admin/CarrierZones({id}) Rename or reassign a carrier zone · Update entity in EntitySet CarrierZones #
Ask an LLM
“Can I just rename a carrier zone without touching its other fields?”
“How do I move an existing zone over to a different carrier?”
Tell an agent
Rename carrier zone {id} to {zone}.
Move carrier zone {id} to carrier {carrierId}.
GET /api/v1/admin/CarrierZones/Default.Default() Call the Default function on carrier zones · Call operation Default #
Ask an LLM
“What does the Default OData function on carrier zones give back?”
“Is there a default carrier zone entity I can read as a template?”
Tell an agent
Call the Default function on carrier zones.
Get the default carrier zone entity.
DELETE /api/v1/admin/carrierzones/delete Bulk delete carrier zones by ID · Carrier zones delete route #
Ask an LLM
“Can I remove several carrier zones in a single request?”
“How do I clear out a list of old shipping zones at once?”
Tell an agent destructive · confirm first
Bulk delete carrier zones {ids}.
Remove these carrier zones together: {ids}.
GET /api/v1/admin/carrierzones({key})/carrierzonepostalcoderanges({carrierzonepostalcoderangeKey}) Get a postal code range in a carrier zone · Carrier zones get carrier zone postal code range by key and… #
Ask an LLM
“Which postal code ranges fall inside a given carrier zone?”
“Can I look up one postal code range that defines a shipping zone?”
Tell an agent
Get postal code range {carrierzonepostalcoderangeKey} of carrier zone {key}.
Show the zip range {carrierzonepostalcoderangeKey} assigned to zone {key}.
GET /api/v1/admin/carrierzones({key})/carrierzonerates({carrierzonerateKey}) Get a shipping rate in a carrier zone · Carrier zones get carrier zone rate by key and carrierzoneratekey #
Ask an LLM
“What shipping rate applies inside a particular carrier zone?”
“Can I read one rate entry configured for a carrier zone?”
Tell an agent
Get rate {carrierzonerateKey} for carrier zone {key}.
Show the shipping rate {carrierzonerateKey} in zone {key}.
GET /api/v1/admin/carrierzones({key})/customproperties({custompropertyKey}) Get a custom property on a carrier zone · Carrier zones get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a carrier zone?”
“Can carrier zones hold custom fields I can fetch one at a time?”
Tell an agent
Get custom property {custompropertyKey} of carrier zone {key}.
Read carrier zone {key}'s custom field {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-carrier-zones-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-carrier-zones-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-carrier-zones-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Carrier Zones API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Carrier Zones
paths:
  /api/v1/admin/CarrierZones:
    get:
      tags:
      - Carrier Zones
      summary: Returns the EntitySet CarrierZones
      operationId: CarrierZones_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:
      - Carrier Zones
      summary: Post a new entity to EntitySet CarrierZones
      operationId: CarrierZones_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CarrierZone'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CarrierZones({id}):
    get:
      tags:
      - Carrier Zones
      summary: Returns the entity with the key from CarrierZones
      operationId: CarrierZones_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:
      - Carrier Zones
      summary: Replace entity in EntitySet CarrierZones
      operationId: CarrierZones_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.CarrierZone'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Carrier Zones
      summary: Delete entity in EntitySet CarrierZones
      operationId: CarrierZones_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:
      - Carrier Zones
      summary: Update entity in EntitySet CarrierZones
      operationId: CarrierZones_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.CarrierZone'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CarrierZones/Default.Default():
    get:
      tags:
      - Carrier Zones
      summary: Call operation Default
      operationId: CarrierZones_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/carrierzones/delete:
    delete:
      tags:
      - Carrier Zones
      operationId: CarrierZones_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: Carrier zones delete route
      x-summary-source: derived
  /api/v1/admin/carrierzones({key})/carrierzonepostalcoderanges({carrierzonepostalcoderangeKey}):
    get:
      tags:
      - Carrier Zones
      operationId: CarrierZones_GetCarrierZonePostalCodeRangeByKeyAndCarrierzonepostalcoderangekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: carrierzonepostalcoderangeKey
        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: Carrier zones get carrier zone postal code range by key and…
      x-summary-source: derived
  /api/v1/admin/carrierzones({key})/carrierzonerates({carrierzonerateKey}):
    get:
      tags:
      - Carrier Zones
      operationId: CarrierZones_GetCarrierZoneRateByKeyAndCarrierzoneratekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: carrierzonerateKey
        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: Carrier zones get carrier zone rate by key and carrierzoneratekey
      x-summary-source: derived
  /api/v1/admin/carrierzones({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Carrier Zones
      operationId: CarrierZones_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: Carrier zones get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.CarrierZone:
      required:
      - zone
      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
        zone:
          maxLength: 50
          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