Narvar
App · 16 actions
Send orders and shipments to Narvar for tracking and customer updates, start returns with labels, and work with returns, exchanges, refunds and return locations in Narvar's Shopify returns app.
Actions
| Action | What it does |
|---|---|
| Add shipment | Add a shipment to an order, with its carrier and tracking number, or update one Narvar has, so Narvar tracks the package and tells the customer. |
| Change return status | Set a return's status in Narvar's Shopify returns app, such as delivered or cancelled, and add a note to it. |
| Create or update order | Send an order to Narvar, or new details of one it has, so Narvar can track it and send the customer updates. |
| Create return location | Add a store or warehouse that takes returns. |
| Create return with label | Start a return on an order Narvar has and get its shipping label, tracking link or QR code. |
| Create Shopify return | Start a return or exchange on a Shopify order in Narvar's returns app, and get its RMA number, label and QR code. |
| Delete return location | Delete a return location. |
| Get order | Get an order Narvar has, with its items, shipments and tracking numbers, customer and billing. |
| Get return | Get one return or exchange from Narvar's Shopify returns app, with its status, items, packages, refund and fees. |
| Get return label | Get a platform return's label, tracking link and QR code again, by the reference number 'Create return with label' gave. |
| Get return location | Get one return location with its address and what it takes. |
| Get return timeline | Get the history of a return in Narvar's Shopify returns app: each status change and who made it. |
| List return locations | List the stores and warehouses that take returns in Narvar's Shopify returns app. |
| List returns | List returns and exchanges from Narvar's Shopify returns app, newest first unless dates are given, filtered by order or customer. |
| Record received items | Tell Narvar's Shopify returns app what your warehouse received for a return: approve, reject or flag each item, and refund the customer in full or in part. |
| Update return location | Change a return location's name, address or what it takes. |
Add shipment
Add a shipment to an order, with its carrier and tracking number, or update one Narvar has, so Narvar tracks the package and tells the customer. Needs the platform's account ID and auth token.
Inputs
- Order number
order_numbertextRequired - The order's number, as your store sends it to Narvar.
- Tracking number
tracking_numbertextRequired - The carrier's tracking number for the package.
- Carrier
carriertextRequired - Narvar's name for the carrier, such as ups, fedex, usps or dhl. Your Narvar account manager has the full list.
- Items shipped
itemslistRequired - What is in the package. Each needs a 'sku' (or 'item_id') and a 'quantity'.
- Ship date
ship_datedate and time - When the package shipped.
- Ship method
ship_methodtext - Such as Ground or Next Day.
- Carrier service
carrier_servicetext - Such as UPS Ground.
- Recipient first name
recipient_first_nametext - Who it is shipped to.
- Recipient last name
recipient_last_nametext - Who it is shipped to.
- Recipient email
recipient_emailtext - The recipient's email address.
- Recipient phone
recipient_phonetext - The recipient's phone number.
- Street
street_1text - The delivery street address.
- Street line 2
street_2text - Apartment, suite or floor.
- City
citytext - The delivery city.
- State or province
statetext - State or province, such as CA.
- ZIP or postal code
zip_codetext - ZIP or postal code.
- Country
countrytext - Two-letter country code, such as US.
Outputs
messageslist- Narvar's messages about the request, if any
order_numbertext- The order
statustext- Narvar's status for the request, such as SUCCESS
tracking_numbertext- The shipment's tracking number
Example output
{
"messages": [],
"order_number": "ORD123",
"status": "SUCCESS",
"tracking_number": "1Z9W9F489014511424"
}Change return status
Set a return's status in Narvar's Shopify returns app, such as delivered or cancelled, and add a note to it.
Inputs
- Return
rma_numbertextRequired - The return's RMA number. Pick a recent one, or give it from an earlier step.
- New status
statustext - The return's new status. Leave empty to only add a note.One of:
initiated,on_its_way_to_retailer(On its way to you),delivered_to_retailer(Delivered to you),received_by_retailer(Received by you),rejected,cancelled_by_retailer(Cancelled by you),cancelled_by_user(Cancelled by the customer),exception,out_of_stock_exception(Out of stock exception),resolve_manually_without_automation(Resolve manually). - Note
notetext - Text to add to the return's notes.
Outputs
notetext- The note added, if any
responseobject- Narvar's answer, if any
rma_numbertext- The return
statustext- The status set, empty if only a note
Example output
{
"note": "Received at DC01",
"response": {},
"rma_number": "RX5A",
"status": "delivered_to_retailer"
}Create or update order
Send an order to Narvar, or new details of one it has, so Narvar can track it and send the customer updates. Needs the platform's account ID and auth token.
Inputs
- Order number
order_numbertextRequired - The order's number, as your store sends it to Narvar.
- Items
itemslistRequired - Everything in the order. Each needs a 'sku' and a 'quantity'; 'name', 'item_id', 'unit_price', 'item_image', 'item_url' and 'fulfillment_status' are shown to the customer too.
- Order date
order_datedate and time - When the order was placed.
- Customer first name
customer_first_nametext - The customer's first name.
- Customer last name
customer_last_nametext - The customer's last name.
- Customer email
customer_emailtext - Where Narvar sends the customer's order and delivery updates.
- Customer phone
customer_phonetext - For text updates, with the country code.
- Customer ID
customer_idtext - Your own id for the customer.
- Street
street_1text - The customer's billing street address.
- Street line 2
street_2text - Apartment, suite or floor.
- City
citytext - The customer's billing city.
- State or province
statetext - State or province, such as CA.
- ZIP or postal code
zip_codetext - ZIP or postal code.
- Country
countrytext - Two-letter country code, such as US.
- Currency
currency_codetext - Three-letter currency code, such as USD.
- Order total
order_totalnumber - The amount billed for the order.At least 0.
- Tax
tax_amountnumber - The tax on the order.At least 0.
- Shipping and handling
shipping_amountnumber - What the customer paid for shipping and handling.At least 0.
- Promised delivery date
order_promise_datedate and time - When you promised the customer the order would arrive.
- Custom attributes
attributesobject - Your own keys and values to keep on the order.
Outputs
messageslist- Narvar's messages about the request, if any
order_numbertext- The order sent
statustext- Narvar's status for the request, such as SUCCESS
Example output
{
"messages": [],
"order_number": "ORD123",
"status": "SUCCESS"
}Create return location
Add a store or warehouse that takes returns. Your Narvar account needs return location management turned on.
Inputs
- Name
nametextRequired - The location's name.
- Address
address1textRequired - Street address.
- Address line 2
address2text - Suite or floor.
- City
citytextRequired - City.
- State or province
statetextRequired - Such as California.
- State code
state_codetextRequired - Such as CA.
- ZIP or postal code
zip_codetextRequired - ZIP or postal code.
- Country
countrytextRequired - Such as United States.
- Country code
country_codetextRequired - Two letters, such as US.
- Phone
phonetextRequired - Such as 1-415-555-5555.
- Latitude
latitudenumberRequired - The location's latitude, such as 37.79.From -90 to 90.
- Longitude
longitudenumberRequired - The location's longitude, such as -122.39.From -180 to 180.
- Takes in-store returns
accept_in_store_returnstrue/false - Whether customers can return items here in person.
- Takes mailed returns
accept_mail_in_returnstrue/false - Whether returns can be mailed here. On unless turned off.
Outputs
locationobject- The return location
Example output
{
"location": {
"accept_in_store_returns": true,
"accept_mail_in_returns": true,
"id": "YXWN",
"location": {
"address1": "1214 Main Road",
"address2": "Suite 4",
"city": "San Francisco",
"country": "United States",
"country_code": "US",
"latitude": 37.79,
"longitude": -122.39,
"phone": "1-415-555-5555",
"state": "California",
"state_code": "CA",
"zip": "94105"
},
"name": "San Francisco store"
}
}Create return with label
Start a return on an order Narvar has and get its shipping label, tracking link or QR code. Needs the platform's account ID and auth token.
Inputs
- Order number
order_numbertextRequired - The order's number, as your store sends it to Narvar.
- Items to return
itemslistRequired - Each needs a 'sku', a 'quantity' and a 'return_reason_code' (a reason code set up in Narvar Hub); 'item_id' and 'customer_comment' are optional.
- Customer email
customer_emailtext - Checked against the order before the return is made.
- Postal code
postal_codetext - Checked against the order's billing postal code (its shipping one for a gift).
- RMA number
rma_numbertext - Your own RMA number. Leave empty to have Narvar make one.
- Carrier
carriertext - Which carrier makes the label. Leave empty for your Narvar rules.One of:
ups,fedex,usps,dhl. - Return type
return_typetext - What kind of return this is. Defaults to a return by mail.One of:
return(Return (default)),lost(Lost package),refused(Refused by the customer),delivery-exception(Delivery exception). - Locale
localetext - Such as en_US. Defaults to en_US.
- Gift return
gift_returntrue/false - Turn on when the person returning it received it as a gift.
Outputs
messageslist- Narvar's messages about the request, if any
order_numbertext- The order the return is for
return_methodslist- Ways to send the return, with labels
return_reference_numbertext- Narvar's reference for the return, to get its label later
rma_numbertext- The return's RMA number
statustext- Narvar's status for the request, such as SUCCESS
Example output
{
"messages": [],
"order_number": "ORD123",
"return_methods": [
{
"carrier": {
"name": "UPS"
},
"label_url": "https://returns-narvar.com/returns/retailer/viewlabel?return_id=gbZ1AoqzlP1QABRmO",
"qr_code_url": "",
"tracking_number": "1Z9W9F489014511425",
"tracking_url": "https://retailer.narvar.com/retailer/tracking/ups?tracking_numbers=1Z9W9F489014511425",
"type": "MAIL"
}
],
"return_reference_number": "gbZ1AoqzlP1QABRmO",
"rma_number": "RA1001",
"status": "SUCCESS"
}Create Shopify return
Start a return or exchange on a Shopify order in Narvar's returns app, and get its RMA number, label and QR code.
Inputs
- Order number
order_numbertextRequired - The order's number, as your store sends it to Narvar.
- Customer email
emailtextRequired - The email address on the order.
- Items to return
return_itemslistRequired - Each needs a 'lineItemId' (the Shopify line item) and a 'quantity'; give a 'returnReason' or 'returnReasonId' from your return reasons.
- How it comes back
shipping_methodtextRequired - How the customer sends the item back.One of:
usps_returns(USPS),fedex,ups,keep_the_item(Keep the item),return_in_store(Return in store),ship_on_your_own(Ship on their own). - Items to exchange
exchange_itemslist - For an exchange: each with 'returnItem' (as in Items to return) and the replacement's 'newProductVariantId'.
- Refund to
refund_methodtext - How the customer is refunded, if your refund rules allow it.One of:
original_payment(Original payment method),gift_card(Gift card). - Locale
localetext - Such as en. Defaults to en.
- Shipping price
shipping_pricenumber - What the customer pays to send it back.At least 0.
- Send from address
from_addressobject - Only when the order's address won't do: name, address1, address2, city, provinceCode, postalCode, countryCode and phone.
Outputs
qr_codetext- Address of the QR code image
rma_numbertext- The new return's RMA number
shipping_labeltext- Address of the label image
Example output
{
"qr_code": "https://storage.googleapis.com/shopify-zero-narvar/example/qr_code.png",
"rma_number": "RX5A",
"shipping_label": "https://storage.googleapis.com/shopify-zero-narvar/example/return_label.pdf"
}Delete return location
Delete a return location. Delete the return rules that use it first.
Inputs
- Return location
location_idtextRequired - The return location. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- True once deleted
location_idtext- The location deleted
Example output
{
"deleted": true,
"location_id": "YXWN"
}Get order
Get an order Narvar has, with its items, shipments and tracking numbers, customer and billing. Needs the platform's account ID and auth token.
Inputs
- Order number
order_numbertextRequired - The order's number, as your store sends it to Narvar.
Outputs
messageslist- Narvar's messages about the request, if any
orderobject- The order
statustext- Narvar's status for the request, such as SUCCESS
Example output
{
"messages": [],
"order": {
"attributes": {},
"billing": {
"amount": 34.07,
"billed_to": {
"address": {
"city": "San Francisco",
"country": "US",
"state": "CA",
"street_1": "50 Beale St",
"street_2": "Floor 4",
"zip": "94105"
},
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"location_id": "",
"phone": "4155550100"
},
"shipping_handling": 6.42,
"tax_amount": 2.66,
"tax_rate": 8.5
},
"currency_code": "USD",
"customer": {
"address": {
"city": "San Francisco",
"country": "US",
"state": "CA",
"street_1": "50 Beale St",
"street_2": "Floor 4",
"zip": "94105"
},
"customer_id": "3bc3642c-86ee-3b9a-880a-203a22738465",
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "4155550100"
},
"order_date": "2026-11-14T07:06:49Z",
"order_items": [
{
"categories": [
"Tops"
],
"description": "Narwhal Tee, blue, medium",
"fulfillment_status": "SHIPPED",
"fulfillment_type": "HD",
"is_backordered": false,
"is_final_sale": false,
"is_gift": false,
"item_id": "itemid23541406",
"item_image": "https://cdn.example.com/narwhal-tee.png",
"item_promise_date": "2026-11-20T07:06:48Z",
"item_url": "https://shop.example.com/products/narwhal-tee",
"line_number": 1,
"line_price": 24.99,
"name": "Narwhal Tee",
"quantity": 1,
"sku": "23541406",
"unit_price": 24.99
}
],
"order_number": "ORD123",
"order_promise_date": "2026-11-20T07:06:48Z",
"pickups": [],
"selected_ship_method": "Ground",
"shipments": [
{
"carrier": "ups",
"carrier_service": "UPS Ground",
"items_info": [
{
"item_id": "itemid23541406",
"quantity": 1,
"sku": "23541406"
}
],
"ship_date": "2026-11-16T07:06:48Z",
"ship_method": "Ground",
"ship_source": "DC01",
"ship_total": 6.42,
"shipped_from": {
"address": {
"city": "San Francisco",
"country": "US",
"state": "CA",
"street_1": "50 Beale St",
"street_2": "Floor 4",
"zip": "94105"
},
"email": "john@example.com",
"first_name": "Warehouse",
"last_name": "DC01",
"location_id": "DC01",
"phone": "4155550100"
},
"shipped_to": {
"address": {
"city": "San Francisco",
"country": "US",
"state": "CA",
"street_1": "50 Beale St",
"street_2": "Floor 4",
"zip": "94105"
},
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"location_id": "",
"phone": "4155550100"
},
"tracking_number": "1Z9W9F489014511424"
}
]
},
"status": "SUCCESS"
}Get return
Get one return or exchange from Narvar's Shopify returns app, with its status, items, packages, refund and fees.
Inputs
- Return
rma_numbertextRequired - The return's RMA number. Pick a recent one, or give it from an earlier step.
Outputs
returnobject- The return
Example output
{
"return": {
"currency": "GBP",
"email": "customer@example.com",
"errors": [],
"estimated_refund": "900.00",
"fee_breakdown": [
{
"currency": "GBP",
"description": "Return Fee",
"fee": 0.0,
"formatted_fee": "FREE"
}
],
"gift": false,
"items": [
{
"child_reason": "Too small",
"child_reason_code": "R5YGD",
"comment": "Runs small, ordered size 8",
"exchange_item": {},
"item_id": 17632336576829,
"keep_the_item": false,
"quantity": 1,
"reason": "Incorrect Sizing",
"reason_code": "DMKKB",
"sku": "8MUO2",
"total_item_price": "900.00",
"transaction_type": "return",
"unit_price": "900.00"
}
],
"label_url": "https://storage.googleapis.com/shopify-zero-narvar/example/return_label.pdf",
"locale": "en",
"order_number": "#3420",
"origin_city": "London",
"origin_country": "GB",
"origin_zip": "NW1 6XE",
"package": {
"carrier": "ship_on_your_own",
"carrier_service_method": "",
"destination_city": "San Francisco",
"destination_country": "US",
"destination_zip": "94105",
"tracking_number": ""
},
"packages": [
{
"carrier_service_name": "",
"destination_city": "San Francisco",
"destination_country_code": "US",
"destination_postal_code": "94105",
"items": [
{
"item_id": 17632336576829,
"quantity": 1
}
],
"letter": "A",
"return_method": "self",
"return_tracking_company": "",
"return_tracking_number": "",
"tracking_link": ""
}
],
"refund_method": "original_payment",
"restocking_fee": "0.00",
"retailer_name": "Dev Narvar",
"return_creation_date": "2026-08-17T20:53:43.000Z",
"return_method": "self",
"return_status": "initiated",
"rma_number": "RX5A",
"shop_currency": "USD",
"shopify_order_id": 7327841321277,
"transaction_types": [
"return"
],
"transactions": []
}
}Get return label
Get a platform return's label, tracking link and QR code again, by the reference number 'Create return with label' gave. Needs the platform's account ID and auth token.
Inputs
- Return reference number
return_reference_numbertextRequired - The reference number 'Create return with label' gave.
Outputs
messageslist- Narvar's messages about the request, if any
order_numbertext- The order the return is for
return_methodslist- Ways to send the return, with labels
return_reference_numbertext- Narvar's reference for the return, to get its label later
rma_numbertext- The return's RMA number
statustext- Narvar's status for the request, such as SUCCESS
Example output
{
"messages": [],
"order_number": "ORD123",
"return_methods": [
{
"carrier": {
"name": "UPS"
},
"label_url": "https://returns-narvar.com/returns/retailer/viewlabel?return_id=gbZ1AoqzlP1QABRmO",
"qr_code_url": "",
"tracking_number": "1Z9W9F489014511425",
"tracking_url": "https://retailer.narvar.com/retailer/tracking/ups?tracking_numbers=1Z9W9F489014511425",
"type": "MAIL"
}
],
"return_reference_number": "gbZ1AoqzlP1QABRmO",
"rma_number": "RA1001",
"status": "SUCCESS"
}Get return location
Get one return location with its address and what it takes.
Inputs
- Return location
location_idtextRequired - The return location. Pick one, or give its id from an earlier step.
Outputs
locationobject- The return location
Example output
{
"location": {
"accept_in_store_returns": true,
"accept_mail_in_returns": true,
"id": "YXWN",
"location": {
"address1": "1214 Main Road",
"address2": "Suite 4",
"city": "San Francisco",
"country": "United States",
"country_code": "US",
"latitude": 37.79,
"longitude": -122.39,
"phone": "1-415-555-5555",
"state": "California",
"state_code": "CA",
"zip": "94105"
},
"name": "San Francisco store"
}
}Get return timeline
Get the history of a return in Narvar's Shopify returns app: each status change and who made it.
Inputs
- Return
rma_numbertextRequired - The return's RMA number. Pick a recent one, or give it from an earlier step.
Outputs
countnumber- How many entries
rma_numbertext- The return
timelinelist- What happened, in order
Example output
{
"count": 1,
"rma_number": "RX5A",
"timeline": [
{
"by_user": "system",
"description": "Return initiated",
"status": "initiated",
"timeline_item_type": "state_transition",
"timestamp": "2026-08-17T20:53:43Z",
"user": {
"email": "",
"first_name": "",
"last_name": ""
}
}
]
}List return locations
List the stores and warehouses that take returns in Narvar's Shopify returns app.
Inputs
None.
Outputs
countnumber- How many
locationslist- The return locations
Example output
{
"count": 1,
"locations": [
{
"accept_in_store_returns": true,
"accept_mail_in_returns": true,
"id": "YXWN",
"location": {
"address1": "1214 Main Road",
"address2": "Suite 4",
"city": "San Francisco",
"country": "United States",
"country_code": "US",
"latitude": 37.79,
"longitude": -122.39,
"phone": "1-415-555-5555",
"state": "California",
"state_code": "CA",
"zip": "94105"
},
"name": "San Francisco store"
}
]
}List returns
List returns and exchanges from Narvar's Shopify returns app, newest first unless dates are given, filtered by order or customer. Gets one page; to see more, run it again with the next page number.
Inputs
- Dates are
date_fieldtext - Whether the dates mean when returns were made or last changed.One of:
created(When the return was made (default)),updated(When the return last changed). Default:created. - From
sincedate and time - Only returns on or after this time, oldest first.
- Until
untildate and time - Only returns on or before this time. With no dates, the newest come first.
- Order number
order_numbertext - Only returns for this order.
- Customer email
emailtext - Only returns for this customer's orders.
- Page size
per_pagenumber - How many to return, 1 to 100. Defaults to 100.From 1 to 100.
- Page
pagenumber - Which page of results, starting at 1.At least 1.
Outputs
countnumber- How many on this page
next_timestamptext- Where the next page starts, as a From time; empty on the last
returnslist- The returns
Example output
{
"count": 1,
"next_timestamp": "",
"returns": [
{
"currency": "GBP",
"email": "customer@example.com",
"errors": [],
"estimated_refund": "900.00",
"fee_breakdown": [
{
"currency": "GBP",
"description": "Return Fee",
"fee": 0.0,
"formatted_fee": "FREE"
}
],
"gift": false,
"items": [
{
"child_reason": "Too small",
"child_reason_code": "R5YGD",
"comment": "Runs small, ordered size 8",
"exchange_item": {},
"item_id": 17632336576829,
"keep_the_item": false,
"quantity": 1,
"reason": "Incorrect Sizing",
"reason_code": "DMKKB",
"sku": "8MUO2",
"total_item_price": "900.00",
"transaction_type": "return",
"unit_price": "900.00"
}
],
"label_url": "https://storage.googleapis.com/shopify-zero-narvar/example/return_label.pdf",
"locale": "en",
"order_number": "#3420",
"origin_city": "London",
"origin_country": "GB",
"origin_zip": "NW1 6XE",
"package": {
"carrier": "ship_on_your_own",
"carrier_service_method": "",
"destination_city": "San Francisco",
"destination_country": "US",
"destination_zip": "94105",
"tracking_number": ""
},
"packages": [
{
"carrier_service_name": "",
"destination_city": "San Francisco",
"destination_country_code": "US",
"destination_postal_code": "94105",
"items": [
{
"item_id": 17632336576829,
"quantity": 1
}
],
"letter": "A",
"return_method": "self",
"return_tracking_company": "",
"return_tracking_number": "",
"tracking_link": ""
}
],
"refund_method": "original_payment",
"restocking_fee": "0.00",
"retailer_name": "Dev Narvar",
"return_creation_date": "2026-08-17T20:53:43.000Z",
"return_method": "self",
"return_status": "initiated",
"rma_number": "RX5A",
"shop_currency": "USD",
"shopify_order_id": 7327841321277,
"transaction_types": [
"return"
],
"transactions": []
}
]
}Record received items
Tell Narvar's Shopify returns app what your warehouse received for a return: approve, reject or flag each item, and refund the customer in full or in part.
Inputs
- Return
rma_numbertextRequired - The return's RMA number. Pick a recent one, or give it from an earlier step.
- Items received
itemslistRequired - Each needs an 'item_id' (or 'item_sku'), a 'quantity' and a 'status': approved, approved_no_restock, rejected, not_received, exception or invalid_item.
- Issue the refund
process_refundtrue/false - Refund the customer in Shopify. On unless turned off.
- Approve when all items are approved
auto_approvetrue/false - Approve the return as soon as every item is approved.
- Drop items not received
remove_not_received_itemstrue/false - Take items marked not_received off the return and approve the rest, instead of sending it to exception.
- Refund amount
refund_amountnumber - A partial refund in place of the full one, no more than Narvar worked out. Leave empty for the full refund.At least 0.
- Refund currency
refund_currencytext - Three-letter currency code, such as USD.
- Move return to
status_overridetext - A new status for the return. Can't be used with a refund amount.One of:
on_its_way_to_retailer(On its way to you),delivered_to_retailer(Delivered to you),received_by_retailer(Received by you),approved,rejected,exception,resolve_manually_without_automation(Resolve manually),cancelled_by_retailer(Cancelled by you),cancelled_by_user(Cancelled by the customer),needs_manual_approval(Needs manual approval). - Reference ID
reference_idtext - Narvar ignores a second update with the same reference. Leave empty to make one.
Outputs
reference_idtext- The update's reference id
responseobject- Narvar's answer, if any
rma_numbertext- The return
updatedtrue/false- True once Narvar took the update
Example output
{
"reference_id": "6f1c2b9e-1d3a-4c55-9a8e-2f6b1d0c7e41",
"response": {},
"rma_number": "RX5A",
"updated": true
}Update return location
Change a return location's name, address or what it takes. Give every field, as Narvar replaces the location.
Inputs
- Return location
location_idtextRequired - The return location. Pick one, or give its id from an earlier step.
- Name
nametextRequired - The location's name.
- Address
address1textRequired - Street address.
- Address line 2
address2text - Suite or floor.
- City
citytextRequired - City.
- State or province
statetextRequired - Such as California.
- State code
state_codetextRequired - Such as CA.
- ZIP or postal code
zip_codetextRequired - ZIP or postal code.
- Country
countrytextRequired - Such as United States.
- Country code
country_codetextRequired - Two letters, such as US.
- Phone
phonetextRequired - Such as 1-415-555-5555.
- Latitude
latitudenumberRequired - The location's latitude, such as 37.79.From -90 to 90.
- Longitude
longitudenumberRequired - The location's longitude, such as -122.39.From -180 to 180.
- Takes in-store returns
accept_in_store_returnstrue/false - Whether customers can return items here in person.
- Takes mailed returns
accept_mail_in_returnstrue/false - Whether returns can be mailed here. On unless turned off.
Outputs
locationobject- The return location
Example output
{
"location": {
"accept_in_store_returns": true,
"accept_mail_in_returns": true,
"id": "YXWN",
"location": {
"address1": "1214 Main Road",
"address2": "Suite 4",
"city": "San Francisco",
"country": "United States",
"country_code": "US",
"latitude": 37.79,
"longitude": -122.39,
"phone": "1-415-555-5555",
"state": "California",
"state_code": "CA",
"zip": "94105"
},
"name": "San Francisco store"
}
}