Optimizely

Optimizely Carrier Zone Rates API

The Carrier Zone Rates API from Optimizely — 5 operation(s) for carrier zone rates.

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/CarrierZoneRates List carrier zone shipping rates · Returns the EntitySet CarrierZoneRates #
Ask an LLM
“How do I see the weight-based shipping rates for each carrier zone?”
“Can I filter carrier zone rates to a single zone?”
Tell an agent
List all carrier zone rates.
List carrier zone rates matching {filter}, sorted by {orderby}.
POST /api/v1/admin/CarrierZoneRates Add a weight rate to a carrier zone · Post a new entity to EntitySet CarrierZoneRates #
Ask an LLM
“How do I add a shipping rate for a weight break in a carrier zone?”
“What do I need to create a new carrier zone rate?”
Tell an agent
Create a rate of {rate} for weight {weight} in carrier zone {carrierZoneId}.
Add a new weight break {weight} to zone {carrierZoneId}.
GET /api/v1/admin/CarrierZoneRates({id}) Get one carrier zone rate · Returns the entity with the key from CarrierZoneRates #
Ask an LLM
“How do I look up a single carrier zone rate by its ID?”
“What weight and price does a specific zone rate record hold?”
Tell an agent
Get carrier zone rate {id}.
Show the weight and rate for zone rate {id}.
PUT /api/v1/admin/CarrierZoneRates({id}) Replace a carrier zone rate · Replace entity in EntitySet CarrierZoneRates #
Ask an LLM
“How do I overwrite a whole carrier zone rate record?”
“Is there a way to fully replace a zone rate instead of patching it?”
Tell an agent
Replace zone rate {id} with weight {weight} and rate {rate} in zone {carrierZoneId}.
Overwrite carrier zone rate {id} with a full new record.
DELETE /api/v1/admin/CarrierZoneRates({id}) Delete a carrier zone rate · Delete entity in EntitySet CarrierZoneRates #
Ask an LLM
“How do I remove one weight rate from a carrier zone?”
“Can I delete a zone rate only if its ETag still matches?”
Tell an agent destructive · confirm first
Delete carrier zone rate {id}.
Remove zone rate {id} if its ETag is still {etag}.
PATCH /api/v1/admin/CarrierZoneRates({id}) Change the price on a carrier zone rate · Update entity in EntitySet CarrierZoneRates #
Ask an LLM
“How do I raise the shipping price on an existing zone rate?”
“Can I change just the weight break of a carrier zone rate?”
Tell an agent
Set the rate on carrier zone rate {id} to {rate}.
Update the weight of zone rate {id} to {weight}.
GET /api/v1/admin/CarrierZoneRates/Default.Default() Get a blank carrier zone rate template · Call operation Default #
Ask an LLM
“What default values does a new carrier zone rate start with?”
“Can I fetch an empty zone rate template before creating one?”
Tell an agent
Fetch the default carrier zone rate template.
Show me the starting values for a new zone rate.
DELETE /api/v1/admin/carrierzonerates/delete Bulk delete carrier zone rates · Carrier zone rates delete route #
Ask an LLM
“How do I delete several carrier zone rates at once?”
“Can I clear out a batch of zone rates by ID?”
Tell an agent destructive · confirm first
Bulk delete the carrier zone rates with IDs {ids}.
Remove these zone rates in one call: {ids}.
GET /api/v1/admin/carrierzonerates({key})/customproperties({custompropertyKey}) Get a custom property on a carrier zone rate · Carrier zone rates get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a carrier zone rate?”
“Can I fetch one extra field value from a zone rate?”
Tell an agent
Get custom property {custompropertyKey} on carrier zone rate {key}.
Show the custom property {custompropertyKey} of zone rate {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-carrier-zone-rates-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-rates-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-rates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Carrier Zone Rates API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Carrier Zone Rates
paths:
  /api/v1/admin/CarrierZoneRates:
    get:
      tags:
      - Carrier Zone Rates
      summary: Returns the EntitySet CarrierZoneRates
      operationId: CarrierZoneRates_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 Rates
      summary: Post a new entity to EntitySet CarrierZoneRates
      operationId: CarrierZoneRates_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CarrierZoneRate'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CarrierZoneRates({id}):
    get:
      tags:
      - Carrier Zone Rates
      summary: Returns the entity with the key from CarrierZoneRates
      operationId: CarrierZoneRates_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 Rates
      summary: Replace entity in EntitySet CarrierZoneRates
      operationId: CarrierZoneRates_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.CarrierZoneRate'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Carrier Zone Rates
      summary: Delete entity in EntitySet CarrierZoneRates
      operationId: CarrierZoneRates_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 Rates
      summary: Update entity in EntitySet CarrierZoneRates
      operationId: CarrierZoneRates_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.CarrierZoneRate'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CarrierZoneRates/Default.Default():
    get:
      tags:
      - Carrier Zone Rates
      summary: Call operation Default
      operationId: CarrierZoneRates_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/carrierzonerates/delete:
    delete:
      tags:
      - Carrier Zone Rates
      operationId: CarrierZoneRates_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 rates delete route
      x-summary-source: derived
  /api/v1/admin/carrierzonerates({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Carrier Zone Rates
      operationId: CarrierZoneRates_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 rates get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.CarrierZoneRate:
      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
        weight:
          format: decimal
          type: number
        rate:
          format: decimal
          type: number
        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