IFS

IFS Inventory API

Parts and inventory management

OpenAPI Specification

ifs-inventory-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: IFS Cloud ERP Finance Inventory API
  description: IFS Cloud ERP REST API providing integration with financial management, procurement, manufacturing, project management, and supply chain modules. IFS Cloud exposes OData-compatible REST endpoints for accessing business entities across energy, manufacturing, aerospace, and defense industry verticals.
  version: 22.1.0
  contact:
    name: IFS Support
    url: https://www.ifs.com/support/
  license:
    name: IFS License
    url: https://www.ifs.com/
servers:
- url: https://{tenant}.ifs.cloud/main/ifsapp/data
  description: IFS Cloud REST API (OData endpoint)
  variables:
    tenant:
      default: yourcompany
      description: IFS Cloud tenant identifier
security:
- OAuth2: []
tags:
- name: Inventory
  description: Parts and inventory management
paths:
  /PART_CATALOG_API:
    get:
      operationId: listParts
      summary: List parts from part catalog
      description: Returns parts from the IFS part catalog with inventory balances and descriptions.
      tags:
      - Inventory
      parameters:
      - name: $filter
        in: query
        schema:
          type: string
      - name: $top
        in: query
        schema:
          type: integer
          default: 100
      - name: $skip
        in: query
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Parts returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartCollection'
components:
  schemas:
    PartCollection:
      type: object
      properties:
        '@odata.context':
          type: string
        '@odata.count':
          type: integer
        value:
          type: array
          items:
            $ref: '#/components/schemas/Part'
    Part:
      type: object
      properties:
        PartNo:
          type: string
        Description:
          type: string
        UnitMeas:
          type: string
          description: Unit of measure code
        PartType:
          type: string
          enum:
          - PURCHASED
          - MANUFACTURED
          - NOT_APPLICABLE
        DangerousGoodsClass:
          type: string
        NetWeight:
          type: number
        GrossWeight:
          type: number
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.ifs.cloud/oauth2/authorize
          tokenUrl: https://login.ifs.cloud/oauth2/token
          scopes:
            ifs.read: Read IFS data
            ifs.write: Write IFS data
externalDocs:
  description: IFS Cloud Documentation
  url: https://docs.ifs.com/