Salesforce

Salesforce Journals API

The Journals API from Salesforce — 1 operation(s) for journals.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_job_info.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/bulk_api_2_0_security.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list.htm
📖
Documentation
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/rest-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/get-started-spec.html
📖
APIReference
https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_overview.html
📖
Authentication
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/access-token-s2s.html
📖
Documentation
https://developer.salesforce.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-journals-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/json-schema/salesforce-bulk-job-schema.json

OpenAPI Specification

salesforce-journals-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Journals 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: Journals
paths:
  /data/v64.0/connect/realtime/loyalty/programs/{loyaltyProgramName}:
    parameters: []
    post:
      tags:
      - Journals
      summary: Salesforce Transaction Journals Execution
      description: 'Standard Documentation:


        [https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_loyalty_program_realtime.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_loyalty_program_realtime.htm)'
      operationId: TransactionJournalsExecution
      parameters:
      - name: loyaltyProgramName
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TransactionJournalsExecutionRequest'
              - examples:
                - transactionJournals:
                  - ActivityDate: '2023-11-27T12:45:19.000Z'
                    JournalTypeId: 0lERM00000001Bb2AI
                    LoyaltyProgramId: 0lpRM00000002YTYAY
                    MemberId: 0lMRM0000002Fmu2AE
                    Status: Pending
                    appliedPromotions:
                    - promotionId: 0c8RM0000004FiXYAU
                      rewards:
                      - rewardType: Discount
                        discountAmount: 15
                      - rewardType: Points
                        loyaltyProgramCurrencyName: Coins
                        points: 100
                        relatedInformation: Test
                        notes: Test
                      - rewardType: Voucher
                        voucherDefinitionName: 10% Discount Voucher
                        voucherExpirationDate: '2023-12-15T00:00:00.000Z'
                        voucherEffectiveDate: '2023-11-29T00:00:00.000Z'
                        notes: Test
                      - rewardType: Badge
                        loyaltyProgramBadgeName: Gen AI Badge
                        memberBadgeStatus: Active
                        badgeValidityEndDate: '2023-12-15T00:00:00.000Z'
                        reason: Test
                      - rewardType: Game
                        gameDefinitionName: TestGame
              contentMediaType: application/json
            example:
              transactionJournals:
              - ActivityDate: '2023-11-27T12:45:19.000Z'
                JournalTypeId: 0lERM00000001Bb2AI
                LoyaltyProgramId: 0lpRM00000002YTYAY
                MemberId: 0lMRM0000002Fmu2AE
                Status: Pending
                appliedPromotions:
                - promotionId: 0c8RM0000004FiXYAU
                  rewards:
                  - rewardType: Discount
                    discountAmount: 15
                  - rewardType: Points
                    loyaltyProgramCurrencyName: Coins
                    points: 100
                    relatedInformation: Test
                    notes: Test
                  - rewardType: Voucher
                    voucherDefinitionName: 10% Discount Voucher
                    voucherExpirationDate: '2023-12-15T00:00:00.000Z'
                    voucherEffectiveDate: '2023-11-29T00:00:00.000Z'
                    notes: Test
                  - rewardType: Badge
                    loyaltyProgramBadgeName: Gen AI Badge
                    memberBadgeStatus: Active
                    badgeValidityEndDate: '2023-12-15T00:00:00.000Z'
                    reason: Test
                  - rewardType: Game
                    gameDefinitionName: TestGame
        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:
    TransactionJournal3:
      title: TransactionJournal3
      required:
      - ActivityDate
      - JournalTypeId
      - LoyaltyProgramId
      - MemberId
      - Status
      - appliedPromotions
      type: object
      properties:
        ActivityDate:
          type: string
          example: example_value
        JournalTypeId:
          type: string
          example: '500123'
        LoyaltyProgramId:
          type: string
          example: '500123'
        MemberId:
          type: string
          example: '500123'
        Status:
          type: string
          example: example_value
        appliedPromotions:
          type: array
          items:
            $ref: '#/components/schemas/AppliedPromotion'
          description: ''
          example: []
      examples:
      - ActivityDate: '2023-11-27T12:45:19.000Z'
        JournalTypeId: 0lERM00000001Bb2AI
        LoyaltyProgramId: 0lpRM00000002YTYAY
        MemberId: 0lMRM0000002Fmu2AE
        Status: Pending
        appliedPromotions:
        - promotionId: 0c8RM0000004FiXYAU
          rewards:
          - rewardType: Discount
            discountAmount: 15
          - rewardType: Points
            loyaltyProgramCurrencyName: Coins
            points: 100
            relatedInformation: Test
            notes: Test
          - rewardType: Voucher
            voucherDefinitionName: 10% Discount Voucher
            voucherExpirationDate: '2023-12-15T00:00:00.000Z'
            voucherEffectiveDate: '2023-11-29T00:00:00.000Z'
            notes: Test
          - rewardType: Badge
            loyaltyProgramBadgeName: Gen AI Badge
            memberBadgeStatus: Active
            badgeValidityEndDate: '2023-12-15T00:00:00.000Z'
            reason: Test
          - rewardType: Game
            gameDefinitionName: TestGame
    TransactionJournalsExecutionRequest:
      title: TransactionJournalsExecutionRequest
      required:
      - transactionJournals
      type: object
      properties:
        transactionJournals:
          type: array
          items:
            $ref: '#/components/schemas/TransactionJournal3'
          description: ''
          example: []
      examples:
      - transactionJournals:
        - ActivityDate: '2023-11-27T12:45:19.000Z'
          JournalTypeId: 0lERM00000001Bb2AI
          LoyaltyProgramId: 0lpRM00000002YTYAY
          MemberId: 0lMRM0000002Fmu2AE
          Status: Pending
          appliedPromotions:
          - promotionId: 0c8RM0000004FiXYAU
            rewards:
            - rewardType: Discount
              discountAmount: 15
            - rewardType: Points
              loyaltyProgramCurrencyName: Coins
              points: 100
              relatedInformation: Test
              notes: Test
            - rewardType: Voucher
              voucherDefinitionName: 10% Discount Voucher
              voucherExpirationDate: '2023-12-15T00:00:00.000Z'
              voucherEffectiveDate: '2023-11-29T00:00:00.000Z'
              notes: Test
            - rewardType: Badge
              loyaltyProgramBadgeName: Gen AI Badge
              memberBadgeStatus: Active
              badgeValidityEndDate: '2023-12-15T00:00:00.000Z'
              reason: Test
            - rewardType: Game
              gameDefinitionName: TestGame
    AppliedPromotion:
      title: AppliedPromotion
      required:
      - promotionId
      - rewards
      type: object
      properties:
        promotionId:
          type: string
          example: '500123'
        rewards:
          type: array
          items:
            $ref: '#/components/schemas/Reward'
          description: ''
          example: []
      examples:
      - promotionId: 0c8RM0000004FiXYAU
        rewards:
        - rewardType: Discount
          discountAmount: 15
        - rewardType: Points
          loyaltyProgramCurrencyName: Coins
          points: 100
          relatedInformation: Test
          notes: Test
        - rewardType: Voucher
          voucherDefinitionName: 10% Discount Voucher
          voucherExpirationDate: '2023-12-15T00:00:00.000Z'
          voucherEffectiveDate: '2023-11-29T00:00:00.000Z'
          notes: Test
        - rewardType: Badge
          loyaltyProgramBadgeName: Gen AI Badge
          memberBadgeStatus: Active
          badgeValidityEndDate: '2023-12-15T00:00:00.000Z'
          reason: Test
        - rewardType: Game
          gameDefinitionName: TestGame
    Reward:
      title: Reward
      required:
      - rewardType
      type: object
      properties:
        rewardType:
          type: string
          example: example_value
        discountAmount:
          type: integer
          contentEncoding: int32
          example: 42
        loyaltyProgramCurrencyName:
          type: string
          example: example_value
        points:
          type: integer
          contentEncoding: int32
          example: 10
        relatedInformation:
          type: string
          example: example_value
        notes:
          type: string
          example: example_value
        voucherDefinitionName:
          type: string
          example: example_value
        voucherExpirationDate:
          type: string
          example: example_value
        voucherEffectiveDate:
          type: string
          example: example_value
        loyaltyProgramBadgeName:
          type: string
          example: example_value
        memberBadgeStatus:
          type: string
          example: example_value
        badgeValidityEndDate:
          type: string
          example: example_value
        reason:
          type: string
          example: example_value
        gameDefinitionName:
          type: string
          example: example_value
      examples:
      - rewardType: Discount
        discountAmount: 15
  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}".

        '