# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Admin API V1 Order Status Mappings API version: 1.0.0 extends: openapi/optimizely-order-status-mappings-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-10-01' generator: build-phrasing.py label: Generated by API Evangelist operations: 10 - target: $.paths['/api/v1/admin/OrderStatusMappings'].get update: x-apievangelist-phrasing: intent: List order status mappings effect: read questions: - How are my ERP order statuses mapped to the names customers see? - Which order statuses allow cancellation or returns? - Can I sort order status mappings by display name? instructions: - text: List all order status mappings. - text: Find order status mappings matching {filter}. slots: filter: query.$filter method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/OrderStatusMappings'].post update: x-apievangelist-phrasing: intent: Map an ERP order status to a display name effect: write questions: - 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? instructions: - text: Map ERP order status {erpOrderStatus} to display name {displayName}. slots: erpOrderStatus: requestBody.erpOrderStatus displayName: requestBody.displayName - text: Create a status mapping for {erpOrderStatus} shown as {displayName} with cancellation allowed {allowCancellation}. slots: erpOrderStatus: requestBody.erpOrderStatus displayName: requestBody.displayName allowCancellation: requestBody.allowCancellation method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/OrderStatusMappings({id})'].get update: x-apievangelist-phrasing: intent: Get one order status mapping effect: read questions: - What display name and rules does a specific order status mapping have? - Is a given status mapping the default one? instructions: - text: Get order status mapping {id}. slots: id: path.id - text: Show status mapping {id} returning only {select}. slots: id: path.id select: query.$select method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/OrderStatusMappings({id})'].put update: x-apievangelist-phrasing: intent: Replace an order status mapping effect: write questions: - 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? instructions: - text: Replace status mapping {id} with ERP status {erpOrderStatus} shown as {displayName}. slots: id: path.id erpOrderStatus: requestBody.erpOrderStatus displayName: requestBody.displayName - text: Overwrite the whole order status mapping record {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/OrderStatusMappings({id})'].delete update: x-apievangelist-phrasing: intent: Delete an order status mapping effect: destructive questions: - How do I remove a single order status mapping? - Can I delete a status mapping only if its ETag still matches? instructions: - text: Delete order status mapping {id}. slots: id: path.id - text: Delete status mapping {id} if the ETag is {ifMatch}. slots: id: path.id ifMatch: header.If-Match method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/OrderStatusMappings({id})'].patch update: x-apievangelist-phrasing: intent: Partially update an order status mapping effect: write questions: - Can I just rename the label customers see for an order status? - How do I turn on RMA returns for one existing status mapping? instructions: - text: Change the display name of status mapping {id} to {displayName}. slots: id: path.id displayName: requestBody.displayName - text: Set allow-RMA to {allowRma} on status mapping {id}. slots: allowRma: requestBody.allowRma id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/OrderStatusMappings/Default.Default()'].get update: x-apievangelist-phrasing: intent: Get the default order status mapping template effect: read questions: - What default values does a new order status mapping start with? - Is there a blank order status mapping template? instructions: - text: Fetch the default order status mapping template. - text: Get default values for a new status mapping. method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/orderstatusmappings/delete'].delete update: x-apievangelist-phrasing: intent: Bulk delete order status mappings effect: destructive questions: - How do I delete several order status mappings at once? - Can I remove multiple status mappings by their IDs? instructions: - text: Bulk delete order status mappings {ids}. slots: ids: query.ids - text: 'Remove all these status mappings in one call: {ids}.' slots: ids: query.ids method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/orderstatusmappings({key})/customproperties({custompropertyKey})'].get update: x-apievangelist-phrasing: intent: Get a custom property of an order status mapping effect: read questions: - How do I read a custom property on an order status mapping? - Can I fetch one custom field value from a status mapping? instructions: - text: Get custom property {custompropertyKey} of status mapping {key}. slots: custompropertyKey: path.custompropertyKey key: path.key - text: Show custom field {custompropertyKey} on order status mapping {key}. slots: custompropertyKey: path.custompropertyKey key: path.key method: generated generated: '2026-09-26' - target: $.paths['/api/v1/orderstatusmappings'].get update: x-apievangelist-phrasing: intent: List order status mappings effect: read questions: - How are back-office order statuses mapped to what shoppers see? - Which order status mappings are configured for the storefront? instructions: - text: List the order status mappings. - text: Show how order statuses are mapped for display. method: generated generated: '2026-10-01'