openapi: 3.1.0
info:
  title: Oracle Fusion Cloud Applications Oracle Fusion Common Features REST Absences Shipments API
  description: REST APIs for Oracle Fusion Cloud Applications Common features, providing access to shared services such as attachments, flexfields, lookup types, roles, users, security, scheduled processes, announcements, and approval workflows used across all Fusion Cloud application pillars.
  version: 11.13.18.05
  contact:
    name: Oracle Support
    url: https://support.oracle.com
    email: support@oracle.com
  license:
    name: Oracle Cloud Services Agreement
    url: https://www.oracle.com/corporate/contracts/cloud-services/
  termsOfService: https://www.oracle.com/corporate/contracts/cloud-services/
servers:
- url: https://{instance}.oraclecloud.com
  description: Oracle Fusion Cloud Instance
  variables:
    instance:
      default: servername
      description: Your Oracle Cloud instance identifier
security:
- bearerAuth: []
tags:
- name: Shipments
  description: Shipping and receiving operations
paths:
  /fscmRestApi/resources/11.13.18.05/shipments:
    get:
      operationId: listShipments
      summary: Oracle Fusion Cloud Applications List shipments
      description: Retrieve shipment records including delivery details, tracking, and shipping status.
      tags:
      - Shipments
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/finder'
      responses:
        '200':
          description: Shipments retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Shipment'
                  count:
                    type: integer
                  hasMore:
                    type: boolean
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    q:
      name: q
      in: query
      required: false
      schema:
        type: string
    offset:
      name: offset
      in: query
      required: false
      schema:
        type: integer
        default: 0
    fields:
      name: fields
      in: query
      required: false
      schema:
        type: string
    limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 25
        maximum: 500
    finder:
      name: finder
      in: query
      required: false
      schema:
        type: string
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
  schemas:
    Shipment:
      type: object
      properties:
        ShipmentId:
          type: integer
          description: Shipment identifier
        ShipmentNumber:
          type: string
          description: Shipment number
        DeliveryName:
          type: string
          description: Delivery name
        ShipFromOrganization:
          type: string
          description: Ship from organization
        ShipToCustomer:
          type: string
          description: Ship to customer
        ShipToAddress:
          type: string
          description: Ship to address
        Carrier:
          type: string
          description: Carrier name
        TrackingNumber:
          type: string
          description: Tracking number
        ShipDate:
          type: string
          format: date
          description: Ship date
        DeliveryDate:
          type: string
          format: date
          description: Expected delivery date
        Status:
          type: string
          description: Shipment status
          enum:
          - Open
          - Packed
          - Shipped
          - In Transit
          - Delivered
          - Closed
        Weight:
          type: number
          format: double
          description: Total weight
        WeightUom:
          type: string
          description: Weight unit of measure
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Oracle Fusion Cloud Applications Common Features REST API Documentation
  url: https://docs.oracle.com/en/cloud/saas/applications-common/26a/farca/index.html