GET - Retrieve a return

Retrieves a specific return

get
Retrieve a specific return

https://api.richcommerce.co/2020-05-25/returns/:id
This endpoint allows you to retrieve a single return based on the rma.
Request
Response
Request
Path Parameters
id
required
string
rma number of the return object
Headers
Authorization
required
string
Authentication token in the format of "RichReturnsToken xxxxx-xxxxx-xxxxx-xxxxx-xxxxx"
Response
200: OK
Return successfully retrieved.
{
"return": {
"rma": "RMA-1273574632",
"status": "Approved",
"method": "methodCustomerChoice",
"staffNotes": null,
"createdAt": "2020-05-25T11:32:41+02:00",
"labelFeeAmount": "6.5",
"restockingFeeAmount": "3.5",
"photoUploadUrl1": "https://3736324.s3.amazonaws.com/adsaddakf229.jpg",
"photoUploadUrl2": null,
"photoUploadUrl3": null,
"labelStatus": "",
"labelTrackingNumber": "9405511258370803554764",
"labelTrackingUrl": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9405511258370803554764",
"labelUrl": "https://3736324.s3.amazonaws.com/4529259fjasdj4543.pdf",
"labelAmount": "10.86",
"labelCurrency": "USD",
"orderId": "612949162897",
"orderNumber": "1147",
"orderDate": "2018-09-04T18:56:57+02:00",
"orderCurrency": "EUR",
"orderTotal": "143.00",
"orderLineItemTotal": "143.00",
"orderDiscount": "0.00",
"orderTax": "0.00",
"orderTags": "high-value, noreturn",
"orderDiscountCodes": null,
"orderPaymentGateway": "",
"orderFulfillmentLocationId": "15328867049",
"customerEmail": "[email protected]",
"customerFirstName": "Santos",
"customerLastName": "Hagenes",
"customerMobile": "(029) 398-9235 09071",
"customerLocale": null,
"shippingAddressFirstName": "Santos",
"shippingAddressLastName": "Hagenes",
"shippingAddressAddress1": "142 Market Street",
"shippingAddressAddress2": null,
"shippingAddressCity": "San Francisco",
"shippingAddressZip": "94419",
"shippingAddressProvince": "California",
"shippingAddressProvinceCode": "CA",
"shippingAddressCountry": "United States",
"shippingAddressCountryCode": "US",
"shippingAddressPhone": "(029) 398-9235 09071",
"Products": [
{
"lineItemId": "1445217470723",
"lineItemPrice": 65,
"lineItemDiscount": 0,
"returnItemReason": "Didn't fit - Too small",
"returnItemResolution": "refundToOriginal",
"returnItemResolutionLabel": "Refund",
"returnItemQuantity": 1,
"returnItemNote": null,
"productId": "1510432604233",
"productName": "Blue Silk Tuxedo",
"productVendor": "Liam Fashions",
"productImageUrl": "https://cdn.shopify.com/s/files/1/0638/7980/6955/products/man-adjusts-blue-tuxedo-bowtie_925x_925x_4231624d-d182-4581-8a38-8f47e9de9309.jpg?v=1584727808",
"productTags": null,
"productWeightInGrams": 292,
"variantId": "12990122081101",
"variantSku": "4111432252556",
"variantName": "xs",
"inventoryItemId": "524526229945",
"stockLocationId": "252502296060",
"exchangeItemVariantId": null,
"exchangeItemVariantName": null,
"exchangeItemPrice": null,
"exchangeItemWeightInGrams": null
}
]
}
}

‚Äč

For a detailed list of the available fields in the response body see the page GET - List all returns.