OpenAPI Specification
openapi: 3.1.0
info:
title: Oracle Retail Merchandising Foundation Cloud Service Fulfillment Returns API
description: Oracle Retail Merchandising Foundation Cloud Service (RMFCS) provides REST APIs for managing merchandise hierarchies, item setup, purchase orders, cost management, supplier management, and inventory transactions across omnichannel retail operations.
version: 26.1.0
contact:
name: Oracle Retail Support
url: https://support.oracle.com
license:
name: Oracle Technology Network License
url: https://www.oracle.com/legal/terms/
servers:
- url: https://{host}/MerchServices/MerchRes/v1
description: Oracle Retail Merchandising REST API
variables:
host:
default: retail.example.com
description: RMFCS hostname
security:
- oauth2: []
tags:
- name: Returns
description: Returns and refunds management
paths:
/returns:
post:
operationId: createReturn
summary: Create a return
description: Initiates a customer return authorization for one or more order lines.
tags:
- Returns
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnCreate'
responses:
'201':
description: Return authorization created
content:
application/json:
schema:
$ref: '#/components/schemas/Return'
'400':
$ref: '#/components/responses/BadRequest'
components:
responses:
BadRequest:
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
ReturnCreate:
type: object
required:
- orderId
- lines
properties:
orderId:
type: string
lines:
type: array
items:
type: object
required:
- lineId
- quantity
- reason
properties:
lineId:
type: string
quantity:
type: integer
reason:
type: string
Return:
type: object
properties:
returnId:
type: string
orderId:
type: string
status:
type: string
enum:
- PENDING
- APPROVED
- RECEIVED
- REFUNDED
lines:
type: array
items:
type: object
properties:
lineId:
type: string
quantity:
type: integer
reason:
type: string
createDatetime:
type: string
format: date-time
Error:
type: object
properties:
code:
type: string
message:
type: string
securitySchemes:
oauth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://identity.oraclecloud.com/oauth2/v1/token
scopes:
retail.read: Read retail data
retail.write: Write retail data