...

In this article

Overview

You can use this Snap to calculate generate refund transactions based on line and shipped itemsfor an order.

Prerequisites

None.

Support for Ultra Pipelines

...

Known Issues

None.

...

Known Issues

None.

Snap Input and Output

...

Example

Calculating Refund For An Order

This example Pipeline demonstrates how to calculate refund for an order and subsequently create an Order Refund using the Calculate Order Refund and Create Order Refund Snaps.

Image Added

First, we pass the following customer and order data using the JSON Generator Snap.

[
    {
        "email": "john.doe@snaplogic.com",
        "phone": "9533322211",
        "test": true,
        "line_items": [
            {
                "variant_id": 40273525866686,
                "product_id": 6863881928894,
                "quantity": 1
            }
        ],
        "transactions": [
            {
                "kind": "sale",
                "status": "success",
                "amount": 5000
            }
        ],
        "billing_address": {
            "address1": "Sector-1",
            "address2": "Apartment 5",
            "city": "Vishakapatnam",
            "company": null,
            "country": "India",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "9533322211",
            "province": "AP",
            "zip": "530046",
            "name": "John",
            "country_code": "IN"
        },
        "shipping_address": {
            "address1": "Sector-1",
            "address2": "Apartment 5",
            "city": "Vishakapatnam",
            "company": null,
            "country": "India",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "9533322211",
            "province": "AP",
            "zip": "530046",
            "name": "John",
            "country_code": "IN"
        }
    }
]

Upon validation, we see the following data in the output preview of the Snap.

[
	{
		"email":"john.doe@snaplogic.com"
		"phone":"9533322211"
		"test":true
		"line_items":
	[
	{
		"variant_id":40273525866686
		"product_id":6863881928894
		"quantity":1
	}
]
		"transactions":
[
	{
		"kind":"sale"
		"status":"success"
		"amount":5000
	}
]
		"billing_address":
	{
		"address1":"Sector-1"
		"address2":"Apartment 5"
		"city":"Vishakapatnam"
		"company":null
		"country":"India"
		"first_name":"John"
		"last_name":"Doe"
		"phone":"9533322211"
		"province":"AP"
		"zip":"530046"
		"name":"John"
		"country_code":"IN"
}
		"shipping_address":
	{
		"address1":"Sector-1"
		"address2":"Apartment 5"
		"city":"Vishakapatnam"
		"company":null
		"country":"India"
		"first_name":"John"
		"last_name":"Do"
		"phone":"9533322211"
		"province":"AP"
		"zip":"530046"
		"name":"Rohit"
		"country_code":"IN"
		}
	}
]

Next, we configure the Create Order Snap to create an order. On validation, the Snap creates an order.

Create Order Snap Configuration	Output
Image Added	Image Added

Next, we configure the first Mapper Snap to map the ID against the Order Id column.
Image Added

Upon validation, the Snap generates the following data in the output preview of the Snap.
Image Added

Next, we configure the JSON Splitter Snap to split each item in the line items into separate documents. We specify the $line_items for Json Path and $order_id (path of the object) for Include Path to include in the output.
Image Added

Upon validation, we see the value for each line item in the order separately.
Image Added

Next, we configure the second Mapper Snap to map the following attributes in the line item.
Image Added

Upon validation, the Snap generates the line item data as configured.
Image Added

Next, we use the Group by Fields Snap to group the line items by Order ID. However, we are only interested in refund line items; hence, we specify refund_line_items in the Target field. Upon validation we see the list of items grouped under refund_line_items object.

Next, we use the Mapper Snap to pass the refund line items output from the upstream Snap to calculate order refund subsequently.
Image Added

Upon validation, the Snap generates the refund order data as follows.
Image Added

Next, we configure the Calculate Order Refund Snap to calculate the refund for the order.
Image Added

Upon validation, the Snap generates the status of the refund (full refund in this case) and other details, such as quantity, line_item_id, orderId, and location_id.
Image Added

Next, we use the fourth and the last Mapper Snap in our Pipeline to pass the details as highlighted below to use the Snap's output in the downstream Snap for creating an order refund.
Image Added

We configure the Create Order Refund Snap to create a refund for the order.
Image Added

Upon validation, the Snap generates a refund for the order and we can view the related refund data in the output preview of the Snap.
Image Added

We further use the JSON formatter Snap to format the JSON file, and write the document on to SL database using the File Writer Snap.

Download this Pipeline.

Downloads

...

• Order Refunds API
• Getting Started with SnapLogic
• Snap Support for Ultra PipelinesSnapLogic Product Glossary