On this page

Overview

Use this Snap to read Coupa resource records such as suppliers, by using the relevant resource APIs. You can choose the detail-level of the output and additionally use query parameters to filter the result. Moreover, you can also query a specific record by using the record's ID.

Prerequisites

Limitations

None.

Troubleshooting

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsCompatible Upstream and Downstream SnapsDescription
Input Document
  • Min: 0
  • Max: 1
  • Mapper Snap
  • Copy Snap
Optional. Use upstream Snaps when querying a specific resource record using the record's ID.
OutputDocument
  • Min: 1
  • Max: 1
  • Document to Binary + File Writer

JSON document containing the record details. Level of detail varies according to the configuration of the Response Type field.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 
LabelStringRequired. The name for the Snap. We recommend you update the Snap name, if there is more than one of the same Snap in your Pipeline.N/ACoupa Read

Response Type

String

Specifies the level of detail required in the Snap's output. You can configure this keeping in mind the available memory and likely processing time that it would take to execute this Snap. 

Available options are:

  • all: Output contains all details of the selected resource.
  • limited: Output contains only the records' ID.
  • shallow: Output contains ID as well as the direct child attributes of each record.

See API Return Formats for more details.

alllimited
Coupa API NameString

Required. The API name associated with the target resource. Select the target resource from the suggestions in the field. Suggestions vary based on the SnapLogic Coupa account.

When fetching resource elements such as id, (for example, suppliers/:id), you must provide the query value as an upstream parameter.


N/Asuppliers
Query ParametersN/A

The query parameters and the values to be used to filter the results of the query. See Querying Options for details.

Click + to add query parameters.

N/AN/A
Query ParameterStringThe parameter to be used to filter the results of the query. You can also include operators along with the arguments based upon your requirements. See API Operators for details.
  • limit
  • email
  • email[not_eq]
Query Parameter ValueString/IntegerThe value corresponding to the specified parameter.
  • 7
  • john.doe@company.com
Snap ExecutionN/A

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.
  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Validate & ExecuteExecute only

Examples

Fetching and Updating Inactive Records

This example demonstrates how you can fetch one inactive Coupa supplier record and update one of its custom fields.

Download the example Pipeline.

The Coupa Read Snaps is configured as shown below:

Use Query Parameters field-set to filter the records. The Snap fetches all the supplier records, if this filter is not applied.

Based on this configuration, the Snap fetches the topmost inactive record for the supplier named Dell (USA). 

In this example, we want to update one of the custom fields in the fetched record. To update a resource record, pass the record ID to the Coupa Update Snap. To do so, use the Mapper Snap connected to both Coupa Read and Coupa Update Snap. Additionally, provide the values to be updated. For example, custom-field-5 and John Doe in this case.

This Mapper Snap is configured as shown below:

Output from the Mapper Snap:

This data is passed into the Coupa Update Snap which is configured as shown below: 

The response type is limited; therefore, only the updated data is shown in the output: 

Downloads

See Also