Salesforce Product API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Product API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Product
paths:
  /data/v64.0/sobjects/OpportunityLineItem/{OPPORTUNITY_LINE_ITEM_ID}/OpportunityLineItemSchedules:
    parameters: []
    get:
      tags:
      - Product
      summary: Salesforce Product Schedules
      description: 'Work with revenue and quantity schedules for opportunity products. Establish or reestablish a product schedule with multiple installments for an opportunity product. Delete all installments in a schedule.

        This resource is available in REST API version 43.0 and later.


        In API version 46.0 and later, established and re-established schedules support custom fields, validation rules, and Apex triggers. Deleting all schedules now also fires delete triggers.

        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_opportunitylineitemschedules.htm'
      operationId: ProductSchedules
      parameters:
      - name: OPPORTUNITY_LINE_ITEM_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/commerce/catalog-products/actions/get-products:
    parameters: []
    post:
      tags:
      - Product
      summary: Salesforce Request Product Information (no Bundles)
      description: 'Request information for two products that aren''t bundles. For the first product, request only the information about the specified product selling model. For the second product, request information about all related product selling models.


        See [Request Product Information](https://desktop.postman.com/?desktopVersion=10.13.6&webVersion=10.13.7-ui-230522-1730&userId=10709048&teamId=0).'
      operationId: RequestProductInformation(NoBundles)
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RequestProductInformationNoBundlesRequest'
              - examples:
                - productContexts:
                  - product2Id: '{{ClassTrainingProduct}}'
                    productSellingModelId: '{{OneTimePSM}}'
                  - product2Id: '{{VirtualRouterProduct}}'
                  fields:
                  - id
                  - name
                  - IsActive
                  - ProductCode
                  retrievalType: ExcludeChildComponents
              contentMediaType: application/json
            example:
              productContexts:
              - product2Id: '{{ClassTrainingProduct}}'
                productSellingModelId: '{{OneTimePSM}}'
              - product2Id: '{{VirtualRouterProduct}}'
              fields:
              - id
              - name
              - IsActive
              - ProductCode
              retrievalType: ExcludeChildComponents
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    RequestProductInformationNoBundlesRequest:
      title: RequestProductInformationNoBundlesRequest
      required:
      - productContexts
      - fields
      - retrievalType
      type: object
      properties:
        productContexts:
          type: array
          items:
            $ref: '#/components/schemas/ProductContext'
          description: ''
          example: []
        fields:
          type: array
          items:
            type: string
          description: ''
          example: []
        retrievalType:
          type: string
          example: example_value
      examples:
      - productContexts:
        - product2Id: '{{ClassTrainingProduct}}'
          productSellingModelId: '{{OneTimePSM}}'
        - product2Id: '{{VirtualRouterProduct}}'
        fields:
        - id
        - name
        - IsActive
        - ProductCode
        retrievalType: ExcludeChildComponents
    ProductContext:
      title: ProductContext
      required:
      - product2Id
      type: object
      properties:
        product2Id:
          type: string
          example: '500123'
        productSellingModelId:
          type: string
          example: '500123'
      examples:
      - product2Id: '{{ClassTrainingProduct}}'
        productSellingModelId: '{{OneTimePSM}}'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '