Versions Compared

Old Version 1

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version Current

changes.mady.by.user Gouri Bhagchandani

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

Note
titleGeneral Guidelines. Remove Before Publishing.
  • Always use title casing for Heading formats 1 and 2.
  • Always use active voice.
  • Do not use "Please" anywhere in the document.
  • Screenshots
    • Always use the New Form UI.
    • Be optically similar. Max size 1000 px or corresponding gridline size as in the style guide.
    • Do not capture Snap borders when showing configurations in the Examples section. You can add a border in the editor here.
    • See Image Style Guidefor details.
  • Examples must always use first-person plural references. You can use the second-person if needed depending upon the example's content.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

...

Use You can use this Snap to ...

Prerequisites

read list of product variants or a specific product variant.
Image Added

Prerequisites

A valid account with the required permissions.

None.

Support for Ultra Pipelines

...

Works in Ultra Pipelines. 

...

Limitations

None.

Limitations

Insert excerpt
Calculate Order Refund
Calculate Order Refund
nopaneltrue

Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

Binary
Binary or

Document



  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • ..
    • Requires the EDI data and internal ID as a JSON document


    		You must pass product ID. Upstream Snap is optional.
    Output

    Document

    Binary

    Binary or Document


    • Min:1
    • Max:1
    • ..
    • ..
    The EDI transaction ID and order confirmation.
    • JSON Formatter
    • CSV Formatter

    Gets a list of product variants or a specific product variant. 

    Snap Settings

    ...

    Batch execution failed

    ...

    The Pipeline ended before the batch could complete execution due to a connection error.

    Verify that the Batch size field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.

    Examples

    Excluding Fields from the Input Data Stream

    We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> to achieve this result:

    <screenshot of Pipeline/Snap and description>

    Download this Pipeline. 

    Downloads

    Note
    titleImportant Steps to Successfully Reuse Pipelines
    1. Download and import the Pipeline into SnapLogic.
    2. Configure Snap accounts as applicable.
    3. Provide Pipeline parameters as applicable.
    Attachments
    patterns*.slp, *.zip

    ...


    Field Name

    ...

    titleDocumenting Fields Based On Data Type/UI Element

    **Delete Before Publishing**

    Choose from the following sentences to document specific field types.

    ...

    • <State what the field contains>. Available options are: <bullet list of LoVs>
      The Salesforce API to be used. Available options are:...
    • Select the <category> that you want to use. Available options are...
      * Option 1<italicized>: <third person singular form of the verb>
      * Option 2<italicized>: <third person singular form of the verb>
      Select the API that you want to use. Available options are:
      Bulk API: Sends the Snap execution request details as a bulk API call.
      REST API: ...
    • Indicates.... Available options are:
      Indicates how the Snap must be executed. Available options are:
      * 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.

    Check boxes:

    • If selected, <Snap behavior>.
      If selected, an empty file is written when the incoming document has no data.
    • If selected, <behavior>. If not selected/Otherwise, <behavior>
      Use "If not selected" if the first sentence is long.
      If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
      If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.
    • Select to <action>
      Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
      Select to execute the Pipeline during validation.

    Text Fields

    • Describe what the user must/must not do. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
      The name of the account.
      Enter the account ID that you want to use to log in to the endpoint.
      Required if IAM Role is selected.
      Do not use this field if you are using batch processing.

    Numeric Text Fields

    • Describe what the user must/must not do. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
      Enter the number of records in a batch.
      Enter the number of seconds for which you want the Snap to wait between retries.
      Enter the number of seconds for which the Snap waits between retries.
      Use the following special values:
      * 0: Disables batching.
      * 1: Includes all documents in a single request.

    ...

    Field Sets

    Specify advanced parameters that you want to include in the request.

    This fieldset consists of the following fields:

    • Field 1
    • Field 2
    • Field 3

    Troubleshooting

    ...

    Field Dependency
    Description
    Label*N/A

    Specify the name for the Snap. You can modify the default name to be specific and meaningful, especially if you have more than one of the same Snap in your Pipeline.

    Default Value: Get Product Variants
    Example: Get Product Variants

    Version*N/A

    Specify the Shopify API version. Alternatively, click the Suggestion Image Added icon to fetch the list of Shopify API versions.

    Default Value: 2021-07
    Example: 2021-04

    Product Id*N/A

    Specify a unique identifier for the product.

    Default Value: N/A
    Example: pro_id

    Resource IdN/A

    Specify a unique identifier for the product variant.

    Default Value: N/A
    Example: var_id

    Parameters

    Use this field set to define object parameters ad their values. This field set contains the following fields:

    • Parameter
    • Parameter value
    ParameterN/A

    Specify an optional parameter for the product variant.

    Default Value: N/A
    Example: limit

    Parameter valueN/A

    Specify a value for the parameter.

    Default Value: N/A
    Example: 5

    Number Of RetriesN/A

    Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.

    Default Value: 1 
    Example: 2 

    Retry Interval (Seconds)N/A

    Specify the duration in seconds for which the Snap must wait between two reconnection attempts, until the number of retries is reached.

    Default Value: 1 
    Example: 5 

    Snap ExecutionN/A

    Select one of the three modes in which the Snap executes. Available options are:

    • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
    • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

    • Disabled: Disables the Snap and all Snaps that are downstream from it.

    Default Value: Validate & Execute
    Example: Execute only


    Insert excerpt
    Create Order
    Create Order
    nopaneltrue

    Insert excerpt
    Shopify Snap Pack
    Shopify Snap Pack
    nopaneltrue

    ...

    See Also