Full RMA webhook

Full RMA webhook

This payload was created to showcase all the possible fields that can be included. It contains everything from the Standard payload (https://speca.io/Narvar/self-serve-rma) and more.
Operations
POST (recommended) - send return details
POST /return
POST (recommended) - send return details
POST /return

Authentication

basicAuth

This payload was created to showcase all the possible fields that can be included. It contains everything from the Standard payload (https://speca.io/Narvar/self-serve-rma?key=53a661b205b0be1ebf5844bb9780b3c7) and more.

Request body

Object
order
Object
retailer_moniker
string

Retailer Name as it is stored in Narvar system

Example:
peninsula
order_number
string

A unique identifier for the order

Example:
ORD123
placement_date
string

Date the order was placed

Example:
2020-04-16T07:06:49Z
customer_id
string

A unique identifier for the customer

Example:
3bc3642c-86ee-3b9a-880a-203a22738465
billing_document
Object
billed_to
Object
first_name
string

First Name

Example:
John
last_name
string

Last Name

Example:
Doe
phone
string

Phone

Example:
8765432
phone_extension
string

Phone Extension

Example:
531
email
string

Billing Email

Example:
narvar@narvar.com
fax
string

Billing Fax

Example:
87654321
address
Object
city
string
Example:
Boston
state
string
Example:
MA
country
string
Example:
US
street1
string
Example:
50 Beale St
zipcode
string
Example:
02210
amount
string

Order amount

Example:
181.17
tax_rate
string

Order tax rate

Example:
2.87
tax_amount
string

Order tax amount

Example:
9.91
payments
Array
Object
method
string

Payment Method

Example:
Card
payment_card
string

Last 4 digits of credit/debit card

Example:
3839
merchant
string

Merchant Type

Example:
VISA
merchant_ref
string

Merchant Reference Number

Example:
7533386798858249
payment_ref
string

Payment Reference Number

Example:
7533386798858249
gift_card
boolean

If Payment was done using a gift card

custom_attributes
Object

Order Custom Attributes

fulfillment_status
string
Example:
FULFILLED
shipment_info
Array
Object
id
string
Example:
peninsula:ORD123
tracking_number
string
Example:
TRACK_23541405_06
items
Array
Object
product_sku
string
Example:
23541405
item_id
string
Example:
itemid23541405
quantity
integer
Example:
7
ship_to
Object
first_name
string
Example:
John
last_name
string
Example:
Doe
phone
string
Example:
8765432
phone_extension
string
Example:
531
email
string
Example:
narvar@narvar.com
fax
string
Example:
87654321
address
Object
city
string
Example:
Boston
state
string
Example:
MA
country
string
Example:
US
street1
string
Example:
40 Beale St
zipcode
string
Example:
02220
discount
string
Example:
12.23
shipping_amount
string
Example:
6.42
tax
string
Example:
2.66
order_currency
string
Example:
USD
retailer_promise_date
string
Example:
2019-12-17T07:06:48Z
ship_date
string
Example:
2019-12-16T07:06:48Z
carrier
string
Example:
ups
carrier_service
string
Example:
UPS Ground
carrier_service_code
string
Example:
CSC
customer_option
string
Example:
23541405
ship_method
string
Example:
Ground
ship_source
string
Example:
QLg
customer_key
string
Example:
3bc3642c-86ee-3b9a-880a-203a22738465
custom_attributes
Object
items
Array
Object
product_sku
string
Example:
23541406
item_id
string
Example:
itemid23541406
name
string
Example:
Narvar QA Order
price
string
Example:
9.99
discount_amount
string
Example:
4.99
categories
Array of string
events
Array
Object
event
string
Example:
CURRENT_RETURNABLE_QTY
date
string
Example:
2018-10-27T11:11:13.200Z
quantity
integer
Example:
5
sequence
integer
Example:
3
image_url
string
Example:
https://cdn.shopify.com/s/files/1/0020/4049/6187/products/Narwhal_1.png?v=1532034034
final_sale
boolean
shop_runner_eligible
boolean
fulfillment_status
string
Example:
Shipped
final_sale_date
string
Example:
2019-12-15T07:06:48Z
parent_product_sku
string
Example:
23541406
line_number
string
Example:
23541405-1
custom_attributes
Object
dimensions
Object
uom
string
Example:
in
length
string
Example:
1.54
height
string
Example:
1.77
weight
string
Example:
10.0
weight_uom
string
Example:
lbs
discount_percent
string
Example:
25.0
back_ordered
boolean
description
string
Example:
Narvar QA Test Order
url
string
Example:
http://itempageurl.com/CNSLwx
quantity
integer
Example:
10
gift
boolean
Example:
true
promise_date
string
Example:
2019-12-17T07:06:48Z
id
string
Example:
peninsula:ORD123:itemid23541406
vendors
Array
Object
name
string
Example:
TestVendorName
type
string
Example:
TestVendorType
phone
string
Example:
7780653467
email
string
Example:
automation2.narvar@gmail.com
address
Object
city
string
Example:
Newark
state
string
Example:
CA
country
string
Example:
US
street1
string
Example:
609 Folsom St
street2
string
Example:
Floor 4
zipcode
string
Example:
94108
returns
Array
Object
return_id
string

Unique ID for each return transaction

Example:
204531
return_created_date
string

Date the return was initiated

Example:
2020-04-17T15:59:09.656Z
return_created_date_epoch
integer

Unix time stamp of return_created_date

Example:
1587139149656
retailer
string

Retailer name as it is stored in the Narvar system

Example:
peninsula
carrier
string

Carrier used to deliver the package

Example:
ups
carrier_service_method
string

Class of service used for the package

Example:
Ground
return_tracking_number
string

The carrier tracking number for the package

Example:
1Z9W9F489014511424
return_method
string

Method selected for the return.

Enumeration:
mail

When customer ships the product via mail.

store

When the customer returns it in store.

self

When the customer returns on their own.

printerless_mail

When customer choose the printerless option.

rma_number
string

Return merchandize authorization

Example:
RA
return_tracking_status
string

This represents the status of the return during its journey to the distribution centre.

Enumeration:
return_initiated_standard

This field is populated right after a return is initiated.

return_on_its_way_standard

This field is populated when we receive a first scan event from the carrier.

return_delivered_standard

This field is populated when we receive a delivered scan event from the carrier.

return_cancellation_standard

This field is populated when an user chooses to cancel the return.

tracking_url
string

This URL can be used to track the package status on the Narvar platform

Example:
https://peninsula.narvar.com/peninsula/tracking/UPS?tracking_numbers=1Z6W11111650E0319580262&type=ret&order_number=70074401&rma=993338
is_simple_return
boolean

True if using Narvar Simple Returns product

return_from
Object
first_name
string
Example:
John
last_name
string
Example:
Doe
phone
string
Example:
8765432
email
string
Example:
narvar@narvar.com
address
Object
city
string
Example:
Boston
state
string
Example:
MA
country
string
Example:
US
street1
string
Example:
50 Beale St
zipcode
string
Example:
02220
return_to
Object
phone
string
Example:
1234567890
address
Object
city
string
Example:
San Francisco
state
string
Example:
CA
country
string
Example:
US
street1
string
Example:
50 Beale St.
street2
string
Example:
7th floor
zipcode
string
Example:
94105
ship_by_date
string

Date before which the the user has to ship their return

Example:
2020-05-16T07:06:49+0000
ship_by_date_epoch
integer

Unix timestamp of ship_by_date

Example:
1589612809000
is_gift_return
boolean

Sent as “true” if the return was initiated by a gift recipient

tax_amount
integer

Final Tax charged for the return transaction

restocking_fee
integer

Restocking fee associated with the return

is_restock_override_used
boolean

True if Return Override code was used for the return

return_shipping_fee
number

Return Shipping Fee associated with the return

Example:
5.95
estimated_refund
integer

Estimated refund to the customer

locale
string

Locale the user chose to initate the return

Example:
en_US
label_url
string

URL of the label

Example:
https://returns-qa01.narvar.qa/returns/peninsula/viewlabel?return_id=wzGOvoa6LPwQ8eA2
printerless_info_url
string

URL to printerless label/barcode if return method is printerless_mail

Example:
https://returns-qa01.narvar.qa/returns/peninsula/printerless-info?return_id=wzGOvoa6LPwQ8eA2
transaction_type
string

This denotes if the transaction was return, exchanges or both.

Enumeration:
return

If the transaction was only return.

exchange

If the transaction was only exchanges

returnandexchange

If the transaction was return and exchange.

refund_option
string

This is the refund method the user chose at the last step of the returns workflow.

Enumeration:
credit_card

If the user chose to receive the refund in the original payment method.

store_credit

If the user chose to receive the refund via Gift Card.

custom_attributes
Object

All the custom attributes at the order level. This is populated from Orders API.

return_items
Array
Object
exchange_item
Object
exchange_option
Object

Exchange options chosen by the user

color
string

Color of the exchange item

Example:
blue
size
string

Size of the exchange item

Example:
medium
variant_sku
string

Variant SKU

Example:
string
variant_title
string

Title of the item being returned

Example:
string
variant_id
string

Variant ID of the exchange item

Example:
012
product_sku
string
Example:
23541406
item_id
string
Example:
1234
line_number
string
Example:
1
item_category
string
Example:
denim
return_quantity
integer
Example:
3
return_reason
string
Example:
Incorrect Item / Damaged
retailer_reason_code
string
Example:
05
user_comment
string
Example:
Did not like
parent_sku
string
Example:
23541406
unit_price
string
Example:
49.99
total_item_price
string
Example:
149.97
custom_attributes
Object
show more

Responses

200 200

SUCCESS

Body
application/json

No payload is required in the response to Narvar. We will ignore any data sent back.

202 Accepted

ACCEPTED

201 Created

CREATED

400 400

BAD REQUEST

application/json
401 401

UNAUTHORIZED

application/json
403 403

FORBIDDEN

application/json
500 500

INTERNAL SERVER ERROR

Body
application/json

Any 5xx response will be considered a failure

Examples

POST /rma HTTP/1.1 

Content-Type: application/json

{
    "order": {
        "retailer_moniker": "peninsula",
        "order_number": "ORD123",
        "placement_date": "2020-04-16T07:06:49Z",
        "customer_id": "3bc3642c-86ee-3b9a-880a-203a22738465",
        "billing_document": {
            "billed_to": {
                "first_name": "John",
                "last_name": "Doe",
                "phone": "8765432",
                "phone_extension": "531",
                "email": "narvar@narvar.com",
                "fax": "87654321",
                "address": {
                    "city": "Boston",
                    "state": "MA",
                    "country": "US",
                    "street1": "50 Beale St",
                    "zipcode": "02210"
                }
            },
            "amount": "181.17",
            "tax_rate": "2.87",
            "tax_amount": "9.91",
            "payments": [
                {
                    "method": "Card",
                    "payment_card": "3839",
                    "merchant": "VISA",
                    "merchant_ref": "7533386798858249",
                    "payment_ref": "7533386798858249",
                    "gift_card": true
                }
            ]
        },
        "custom_attributes": {},
        "fulfillment_status": "FULFILLED",
        "shipment_info": [
            {
                "id": "peninsula:ORD123",
                "tracking_number": "TRACK_23541405_06",
                "items": [
                    {
                        "product_sku": "23541405",
                        "item_id": "itemid23541405",
                        "quantity": 7
                    }
                ],
                "ship_to": {
                    "first_name": "John",
                    "last_name": "Doe",
                    "phone": "8765432",
                    "phone_extension": "531",
                    "email": "narvar@narvar.com",
                    "fax": "87654321",
                    "address": {
                        "city": "Boston",
                        "state": "MA",
                        "country": "US",
                        "street1": "40 Beale St",
                        "zipcode": "02220"
                    }
                },
                "discount": "12.23",
                "shipping_amount": "6.42",
                "tax": "2.66",
                "order_currency": "USD",
                "retailer_promise_date": "2019-12-17T07:06:48Z",
                "ship_date": "2019-12-16T07:06:48Z",
                "carrier": "ups",
                "carrier_service": "UPS Ground",
                "carrier_service_code": "CSC",
                "customer_option": "23541405",
                "ship_method": "Ground",
                "ship_source": "QLg",
                "customer_key": "3bc3642c-86ee-3b9a-880a-203a22738465",
                "custom_attributes": {}
            }
        ],
        "items": [
            {
                "product_sku": "23541406",
                "item_id": "itemid23541406",
                "name": "Narvar QA Order",
                "price": "9.99",
                "discount_amount": "4.99",
                "categories": [
                    ""
                ],
                "events": [
                    {
                        "event": "CURRENT_RETURNABLE_QTY",
                        "date": "2018-10-27T11:11:13.200Z",
                        "quantity": 5,
                        "sequence": 3
                    }
                ],
                "image_url": "https://cdn.shopify.com/s/files/1/0020/4049/6187/products/Narwhal_1.png?v=1532034034",
                "final_sale": true,
                "shop_runner_eligible": true,
                "fulfillment_status": "Shipped",
                "final_sale_date": "2019-12-15T07:06:48Z",
                "parent_product_sku": "23541406",
                "line_number": "23541405-1",
                "custom_attributes": {},
                "dimensions": {
                    "uom": "in",
                    "length": "1.54",
                    "height": "1.77",
                    "weight": "10.0",
                    "weight_uom": "lbs"
                },
                "discount_percent": "25.0",
                "back_ordered": true,
                "description": "Narvar QA Test Order",
                "url": "http://itempageurl.com/CNSLwx",
                "quantity": 10,
                "gift": true,
                "promise_date": "2019-12-17T07:06:48Z",
                "id": "peninsula:ORD123:itemid23541406",
                "vendors": [
                    {
                        "name": "TestVendorName",
                        "type": "TestVendorType",
                        "phone": "7780653467",
                        "email": "automation2.narvar@gmail.com",
                        "address": {
                            "city": "Newark",
                            "state": "CA",
                            "country": "US",
                            "street1": "609 Folsom St",
                            "street2": "Floor 4",
                            "zipcode": "94108"
                        }
                    }
                ]
            }
        ],
        "returns": [
            {
                "return_id": "204531",
                "return_created_date": "2020-04-17T15:59:09.656Z",
                "return_created_date_epoch": 1587139149656,
                "retailer": "peninsula",
                "carrier": "ups",
                "carrier_service_method": "Ground",
                "return_tracking_number": "1Z9W9F489014511424",
                "return_method": "printerless_mail",
                "rma_number": "RA",
                "return_tracking_status": "return_initiated_standard",
                "tracking_url": "https://peninsula.narvar.com/peninsula/tracking/UPS?tracking_numbers=1Z6W11111650E0319580262&type=ret&order_number=70074401&rma=993338",
                "is_simple_return": true,
                "return_from": {
                    "first_name": "John",
                    "last_name": "Doe",
                    "phone": "8765432",
                    "email": "narvar@narvar.com",
                    "address": {
                        "city": "Boston",
                        "state": "MA",
                        "country": "US",
                        "street1": "50 Beale St",
                        "zipcode": "02220"
                    }
                },
                "return_to": {
                    "phone": "1234567890",
                    "address": {
                        "city": "San Francisco",
                        "state": "CA",
                        "country": "US",
                        "street1": "50 Beale St.",
                        "street2": "7th floor",
                        "zipcode": "94105"
                    }
                },
                "ship_by_date": "2020-05-16T07:06:49+0000",
                "ship_by_date_epoch": 1589612809000,
                "is_gift_return": true,
                "tax_amount": 1,
                "restocking_fee": 1,
                "is_restock_override_used": true,
                "return_shipping_fee": 5.95,
                "estimated_refund": 1,
                "locale": "en_US",
                "label_url": "https://returns-qa01.narvar.qa/returns/peninsula/viewlabel?return_id=wzGOvoa6LPwQ8eA2",
                "printerless_info_url": "https://returns-qa01.narvar.qa/returns/peninsula/printerless-info?return_id=wzGOvoa6LPwQ8eA2",
                "transaction_type": "returnandexchange",
                "refund_option": "credit_card",
                "custom_attributes": {},
                "return_items": [
                    {
                        "exchange_item": {
                            "exchange_option": {
                                "color": "blue",
                                "size": "medium"
                            },
                            "variant_sku": "string",
                            "variant_title": "string",
                            "variant_id": "012"
                        },
                        "product_sku": "23541406",
                        "item_id": "1234",
                        "line_number": "1",
                        "item_category": "denim",
                        "return_quantity": 3,
                        "return_reason": "Incorrect Item / Damaged",
                        "retailer_reason_code": "05",
                        "user_comment": "Did not like",
                        "parent_sku": "23541406",
                        "unit_price": "49.99",
                        "total_item_price": "149.97",
                        "custom_attributes": {}
                    }
                ]
            }
        ]
    }
}
show more