Salesforce Add API

The Add API from Salesforce — 2 operation(s) for add.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-add-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Add 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: Add
paths:
  /data/v64.0/commerce/webstores//carts/{webCartId}/cart-items:
    parameters: []
    post:
      tags:
      - Add
      summary: Salesforce Add an Item to a Cart
      operationId: Addanitemtoacart
      parameters:
      - name: effectiveAccountId
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - <EFFECTiVE_ACCOUNT_ID>
        example: '500123'
      - name: webCartId
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 'null'
        example: '500123'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddanitemtoacartRequest'
              - examples:
                - productId: <PRODUCT-ID>
                  quantity: 3
                  type: Product
              contentMediaType: application/json
            example:
              productId: <PRODUCT-ID>
              quantity: 3
              type: Product
        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
  /data/v64.0/tooling/sobjects/PlatformEventChannelMember/{PLATFORM_EVENT_CHANNEL_MEMBER_ID}:
    parameters: []
    patch:
      tags:
      - Add
      summary: Salesforce Add Enriched Fields to Channel Member
      operationId: Addenrichedfieldstochannelmember
      parameters:
      - name: PLATFORM_EVENT_CHANNEL_MEMBER_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddenrichedfieldstochannelmemberRequest'
              - examples:
                - FullName: Account_Channel_chn_AccountChangeEvent
                  Metadata:
                    enrichedFields:
                    - name: External_Account_ID__c
                    eventChannel: Account_Channel__chn
                    selectedEntity: AccountChangeEvent
              contentMediaType: application/json
            example:
              FullName: Account_Channel_chn_AccountChangeEvent
              Metadata:
                enrichedFields:
                - name: External_Account_ID__c
                eventChannel: Account_Channel__chn
                selectedEntity: AccountChangeEvent
        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:
    EnrichedField:
      title: EnrichedField
      required:
      - name
      type: object
      properties:
        name:
          type: string
          example: Example Title
      examples:
      - name: External_Account_ID__c
    Metadata2:
      title: Metadata2
      required:
      - enrichedFields
      - eventChannel
      - selectedEntity
      type: object
      properties:
        enrichedFields:
          type: array
          items:
            $ref: '#/components/schemas/EnrichedField'
          description: ''
          example: []
        eventChannel:
          type: string
          example: example_value
        selectedEntity:
          type: string
          example: example_value
      examples:
      - enrichedFields:
        - name: External_Account_ID__c
        eventChannel: Account_Channel__chn
        selectedEntity: AccountChangeEvent
    AddenrichedfieldstochannelmemberRequest:
      title: AddenrichedfieldstochannelmemberRequest
      required:
      - FullName
      - Metadata
      type: object
      properties:
        FullName:
          type: string
          example: example_value
        Metadata:
          $ref: '#/components/schemas/Metadata2'
      examples:
      - FullName: Account_Channel_chn_AccountChangeEvent
        Metadata:
          enrichedFields:
          - name: External_Account_ID__c
          eventChannel: Account_Channel__chn
          selectedEntity: AccountChangeEvent
    AddanitemtoacartRequest:
      title: AddanitemtoacartRequest
      required:
      - productId
      - quantity
      - type
      type: object
      properties:
        productId:
          type: string
          example: '500123'
        quantity:
          type: integer
          contentEncoding: int32
          example: 10
        type:
          type: string
          example: example_value
      examples:
      - productId: <PRODUCT-ID>
        quantity: 3
        type: Product
  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}".

        '