--- title: "Return" method: GET path: "/returns/{returnId}" tags: ["Returns"] --- # Return `GET /returns/{returnId}` Get return. Requires the [`returns_read`](/docs/api-reference/scopes) scope. ## Response `200` Success - object - `order` OrderReadSchema, required — Order. - `customer` object, required - `emailAddress` string, email — Email address of customer. - `name` PersonNameSchema, required — Person name. - `given` string, required — Given name - `surname` string, required — Surname - `phoneNumber` string — Phone number, in E.164 format - `discounts` MoneySchema, required — Currency amount - `amount` string - `currency` string - `externalId` string — Shopify ID - `id` string, required — Order ID - `items` object[], required - `externalId` string - `fulfillmentLocationId` string, nullable, required — ID of the location where the item was be fulfilled. - `id` string, required — Line item ID - `price` MoneySchema, required — Currency amount - `amount` string - `currency` string - `product` ProductSchema, required — Product. - `externalId` string — Product ID in external system (e.g. shopify). - `name` string, required — Product title - `quantity` number, required — Item quantity. - `variant` ProductVariantSchema, required - `externalId` string - `name` string, required - `sku` string - `weight` WeightSchema — Weight. - `kg` number — Weight in kilograms - `lineItemsTotal` MoneySchema, required — Currency amount - `amount` string - `currency` string - `name` string, required — Shopify name. - `shippingCost` MoneySchema, required — Currency amount - `amount` string - `currency` string - `taxes` MoneySchema, required — Currency amount - `amount` string - `currency` string - `total` MoneySchema, required — Currency amount - `amount` string - `currency` string - `return` ReturnReadSchema, required — Return read. - `compensationMethods` string[] — Array of compensation methods available for this return - `completeWithNoAction` boolean — Whether this return can be completed with no action - `createdAt` string, date-time, required — Time of creation. - `destination` object, required - `mailingAddress` AddressSchema — Address. - `city` string, required — City name - `country` string, required — Country code - `line1` string, required — Line 1 - `line2` string — Line 2 - `postalCode` string, required — Postal or ZIP code - `state` string, required — State or province - `phoneNumber` string — Phone number, in E.164 format - `exchange` object — Exchange order - `itemCount` integer — Total quantity of all exchange items - `items` object[], required - `id` string, required - `originalPrice` object — Original price for the exchange item without discounts and taxes - `amount` string - `currency` string - `price` object — Subtotal price for the exchange item including discounts - `amount` string - `currency` string - `tax` string - `product` ProductSchema — Product. - `externalId` string — Product ID in external system (e.g. shopify). - `name` string, required — Product title - `quantity` number, required — Item quantity. - `variant` ProductVariantSchema, required - `externalId` string - `name` string, required - `sku` string - `weight` WeightSchema — Weight. - `kg` number — Weight in kilograms - `order` object - `externalId` string — ID of external order - `provision` 'instant' | 'deferred', required - `totalTax` object — Total tax for exchange items - `amount` string - `currency` string - `externalOrderIds` string[] — Array of external order IDs associated with this return - `externalReturnIds` object[] — Array of external return identifiers associated with this return. For Shopify returns, value is Shopify's numeric return ID as a string, not a Shopify admin URL or gid:// ID. - `provider` 'shopify', required — External provider that owns this return identifier - `value` string, required — Return identifier value from the external provider - `giftCards` object[], required — Gift card(s) created for return - `amount` MoneySchema, required — Currency amount - `amount` string - `currency` string - `code` string, required — Gift card 16 digit code. - `externalId` string, required — Gift card ID. - `id` string, required — Return identifier. - `internalCreatedByName` string — Name of the internal team member who created this return - `items` object[], required — Return items - `customerComment` string — Customer's comment about the return - `exchangeItem` object — Exchange item details if this return item is being exchanged - `product` object - `externalId` string - `name` string - `quantity` integer - `variant` object - `externalId` string - `name` string - `grade` string, nullable — Merchant-assigned grade for the returned item (e.g. condition or quality tier). Null if the merchant has not graded this item. - `greenReturn` boolean — Whether this is a green return (no physical return required) - `outcome` string, nullable — Merchant-assigned processing outcome for the returned item (e.g. restock, dispose). Null if the merchant has not set an outcome for this item. - `shipmentGroupIds` string[] — IDs of the shipment groups this return item belongs to - `id` string, required — Return item ID. - `orderItem` object, required — Order line item - `id` string, required — Line item reference ID in format: {orderId}/{lineItemIndex} - `line_item_id` string — Original Shopify line item ID - `externalReturnLineItemId` string — External return line item ID - `productId` string — Product ID - `quantity` integer, required — Quantity of items being returned - `reason` string, required — Primary return reason - `reasonCode` string — Return reason code - `reasons` string[] — Array of return reasons - `reasonCodes` string[] — Array of return reason codes - `productAdjustment` string — Product adjustment details - `multipleChoiceQuestions` object[] — Multiple choice questions and answers for this return item - `question` string, required — The question text - `answer` string, required — The selected answer - `assessments` object[] — Assessment records for this return item. Only applicable for warranties. - `assignedUser` object, required — User assigned to this assessment - `id` string, required - `name` string, required - `firstName` string, required - `lastName` string, required - `email` string, required - `responses` union[], required — Assessment responses - union - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `refund` object — Refund details - `amount` MoneySchema, required — Currency amount - `amount` string - `currency` string - `type` string — Refund strategy - `productValueNoTaxNoAdjustment` object — Per-product value before taxes and merchant adjustments. Equivalent to the "Product Value (No Tax/Adjustment)" column in the Returns Report. - `amount` MoneySchema, required — Currency amount - `amount` string - `currency` string - `sku` string — Product SKU - `upc` string, nullable — Universal Product Code (barcode) snapshotted from the product at return-creation time. Null if no barcode was recorded. - `status` string — Return item status - `variantId` string — Product variant ID - `notes` object[] — Teammembers generated notes and comments on the return - `image` string — Optional image URL attached to the note - `message` string, required — The note text - `order` object, required — Original order. - `id` string, required — Redo's internal identifier for the original order created in Redo. - `name` string — Order name from the external provider, such as the Shopify order name. - `shipment` ReturnShipmentSchema — Return shipment tracking information - `carrier` string — Carrier code - `status` 'unknown' | 'pre_transit' | 'in_transit' | 'out_for_delivery' | 'available_for_pickup' | 'cancelled' | 'delivered' | 'error' | 'failure' | 'return_to_sender' | 'expired' — Status of shipment - `tracker` string — Tracking number - `trackingUrl` string — Tracking URL - `postageLabel` string — Postage label URL - `formLabel` string — Form label URL - `shipmentGroupId` string — ID of the shipment group this shipment belongs to - `itemIds` string[] — IDs of the return items included in this shipment - `externalLocationId` string — External location ID for the destination of this shipment - `estimatedDeliveryDate` string — Estimated delivery date for this shipment - `deliveredAt` string — Date and time this shipment was delivered - `shipments` ReturnShipmentSchema[] — Array of all shipments associated with this return - `carrier` string — Carrier code - `status` 'unknown' | 'pre_transit' | 'in_transit' | 'out_for_delivery' | 'available_for_pickup' | 'cancelled' | 'delivered' | 'error' | 'failure' | 'return_to_sender' | 'expired' — Status of shipment - `tracker` string — Tracking number - `trackingUrl` string — Tracking URL - `postageLabel` string — Postage label URL - `formLabel` string — Form label URL - `shipmentGroupId` string — ID of the shipment group this shipment belongs to - `itemIds` string[] — IDs of the return items included in this shipment - `externalLocationId` string — External location ID for the destination of this shipment - `estimatedDeliveryDate` string — Estimated delivery date for this shipment - `deliveredAt` string — Date and time this shipment was delivered - `dropoffs` ReturnDropoffSchema[] — Array of QR-code-based dropoff entries for returns using drop-off methods such as BlueYonder/FedEx Easy Returns. Empty for standard label-based returns. - `shipmentGroupId` string, required — ID of the shipment group this dropoff belongs to - `provider` string, required — Dropoff provider name (e.g. "FedEx Easy Returns", "Virtual") - `qrCode` string — Raw QR code data - `qrCodeUrl` string — URL to a rendered QR code image - `shopifyOrderIds` string[] — Array of Shopify order IDs (deprecated, use externalOrderIds) - `source` object, required - `emailAddress` string, email, required — Email address. - `mailingAddress` AddressSchema, required — Address. - `city` string, required — City name - `country` string, required — Country code - `line1` string, required — Line 1 - `line2` string — Line 2 - `postalCode` string, required — Postal or ZIP code - `state` string, required — State or province - `name` PersonNameSchema, required — Person name. - `given` string, required — Given name - `surname` string, required — Surname - `phoneNumber` string, required — Phone number, in E.164 format - `status` 'open' | 'in_transit' | 'delivered' | 'needs_review' | 'in_review' | 'complete' | 'rejected' | 'flagged' | 'pre_shipment' | 'deleted', required — Return status. * open: Return has been approved and is awaiting shipment. * in_transit: Return shipment is in transit. * delivered: Return shipment has been delivered and awaiting processing. * needs_review: Return requires review before further action. * in_review: Return is currently being reviewed. * complete: The return has been completed successfully. * rejected: The return has been rejected. * flagged: A problem with return processing requires merchant action. * pre_shipment: Return requires pre-shipment merchant authorization. * deleted: The return has been deleted (Reset). - `tags` object[] — Tags associated with this return - `name` string, required — The tag's display name - `source` string, required — The source of the tag - `totals` object — Calculated totals for the return - `charge` object, required — The upsell amount for the exchange order - `amount` MoneySchema, required — Currency amount - `amount` string - `currency` string - `exchange` object, required — Total value of new items in exchange - `amount` MoneySchema, required — Currency amount - `amount` string - `currency` string - `refund` object, required — Total refund amount excluding shipping - `amount` MoneySchema, required — Currency amount - `amount` string - `currency` string - `storeCredit` object, required — Total store credit amount - `amount` MoneySchema, required — Currency amount - `amount` string - `currency` string - `type` 'claim' | 'return' | 'warranty' — Return type. - `updatedAt` string, date-time, required — Time of last update. ## Other responses - `default` — Error --- [API](https://skmtc.dev/redoapp/apis/redo-api.md) · [All operations](https://skmtc.dev/redoapp/apis/redo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/redoapp/redo-api/revisions/119714540a45/schema)