Optimizely

Optimizely Carrier Packages API

The Carrier Packages API from Optimizely — 7 operation(s) for carrier packages.

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/CarrierPackages List carrier package types · Returns the EntitySet CarrierPackages #
Ask an LLM
“How do I list the shipping package sizes defined for my carriers in Optimizely Configured Commerce?”
“Can I filter carrier packages to active ones and sort them by name?”
Tell an agent
List all carrier packages.
List carrier packages matching {filter} ordered by {orderby}.
POST /api/v1/admin/CarrierPackages Create a carrier package · Post a new entity to EntitySet CarrierPackages #
Ask an LLM
“What dimensions and weight can I set on a new carrier package?”
“Can I tie a new shipping package to a specific carrier?”
Tell an agent
Create carrier package {name} for carrier {carrierId}.
Add package {name} measuring {length} x {width} x {height} with weight {weight}.
GET /api/v1/admin/CarrierPackages({id}) Get one carrier package · Returns the entity with the key from CarrierPackages #
Ask an LLM
“How can I see the dimensions of a single carrier package?”
“Which fields can I select when fetching one carrier package?”
Tell an agent
Show carrier package {id}.
Get carrier package {id} returning only {select}.
PUT /api/v1/admin/CarrierPackages({id}) Replace a carrier package · Replace entity in EntitySet CarrierPackages #
Ask an LLM
“Can I overwrite a carrier package with a full new set of dimensions?”
“What's the call to replace a whole carrier package record?”
Tell an agent
Replace carrier package {id} with name {name} and weight {weight}.
Overwrite every field of carrier package {id}, naming it {name}.
DELETE /api/v1/admin/CarrierPackages({id}) Delete a carrier package · Delete entity in EntitySet CarrierPackages #
Ask an LLM
“How do I delete one carrier package by ID?”
“Can I delete a carrier package only if it hasn't changed since I read it?”
Tell an agent destructive · confirm first
Delete carrier package {id}.
Delete carrier package {id} if its ETag matches {etag}.
PATCH /api/v1/admin/CarrierPackages({id}) Update a carrier package's fields · Update entity in EntitySet CarrierPackages #
Ask an LLM
“Can I deactivate a carrier package without resending its dimensions?”
“How do I change just the height of an existing package?”
Tell an agent
Patch carrier package {id} to set active to {isActive}.
Update carrier package {id} height to {height}.
GET /api/v1/admin/CarrierPackages/Default.Default() Get default values for a carrier package · Call operation Default #
Ask an LLM
“What defaults are pre-filled for a carrier package before I create it?”
“Is there a blank carrier package template?”
Tell an agent
Get the default carrier package template.
Show pre-filled values for a new carrier package.
POST /api/v1/admin/CarrierPackages/Default.archive Archive carrier packages (OData action) · Call operation archive #
Ask an LLM
“Can I archive old carrier packages with the Default.archive POST action?”
“How do I archive packages instead of deleting them using a POST?”
Tell an agent
Archive carrier packages {ids} with the Default.archive action.
POST to the carrier package archive action for {ids}.
DELETE /api/v1/admin/carrierpackages/archive Archive carrier packages (DELETE route) · Carrier packages archive route #
Ask an LLM
“Is there a DELETE carrierpackages/archive route for archiving packages?”
“Which endpoint archives carrier packages with the DELETE verb?”
Tell an agent destructive · confirm first
Archive carrier packages {ids} through the DELETE archive route.
Send a DELETE to carrierpackages/archive for {ids}.
DELETE /api/v1/admin/carrierpackages/delete Delete several carrier packages · Carrier packages delete route #
Ask an LLM
“Can I bulk delete carrier packages in one request?”
“How do I permanently remove a list of packages rather than archive them?”
Tell an agent destructive · confirm first
Bulk delete carrier packages {ids}.
Permanently remove the carrier packages in {ids}.
GET /api/v1/admin/carrierpackages({key})/customproperties({custompropertyKey}) Get a custom property on a carrier package · Carrier packages get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a carrier package?”
“Where are extra custom attributes of a shipping package kept?”
Tell an agent
Get custom property {custompropertyKey} on carrier package {key}.
Show carrier package {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-carrier-packages-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-packages-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-packages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Carrier Packages API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Carrier Packages
paths:
  /api/v1/admin/CarrierPackages:
    get:
      tags:
      - Carrier Packages
      summary: Returns the EntitySet CarrierPackages
      operationId: CarrierPackages_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 Packages
      summary: Post a new entity to EntitySet CarrierPackages
      operationId: CarrierPackages_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CarrierPackage'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CarrierPackages({id}):
    get:
      tags:
      - Carrier Packages
      summary: Returns the entity with the key from CarrierPackages
      operationId: CarrierPackages_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 Packages
      summary: Replace entity in EntitySet CarrierPackages
      operationId: CarrierPackages_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.CarrierPackage'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Carrier Packages
      summary: Delete entity in EntitySet CarrierPackages
      operationId: CarrierPackages_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 Packages
      summary: Update entity in EntitySet CarrierPackages
      operationId: CarrierPackages_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.CarrierPackage'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CarrierPackages/Default.Default():
    get:
      tags:
      - Carrier Packages
      summary: Call operation Default
      operationId: CarrierPackages_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CarrierPackages/Default.archive:
    post:
      tags:
      - Carrier Packages
      summary: Call operation archive
      operationId: CarrierPackages_Archive
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      requestBody:
        $ref: '#/components/requestBodies/Affiliates_ArchiveParameters'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/carrierpackages/archive:
    delete:
      tags:
      - Carrier Packages
      operationId: CarrierPackages_ArchiveRoute
      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 packages archive route
      x-summary-source: derived
  /api/v1/admin/carrierpackages/delete:
    delete:
      tags:
      - Carrier Packages
      operationId: CarrierPackages_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 packages delete route
      x-summary-source: derived
  /api/v1/admin/carrierpackages({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Carrier Packages
      operationId: CarrierPackages_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 packages get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.CarrierPackage:
      required:
      - name
      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
        height:
          format: decimal
          type: number
        isActive:
          type: boolean
        length:
          format: decimal
          type: number
        name:
          maxLength: 100
          minLength: 0
          type: string
        weight:
          format: decimal
          type: number
        width:
          format: decimal
          type: number
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  requestBodies:
    Affiliates_ArchiveParameters:
      content:
        application/json:
          schema:
            type: object
            properties: {}
      description: archive action parameters
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query