...
- 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.
...
...
| title | General Guidelines. Remove Before Publishing. |
|---|
In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Use this Snap to ... Sends an invoice for the draft order.
Prerequisites
- Valid client ID.
- A valid account with the required permissions.
None.
Support for Ultra Pipelines
...
Works in Ultra Pipelines.
...
Limitations
...
Limitations <TBD>
- API Versions.
- API Rate limit.
Known Issues
None.
Snap Input and Output
...
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description | |||||
|---|---|---|---|---|---|---|---|---|---|
| Input Document Binary | Binary or Document |
|
| Requires the EDI data and internal ID as a JSON document. | Output | Document Binary Binary or Document |
|
| The EDI transaction ID and order confirmationThe draft invoice order ID. For example, { |
| Output | Binary |
|
| The draft invoice order object. |
Snap Settings
...
| title | Documenting Fields Based On Data Type/UI Element |
|---|
**Delete Before Publishing**
Choose from the following sentences to document specific field types.
...
| Parameter | Data Type | Description | Default Value | Example |
|---|---|---|---|---|
| Label | String | Required. 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 Snaps in your pipeline. | Send Invoice | Ord_312 |
| Version | String/Expression | Required. Specify the Shopify API version. Alternatively, click the Suggestion  icon to fetch the list of Shopify API versions. | 2021-04 | 2021-04 |
| Order ID | String/Expression | Required. Specify a unique identifier for the order. | ||
| Number Of Retries | Integer/Expression | Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout. | 1 | 2 |
| Retry Interval (Seconds) | Integer/Expression | Specify the duration in seconds for which the Snap must wait between two reconnection attempts, until the number of retries is reached. | 1 | 5 |
| Snap Execution | Drop-down list | Select one of the three modes in which the Snap executes. Available options are:
|
...
|
...
|
...
|
...
|
...
|
...
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
...
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
...
| Execute only | Validate & Execute |
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
| 423 error. | The requested shop is currently locked. Shops are locked if they repeatedly exceed their API request limit, or if there is an issue with the account, such as a detected compromise or fraud risk. | Contact support if your store is locked. |
Examples
Sending an Invoice
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:
...
| Attachments | ||
|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...
See Also
- Endpoint Doc Link 1
- Endpoint Doc Link 2
- Endpoint Doc Link 3Shopify - Send draft invoice orders
- Getting Started with SnapLogic
- Snap Support for Ultra Pipelines
- SnapLogic Product Glossary