Optimizely

Optimizely Carrier Zone Postal Code Ranges API

The Carrier Zone Postal Code Ranges API from Optimizely — 5 operation(s) for carrier zone postal code ranges.

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/CarrierZonePostalCodeRanges List carrier zone postal code ranges · Returns the EntitySet CarrierZonePostalCodeRanges #
Ask an LLM
“Which postal code ranges map to each carrier shipping zone?”
“Can I filter postal code ranges to one carrier zone?”
Tell an agent
List all carrier zone postal code ranges.
List postal code ranges matching {filter}.
POST /api/v1/admin/CarrierZonePostalCodeRanges Add a postal code range to a carrier zone · Post a new entity to EntitySet CarrierZonePostalCodeRanges #
Ask an LLM
“How do I assign a range of ZIP codes to a carrier zone?”
“What start and end values does a new postal code range need?”
Tell an agent
Add postal codes {postalCodeStartRange} to {postalCodeEndRange} to carrier zone {carrierZoneId}.
Create a ZIP range from {postalCodeStartRange} through {postalCodeEndRange} for zone {carrierZoneId}.
GET /api/v1/admin/CarrierZonePostalCodeRanges({id}) Get a carrier zone postal code range · Returns the entity with the key from CarrierZonePostalCodeRanges #
Ask an LLM
“Can I look up one postal code range by its ID?”
“Which zone does a particular ZIP range record belong to?”
Tell an agent
Show postal code range {id}.
Get postal code range {id} expanding {expand}.
PUT /api/v1/admin/CarrierZonePostalCodeRanges({id}) Replace a carrier zone postal code range · Replace entity in EntitySet CarrierZonePostalCodeRanges #
Ask an LLM
“Can I overwrite a postal code range record completely?”
“What's the full-replace call for a ZIP range?”
Tell an agent
Replace postal code range {id} with {postalCodeStartRange} to {postalCodeEndRange}.
Overwrite ZIP range {id} and move it to zone {carrierZoneId}, from {postalCodeStartRange} to {postalCodeEndRange}.
DELETE /api/v1/admin/CarrierZonePostalCodeRanges({id}) Delete a carrier zone postal code range · Delete entity in EntitySet CarrierZonePostalCodeRanges #
Ask an LLM
“How do I remove one ZIP range from a carrier zone?”
“Can I delete a postal code range only if its ETag matches?”
Tell an agent destructive · confirm first
Delete postal code range {id}.
Delete postal code range {id} if its ETag is {etag}.
PATCH /api/v1/admin/CarrierZonePostalCodeRanges({id}) Update a carrier zone postal code range · Update entity in EntitySet CarrierZonePostalCodeRanges #
Ask an LLM
“Can I widen a ZIP range by changing just its end value?”
“Is there a partial update for one postal code range?”
Tell an agent
Change the end of postal code range {id} to {postalCodeEndRange}.
Patch postal code range {id} to start at {postalCodeStartRange}.
GET /api/v1/admin/CarrierZonePostalCodeRanges/Default.Default() Get default values for a postal code range · Call operation Default #
Ask an LLM
“What defaults are pre-filled for a new postal code range?”
“Is there a blank ZIP range template?”
Tell an agent
Get the default postal code range template.
Show pre-filled values for a new carrier zone ZIP range.
DELETE /api/v1/admin/carrierzonepostalcoderanges/delete Delete several postal code ranges · Carrier zone postal code ranges delete route #
Ask an LLM
“Can I bulk delete postal code ranges in one request?”
“Which call removes many ZIP ranges by ID list?”
Tell an agent destructive · confirm first
Bulk delete postal code ranges {ids}.
Remove the carrier zone ZIP ranges {ids}.
GET /api/v1/admin/carrierzonepostalcoderanges({key})/customproperties({custompropertyKey}) Get a custom property on a postal code range · Carrier zone postal code ranges get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom field stored on a postal code range?”
“Where are extra attributes of a ZIP range kept?”
Tell an agent
Get custom property {custompropertyKey} on postal code range {key}.
Show ZIP range {key}'s custom field {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-carrier-zone-postal-code-ranges-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-zone-postal-code-ranges-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-zone-postal-code-ranges-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Carrier Zone Postal Code Ranges API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Carrier Zone Postal Code Ranges
paths:
  /api/v1/admin/CarrierZonePostalCodeRanges:
    get:
      tags:
      - Carrier Zone Postal Code Ranges
      summary: Returns the EntitySet CarrierZonePostalCodeRanges
      operationId: CarrierZonePostalCodeRanges_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 Zone Postal Code Ranges
      summary: Post a new entity to EntitySet CarrierZonePostalCodeRanges
      operationId: CarrierZonePostalCodeRanges_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CarrierZonePostalCodeRange'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CarrierZonePostalCodeRanges({id}):
    get:
      tags:
      - Carrier Zone Postal Code Ranges
      summary: Returns the entity with the key from CarrierZonePostalCodeRanges
      operationId: CarrierZonePostalCodeRanges_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 Zone Postal Code Ranges
      summary: Replace entity in EntitySet CarrierZonePostalCodeRanges
      operationId: CarrierZonePostalCodeRanges_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.CarrierZonePostalCodeRange'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Carrier Zone Postal Code Ranges
      summary: Delete entity in EntitySet CarrierZonePostalCodeRanges
      operationId: CarrierZonePostalCodeRanges_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 Zone Postal Code Ranges
      summary: Update entity in EntitySet CarrierZonePostalCodeRanges
      operationId: CarrierZonePostalCodeRanges_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.CarrierZonePostalCodeRange'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CarrierZonePostalCodeRanges/Default.Default():
    get:
      tags:
      - Carrier Zone Postal Code Ranges
      summary: Call operation Default
      operationId: CarrierZonePostalCodeRanges_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/carrierzonepostalcoderanges/delete:
    delete:
      tags:
      - Carrier Zone Postal Code Ranges
      operationId: CarrierZonePostalCodeRanges_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 zone postal code ranges delete route
      x-summary-source: derived
  /api/v1/admin/carrierzonepostalcoderanges({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Carrier Zone Postal Code Ranges
      operationId: CarrierZonePostalCodeRanges_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 zone postal code ranges get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.CarrierZonePostalCodeRange:
      required:
      - postalCodeStartRange
      - postalCodeEndRange
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        carrierZoneId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        postalCodeStartRange:
          maxLength: 50
          minLength: 0
          type: string
        postalCodeEndRange:
          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