Optimizely

Optimizely Order Status Mappings API

The Order Status Mappings API from Optimizely — 5 operation(s) for order status mappings.

GitHub OpenAPI

Operations 10

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/OrderStatusMappings List order status mappings · Returns the EntitySet OrderStatusMappings #
Ask an LLM
“How are my ERP order statuses mapped to the names customers see?”
“Which order statuses allow cancellation or returns?”
Tell an agent
List all order status mappings.
Find order status mappings matching {filter}.
POST /api/v1/admin/OrderStatusMappings Map an ERP order status to a display name · Post a new entity to EntitySet OrderStatusMappings #
Ask an LLM
“How do I add a mapping from an ERP order status to a customer-facing label?”
“Can I allow RMAs or cancellation for a newly mapped status?”
Tell an agent
Map ERP order status {erpOrderStatus} to display name {displayName}.
Create a status mapping for {erpOrderStatus} shown as {displayName} with cancellation allowed {allowCancellation}.
GET /api/v1/admin/OrderStatusMappings({id}) Get one order status mapping · Returns the entity with the key from OrderStatusMappings #
Ask an LLM
“What display name and rules does a specific order status mapping have?”
“Is a given status mapping the default one?”
Tell an agent
Get order status mapping {id}.
Show status mapping {id} returning only {select}.
PUT /api/v1/admin/OrderStatusMappings({id}) Replace an order status mapping · Replace entity in EntitySet OrderStatusMappings #
Ask an LLM
“How do I overwrite an order status mapping entirely?”
“Can I replace a status mapping's ERP code and display name in one full update?”
Tell an agent
Replace status mapping {id} with ERP status {erpOrderStatus} shown as {displayName}.
Overwrite the whole order status mapping record {id}.
DELETE /api/v1/admin/OrderStatusMappings({id}) Delete an order status mapping · Delete entity in EntitySet OrderStatusMappings #
Ask an LLM
“How do I remove a single order status mapping?”
“Can I delete a status mapping only if its ETag still matches?”
Tell an agent destructive · confirm first
Delete order status mapping {id}.
Delete status mapping {id} if the ETag is {ifMatch}.
PATCH /api/v1/admin/OrderStatusMappings({id}) Partially update an order status mapping · Update entity in EntitySet OrderStatusMappings #
Ask an LLM
“Can I just rename the label customers see for an order status?”
“How do I turn on RMA returns for one existing status mapping?”
Tell an agent
Change the display name of status mapping {id} to {displayName}.
Set allow-RMA to {allowRma} on status mapping {id}.
GET /api/v1/admin/OrderStatusMappings/Default.Default() Get the default order status mapping template · Call operation Default #
Ask an LLM
“What default values does a new order status mapping start with?”
“Is there a blank order status mapping template?”
Tell an agent
Fetch the default order status mapping template.
Get default values for a new status mapping.
DELETE /api/v1/admin/orderstatusmappings/delete Bulk delete order status mappings · Order status mappings delete route #
Ask an LLM
“How do I delete several order status mappings at once?”
“Can I remove multiple status mappings by their IDs?”
Tell an agent destructive · confirm first
Bulk delete order status mappings {ids}.
Remove all these status mappings in one call: {ids}.
GET /api/v1/admin/orderstatusmappings({key})/customproperties({custompropertyKey}) Get a custom property of an order status mapping · Order status mappings get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property on an order status mapping?”
“Can I fetch one custom field value from a status mapping?”
Tell an agent
Get custom property {custompropertyKey} of status mapping {key}.
Show custom field {custompropertyKey} on order status mapping {key}.
GET /api/v1/orderstatusmappings List order status mappings · Orders V1 get order status mappings async #
Ask an LLM
“How are back-office order statuses mapped to what shoppers see?”
“Which order status mappings are configured for the storefront?”
Tell an agent
List the order status mappings.
Show how order statuses are mapped for display.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-order-status-mappings-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-order-status-mappings-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-order-status-mappings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Order Status Mappings API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Order Status Mappings
paths:
  /api/v1/admin/OrderStatusMappings:
    get:
      tags:
      - Order Status Mappings
      summary: Returns the EntitySet OrderStatusMappings
      operationId: OrderStatusMappings_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:
      - Order Status Mappings
      summary: Post a new entity to EntitySet OrderStatusMappings
      operationId: OrderStatusMappings_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.OrderStatusMapping'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/OrderStatusMappings({id}):
    get:
      tags:
      - Order Status Mappings
      summary: Returns the entity with the key from OrderStatusMappings
      operationId: OrderStatusMappings_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:
      - Order Status Mappings
      summary: Replace entity in EntitySet OrderStatusMappings
      operationId: OrderStatusMappings_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.OrderStatusMapping'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Order Status Mappings
      summary: Delete entity in EntitySet OrderStatusMappings
      operationId: OrderStatusMappings_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:
      - Order Status Mappings
      summary: Update entity in EntitySet OrderStatusMappings
      operationId: OrderStatusMappings_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.OrderStatusMapping'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/OrderStatusMappings/Default.Default():
    get:
      tags:
      - Order Status Mappings
      summary: Call operation Default
      operationId: OrderStatusMappings_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/orderstatusmappings/delete:
    delete:
      tags:
      - Order Status Mappings
      operationId: OrderStatusMappings_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: Order status mappings delete route
      x-summary-source: derived
  /api/v1/admin/orderstatusmappings({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Order Status Mappings
      operationId: OrderStatusMappings_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: Order status mappings get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/orderstatusmappings:
    get:
      tags:
      - Order Status Mappings
      operationId: OrdersV1_GetOrderStatusMappingsAsync
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Order.WebApi.V1.ApiModels.OrderStatusMappingCollectionModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Order.WebApi.V1.ApiModels.OrderStatusMappingCollectionModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Order.WebApi.V1.ApiModels.OrderStatusMappingCollectionModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Order.WebApi.V1.ApiModels.OrderStatusMappingCollectionModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Order.WebApi.V1.ApiModels.OrderStatusMappingCollectionModel'
      summary: Orders V1 get order status mappings async
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.OrderStatusMapping:
      required:
      - erpOrderStatus
      - displayName
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        erpOrderStatus:
          maxLength: 50
          minLength: 0
          type: string
        displayName:
          maxLength: 50
          minLength: 0
          type: string
        isDefault:
          type: boolean
        allowRma:
          type: boolean
        allowCancellation:
          type: boolean
        odpActionType:
          maxLength: 50
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
    Insite.Order.WebApi.V1.ApiModels.OrderStatusMappingModel:
      type: object
      properties:
        uri:
          type: string
        id:
          type: string
        erpOrderStatus:
          type: string
        displayName:
          type: string
        isDefault:
          type: boolean
        allowRma:
          type: boolean
        allowCancellation:
          type: boolean
        properties:
          type: object
          additionalProperties:
            type: string
    Insite.Order.WebApi.V1.ApiModels.OrderStatusMappingCollectionModel:
      type: object
      properties:
        uri:
          type: string
        orderStatusMappings:
          type: array
          items:
            $ref: '#/components/schemas/Insite.Order.WebApi.V1.ApiModels.OrderStatusMappingModel'
        properties:
          type: object
          additionalProperties:
            type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query