Jump to

• Request
• Response
• Examples

Get Commerce Integrations

get

/rest/v19/commerceProcessSetups/{processVarName}/integrations

Use this endpoint to retrieve available integrations for the specified Commerce Process.

Request

Path Parameters

• processVarName(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : AdminCollectionResponseModel_IntegrationsListModel

Type: object

Show Source

• items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IntegrationsListModel"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object IntegrationsListModel

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/IntegrationsListModel"
    }
}

Nested Schema : IntegrationsListModel

Type: object

Show Source

• description: string()
  Title: Description

  Description of the Integration
• id: integer()
  Title: Id

  Id of the Integration item
• idField: string()
  Title: Id Field

  This field indicates which Commerce attribute stores the external ID of the object being updated by the integration
• modifiedDate: string()
  Title: Modified Date

  Latest Date in which the Integration was modified.
• name: string()
  Title: Name

  Name of the Integration
• orderNo: integer()
  Title: Order No

  Order no of the Integration in the list
• type: string()
  Title: Type

  Type of the Integration

{
    "properties":{
        "id":{
            "type":"integer",
            "format":"",
            "description":"Id of the Integration item",
            "title":"Id"
        },
        "orderNo":{
            "type":"integer",
            "format":"",
            "description":"Order no of the Integration in the list",
            "title":"Order No"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Integration",
            "title":"Name"
        },
        "type":{
            "type":"string",
            "format":"",
            "description":"Type of the Integration",
            "title":"Type"
        },
        "idField":{
            "type":"string",
            "format":"",
            "description":"This field indicates which Commerce attribute stores the external ID of the object being updated by the integration",
            "title":"Id Field"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Integration",
            "title":"Description"
        },
        "modifiedDate":{
            "type":"string",
            "format":"",
            "description":"Latest Date in which the Integration was modified.",
            "title":"Modified Date"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve available integrations for the specified Commerce Process by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/commerceProcessSetups/oraclecpqo/integrations

Response Body Sample

{
  "items": [{
      "orderNo": 5,
      "name": "Sync Quote Lines",
      "type": "REST - Export Lines",
      "idField": "transaction.oRCL_SFA_TransactionID_t",
      "description": "Creates, updates or deletes the SFA quote line",
      "modifiedDate": "09/23/2024 02:32"
    }
  ]
}

Back to Top