Get Order Refund

In this article

Overview

You can use this Snap to fetch a list of refunds for an order or a specific refund of an order.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

  • API versions: Shopify releases new API versions every quarter. Each stable version is supported only for a minimum of 12 months. Part of a Shopify API is deprecated if it becomes unnecessary, unsafe, or outdated. The API’s are marked as deprecated when they are removed in a newer version of the API. The deprecation is then retroactively applied to previous stable versions of the API.
  • API Rate Limit: All Shopify APIs are rate-limited. Shopify uses various strategies to enforce rate limits, such as Calculated query cost, Request-based limit, and Time-based limit. 
    Shopify Snap Pack uses admin APIs, which are applicable for Request-based limit. If the APIs cross the rate limit, the Snap fails.

    API

    Rate-limiting method

    Standard limit

    Shopify Plus limit

    Admin API

    (GraphQL)

    Calculated query cost

    50 points/second

    100 points/second

    Admin API

     (REST)

    Request-based limit

    2 requests/second

    4 requests/second

Shopify Behavior

  • When you create an order for a product, you cannot apply discount on a line item. If the associated discount application is of type code, the Snap returns the discount code that was entered at checkout. Else, the Snap returns the title of the discount that was applied. See Discount APIs for more information.
  • This Snap gets data for non existing orders also.
  • This Snap does not get the count of orders.
  • Order discount is applied for invalid discount codes. The discount percentage or amount is allotted more than percentage/amount set for valid discount code. For example, summer20 is a valid discount code, which should apply 20% of discount. However, if we provide discount percentage as 50%, then it applies 50% discount ignoring the set discount percentage.

Known Issues

None.

Snap Input and Output

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

Document


  • Min:0
  • Max:1
  • Mapper
  • Copy

You must pass Order ID and refund ID to get the specific order refund. Upstream Snap is optional.

Output

Document

  • Min:1
  • Max:1
  • Get Orders
  • Mapper

The order refund ID.

Snap Settings

Field Name
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.

DefaultValueGet Order Refund
ExampleGet Order Refund_300

Version*N/A

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

DefaultValue2021-07
Example:2021-04

Order Id*N/A

Specify a unique identifier for the order.

DefaultValue: N/A
Example: 988

Resource IdN/A

Specify a unique identifier for the refund.

DefaultValue: N/A
Example: res_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 a query parameter.

DefaultValue: N/A
Example: limit

Parameter valueN/A

Specify a value for the parameter.

DefaultValue: 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.

DefaultValue1
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.

DefaultValue1
Example: 2

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.

DefaultValueValidate & Execute
Example: Execute only

Troubleshooting

ErrorReasonResolution

"402 Payment Required"

The requested shop is currently frozen. You need to log in as admin user and pay the outstanding balance to unfreeze the shop.
"404 Not Found"The requested resource is not found.The resource could be available again in the future.

"406 Not Acceptable"

The requested resource is only capable of generating content, but not acceptable according to the Accept headers sent in the request.N/A
"409 error"This is an intermittent error that you can encounter when there is a conflict in your orders, products, or customer data. For example, when you use unsupported characters.Check for the conflicts in your metadata and rerun the Pipeline.
"422 Unprocessable Entity"

The request body was well-formed but contains semantic errors. You can encounter a 422 error from a variety of scenarios including, but not limited to:

  • Formatting of the input is incorrect.

  • Checking out products that are out of stock.

  • Canceling an order that has fulfillments.

  • Creating an order with tax lines on both line items and the order.

  • Creating a customer without an email or name

  • Creating a product without a title.

The response body provides details in the errors or error parameters. Fix the error parameters as given in the error description.
"422 empty entity error"You might be sending null or empty or unsupported data. Check the data and fix the null or empty data.

"423 locked"

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.

Wait for Shopify to unlock your account after the specified amount of time, after which you should be able to continue working on your Pipeline, or contact support if your shop is locked.

"429 Too Many Requests"Shopify APIs use different API rate-limiting methods. If the APIs exceeds the rate limit, the Snap fails.See the API Call Limit documentation for a breakdown of Shopify's rate-limiting mechanism.
"500 Internal Server Error"An internal error in Shopify application causes this error. Post the error details to the API and Technology forum so that Shopify staff can investigate the issue.

"501 Not Implemented"

The requested endpoint is not available on that particular shop, for example, requesting access to a Plus-specific API on a non-Plus shop. This response may also indicate that this endpoint is reserved for future use.N/A
"504 Gateway Timeout"The request could not complete in time. Shopify waits up to 10 seconds for a response.Break down the request in multiple smaller requests.

Example

Getting A Specific Order Refund

This is a simple example of a stand-alone Pipeline that demonstrates how we can get details of a specific order refund. This example assumes that you have configured a valid Shopify account to be used with this Snap.

We configure the Get Order Refund Snap to fetch the order refund details bearing the Order Id 3993490194622 and Resource Id 813559251134.

Upon validation, the Snap gets the order refund data associated with the order.

Snap Pack History

 Click here to expand...
Snap Pack Version 

Release

Date

Type

Updates

4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27main12833 StableUpgraded with the latest SnapLogic Platform release.
4.26 

main11181

Latest

Introduced the Shopify Snap Pack that enables businesses to set up an online store and sell their products online with ease. You can use this Snap Pack to create orders, products, customers, and run automated workflows. This Snap Pack offers the following Snaps:


See Also