return
Important
The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.
Overview
Returns a single return.
Response
Return type Return
Arguments
| Argument | Description |
|---|---|
input (ReturnIdentifierInput required) | Identifier of the return to retrieve. |
Examples
Get Return With Submitted Reason Andreturn Delivery Offer Before Return Is Submitted
Request
query return($input: ReturnIdentifierInput!) {
return(input: {
id: "return-id"
}
) {
returnDetails {
id
createdAt
updatedAt
expiresAt
aliases {
aliasId
aliasType
}
returnLineItems {
id
product {
amazonSku {
marketplaceId
value
}
externalId {
value
}
image {
altText
displayReadyUrl
sourceUrl
}
offerPrime
productId {
value
}
productDetailPageUrl
sku {
value
}
price {
amount
currencyCode
}
}
returnReasonTerm {
additionalComments {
locale
value
}
description {
locale
value
}
reasonCode
isCommentRequired
}
returnReasonTermOptions {
additionalComments {
locale
value
}
description {
locale
value
}
reasonCode
isCommentRequired
}
returnFor {
orderLineItemAmounts {
amount {
unit
value
}
lineItem {
id
amount {
unit
value
}
}
}
}
grading {
summary {
gradedAmount {
unit
value
}
unitWiseCondition {
condition
amount {
unit
value
}
}
}
}
}
aliases {
aliasId
aliasType
}
state
refundTerm {
displayMessage {
locale
value
}
estimatedRefundTotal {
totalAmount {
amount
currencyCode
}
}
paymentTerms {
type
paymentMethodDisplayString {
locale
value
}
estimatedAmount {
amount
currencyCode
}
}
}
returnPackageDetails {
id
labels {
type
url
returnLabelDisplayString {
locale
value
}
}
instructions {
locale
value
}
reason
rma
state
packageTrackerIdentifier {
carrierCode
trackingNumber
}
returnPackageFor {
orderLineItemAmounts {
amount {
unit
value
}
lineItem {
id
}
}
returnLineItemAmounts {
amount {
unit
value
}
returnLineItem {
id
}
}
}
}
returnDeliveryGroups {
returnDeliveryOffer {
details {
id
message {
instructions {
locale
value
}
}
price {
rollupPrices {
type
value {
amount
currencyCode
}
}
totalPrice {
amount
}
}
returnDeliveryTerm {
locator {
url
locatorDisplayString {
locale
value
}
}
}
returnDeliveryOfferFor {
orderLineItemAmounts {
amount {
unit
value
}
lineItem {
id
}
}
returnLineItemAmounts {
amount {
unit
value
}
returnLineItem {
id
}
}
}
}
}
returnDeliveryOfferOptions {
details {
id
message {
instructions {
locale
value
}
returnDeliveryOfferDisplayString {
locale
value
}
}
price {
rollupPrices {
type
value {
amount
currencyCode
}
}
totalPrice {
amount
currencyCode
}
}
returnDeliveryOfferFor {
orderLineItemAmounts {
amount {
unit
value
}
lineItem {
id
}
}
returnLineItemAmounts {
amount {
unit
value
}
returnLineItem {
id
}
}
}
returnDeliveryTerm {
locator {
locatorDisplayString {
locale
value
}
url
}
}
}
}
}
}
}
}
Response
{
"data": {
"return": {
"returnDetails": {
"id": "return-id",
"createdAt": "2024-12-24T08:52:08.592403284Z",
"updatedAt": "2024-12-24T08:52:08.592403284Z",
"expiresAt": null,
"aliases": null,
"returnLineItems": [
{
"id": "3874-76351",
"product": {
"amazonSku": {
"marketplaceId": "ATVPDKIKX0DER:B002EDAIJY",
"value": "B002EDAIJY"
},
"externalId": null,
"image": {
"altText": null,
"displayReadyUrl": "https://amazon-omni-cdn.com/n0g6ddlbju8/joa75jg440wrv4/31B-oBRVzkL._SS60_.jpeg",
"sourceUrl": "https://amazon-omni-cdn.com/n0g6ddlbju8/joa75jg440wrv4/31B-oBRVzkL._SS60_.jpeg"
},
"offerPrime": true,
"productId": {
"value": "9yk0y80ttcnwi3"
},
"productDetailPageUrl": "https://www.amazon.com/dp/B08Y675271?ref=myi_title_dp",
"sku": {
"value": "B002EDAIJY"
},
"price": {
"amount": 1.0,
"currencyCode": "USD"
}
},
"returnReasonTerm": {
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Item arrived too late"
},
"reasonCode": "CR-MISSED_ESTIMATED_DELIVERY",
"isCommentRequired": null
},
"returnReasonTermOptions": [
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "No longer needed"
},
"reasonCode": "CR-UNWANTED_ITEM",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Missing or broken parts"
},
"reasonCode": "CR-MISSING_PARTS",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Wrong item was sent"
},
"reasonCode": "CR-SWITCHEROO",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Item defective or doesn’t work"
},
"reasonCode": "CR-DEFECTIVE",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Bought by mistake"
},
"reasonCode": "CR-ORDERED_WRONG_ITEM",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Product and shipping box both damaged"
},
"reasonCode": "CR-DAMAGED_BY_CARRIER",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Inaccurate website description"
},
"reasonCode": "AMZ-PG-BAD-DESC",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Item arrived too late"
},
"reasonCode": "CR-MISSED_ESTIMATED_DELIVERY",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Product damaged, but shipping box OK"
},
"reasonCode": "CR-DAMAGED_BY_FC",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Better price available"
},
"reasonCode": "CR-FOUND_BETTER_PRICE",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Bought wrong size, style, or color"
},
"reasonCode": "AMZ-PG-MISORDERED",
"isCommentRequired": false
}
],
"returnFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f",
"amount": {
"unit": "ONE",
"value": 1
}
}
}
]
},
"grading": null
}
],
"state": "DRAFT",
"refundTerm": {
"displayMessage": {
"locale": "en-US",
"value": "Estimated refund"
},
"estimatedRefundTotal": {
"totalAmount": {
"amount": 1.00,
"currencyCode": "USD"
}
},
"paymentTerms": []
},
"returnPackageDetails": null,
"returnDeliveryGroups": [
{
"returnDeliveryOffer": {
"details": {
"id": "753-081",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "Staples will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any Staples store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
]
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0
}
},
"returnDeliveryTerm": {
"locator": {
"url": "",
"locatorDisplayString": {
"locale": "en-US",
"value": "Choose dropoff location"
}
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "e655b7d028-f471152e3f#a0c9fbee-e668-b012-0202-be882dbd9ec1"
}
}
]
}
}
},
"returnDeliveryOfferOptions": [
{
"details": {
"id": "345-791",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "Amazon will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any Amazon Fresh or Amazon Go store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
],
"returnDeliveryOfferDisplayString": {
"locale": "en-US",
"value": "Amazon Go - No box or label needed"
}
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
},
"returnDeliveryTerm": {
"locator": {
"locatorDisplayString": {
"locale": "en-US",
"value": "Choose dropoff location"
},
"url": ""
}
}
}
},
{
"details": {
"id": "109-851",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "Whole Foods will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any Whole Foods store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
],
"returnDeliveryOfferDisplayString": {
"locale": "en-US",
"value": "Whole Foods Dropoff - No box or label needed"
}
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
},
"returnDeliveryTerm": {
"locator": {
"locatorDisplayString": {
"locale": "en-US",
"value": "Find a Whole Foods store"
},
"url": "https://www.wholefoodsmarket.com/stores"
}
}
}
},
{
"details": {
"id": "753-081",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "Staples will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any Staples store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
],
"returnDeliveryOfferDisplayString": {
"locale": "en-US",
"value": "Staples Dropoff - no box or label needed"
}
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
},
"returnDeliveryTerm": {
"locator": {
"locatorDisplayString": {
"locale": "en-US",
"value": "Choose dropoff location"
},
"url": ""
}
}
}
},
{
"details": {
"id": "001-971",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "Amazon will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any Amazon Fresh or Amazon Go store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
],
"returnDeliveryOfferDisplayString": {
"locale": "en-US",
"value": "Amazon Fresh - No box or label needed"
}
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
},
"returnDeliveryTerm": {
"locator": {
"locatorDisplayString": {
"locale": "en-US",
"value": "Choose dropoff location"
},
"url": ""
}
}
}
},
{
"details": {
"id": "444-555",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "The UPS Store will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any The UPS Store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
],
"returnDeliveryOfferDisplayString": {
"locale": "en-US",
"value": "The UPS Store Dropoff - No box or label needed"
}
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
},
"returnDeliveryTerm": {
"locator": {
"locatorDisplayString": {
"locale": "en-US",
"value": "Find The UPS Store"
},
"url": "https://www.theupsstore.com/tools/find-a-store"
}
}
}
}
]
}
]
}
}
}
}
Get Return With Return Delivery Offers Before Return Is Submitted
Request
query return($input: ReturnIdentifierInput!) {
return(input: {
id: "return-id"
}
) {
returnDetails {
id
createdAt
updatedAt
expiresAt
aliases {
aliasId
aliasType
}
state
refundTerm {
displayMessage {
locale
value
}
estimatedRefundTotal {
totalAmount {
amount
currencyCode
}
}
paymentTerms {
type
paymentMethodDisplayString {
locale
value
}
estimatedAmount {
amount
currencyCode
}
}
}
returnDeliveryGroups {
returnDeliveryOffer {
details {
id
message {
instructions {
locale
value
}
}
price {
rollupPrices {
type
value {
amount
currencyCode
}
}
totalPrice {
amount
}
}
returnDeliveryTerm {
locator {
url
locatorDisplayString {
locale
value
}
}
}
returnDeliveryOfferFor {
orderLineItemAmounts {
amount {
unit
value
}
lineItem {
id
}
}
returnLineItemAmounts {
amount {
unit
value
}
returnLineItem {
id
}
}
}
}
}
returnDeliveryOfferOptions {
details {
id
message {
instructions {
locale
value
}
returnDeliveryOfferDisplayString {
locale
value
}
}
price {
rollupPrices {
type
value {
amount
currencyCode
}
}
totalPrice {
amount
currencyCode
}
}
returnDeliveryOfferFor {
orderLineItemAmounts {
amount {
unit
value
}
lineItem {
id
}
}
returnLineItemAmounts {
amount {
unit
value
}
returnLineItem {
id
}
}
}
returnDeliveryTerm {
locator {
locatorDisplayString {
locale
value
}
url
}
}
}
}
}
}
}
}
Response
{
"data": {
"return": {
"returnDetails": {
"id": "return-id",
"createdAt": "2024-12-24T08:52:08.592403284Z",
"updatedAt": "2024-12-24T08:52:08.592403284Z",
"expiresAt": null,
"aliases": null,
"state": "DRAFT",
"refundTerm": {
"displayMessage": {
"locale": "en-US",
"value": "Estimated refund"
},
"estimatedRefundTotal": {
"totalAmount": {
"amount": 1.00,
"currencyCode": "USD"
}
},
"paymentTerms": []
},
"returnDeliveryGroups": [
{
"returnDeliveryOffer": {
"details": {
"id": "753-081",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "Staples will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any Staples store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
]
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0
}
},
"returnDeliveryTerm": {
"locator": {
"url": "",
"locatorDisplayString": {
"locale": "en-US",
"value": "Choose dropoff location"
}
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
}
}
},
"returnDeliveryOfferOptions": [
{
"details": {
"id": "345-791",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "Amazon will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any Amazon Fresh or Amazon Go store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
],
"returnDeliveryOfferDisplayString": {
"locale": "en-US",
"value": "Amazon Go - No box or label needed"
}
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
},
"returnDeliveryTerm": {
"locator": {
"locatorDisplayString": {
"locale": "en-US",
"value": "Choose dropoff location"
},
"url": ""
}
}
}
},
{
"details": {
"id": "109-851",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "Whole Foods will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any Whole Foods store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
],
"returnDeliveryOfferDisplayString": {
"locale": "en-US",
"value": "Whole Foods Dropoff - No box or label needed"
}
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
},
"returnDeliveryTerm": {
"locator": {
"locatorDisplayString": {
"locale": "en-US",
"value": "Find a Whole Foods store"
},
"url": "https://www.wholefoodsmarket.com/stores"
}
}
}
},
{
"details": {
"id": "753-081",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "Staples will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any Staples store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
],
"returnDeliveryOfferDisplayString": {
"locale": "en-US",
"value": "Staples Dropoff - no box or label needed"
}
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
},
"returnDeliveryTerm": {
"locator": {
"locatorDisplayString": {
"locale": "en-US",
"value": "Choose dropoff location"
},
"url": ""
}
}
}
},
{
"details": {
"id": "001-971",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "Amazon will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any Amazon Fresh or Amazon Go store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
],
"returnDeliveryOfferDisplayString": {
"locale": "en-US",
"value": "Amazon Fresh - No box or label needed"
}
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
},
"returnDeliveryTerm": {
"locator": {
"locatorDisplayString": {
"locale": "en-US",
"value": "Choose dropoff location"
},
"url": ""
}
}
}
},
{
"details": {
"id": "444-555",
"message": {
"instructions": [
{
"locale": "en-US",
"value": "The UPS Store will pack, label, and ship your return for free. Just bring the item in its original packaging and disassemble it, if needed. We'll email you a return shipping code. Show it to an associate at any The UPS Store."
},
{
"locale": "en-US",
"value": "Printer not required."
}
],
"returnDeliveryOfferDisplayString": {
"locale": "en-US",
"value": "The UPS Store Dropoff - No box or label needed"
}
},
"price": {
"rollupPrices": [],
"totalPrice": {
"amount": 0,
"currencyCode": "USD"
}
},
"returnDeliveryOfferFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
},
"returnDeliveryTerm": {
"locator": {
"locatorDisplayString": {
"locale": "en-US",
"value": "Find The UPS Store"
},
"url": "https://www.theupsstore.com/tools/find-a-store"
}
}
}
}
]
}
]
}
}
}
}
Get Return With Reasons Before Return Is Submitted
Request
query return($input: ReturnIdentifierInput!) {
return(input: {
id: "return-id"
}
) {
returnDetails {
id
createdAt
updatedAt
expiresAt
returnLineItems {
id
returnReasonTerm {
additionalComments {
locale
value
}
description {
locale
value
}
reasonCode
isCommentRequired
}
returnReasonTermOptions {
additionalComments {
locale
value
}
description {
locale
value
}
reasonCode
isCommentRequired
}
}
state
}
}
}
Response
{
"data": {
"return": {
"returnDetails": {
"id": "return-id",
"createdAt": "2024-12-24T08:52:08.592403284Z",
"updatedAt": "2024-12-24T08:52:08.592403284Z",
"expiresAt": null,
"aliases": null,
"returnLineItems": [
{
"id": "3874-76351",
"returnReasonTerm": {
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Item arrived too late"
},
"reasonCode": "CR-MISSED_ESTIMATED_DELIVERY",
"isCommentRequired": null
},
"returnReasonTermOptions": [
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Inaccurate website description"
},
"reasonCode": "AMZ-PG-BAD-DESC",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Better price available"
},
"reasonCode": "CR-FOUND_BETTER_PRICE",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Missing or broken parts"
},
"reasonCode": "CR-MISSING_PARTS",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Bought by mistake"
},
"reasonCode": "CR-ORDERED_WRONG_ITEM",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Product and shipping box both damaged"
},
"reasonCode": "CR-DAMAGED_BY_CARRIER",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Item defective or doesn’t work"
},
"reasonCode": "CR-DEFECTIVE",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Bought wrong size, style, or color"
},
"reasonCode": "AMZ-PG-MISORDERED",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Item arrived too late"
},
"reasonCode": "CR-MISSED_ESTIMATED_DELIVERY",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Product damaged, but shipping box OK"
},
"reasonCode": "CR-DAMAGED_BY_FC",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "No longer needed"
},
"reasonCode": "CR-UNWANTED_ITEM",
"isCommentRequired": false
},
{
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Wrong item was sent"
},
"reasonCode": "CR-SWITCHEROO",
"isCommentRequired": false
}
]
}
],
"state": "DRAFT"
}
}
}
}
Get Return After Return Is Submitted
Request
query return($input: ReturnIdentifierInput!) {
return(input: {
id: "return-id"
}
) {
returnDetails {
id
createdAt
updatedAt
expiresAt
aliases {
aliasId
aliasType
}
returnLineItems {
id
product {
amazonSku {
marketplaceId
value
}
externalId {
value
}
image {
altText
displayReadyUrl
sourceUrl
}
offerPrime
productId {
value
}
productDetailPageUrl
sku {
value
}
price {
amount
currencyCode
}
}
returnReasonTerm {
additionalComments {
locale
value
}
description {
locale
value
}
reasonCode
isCommentRequired
}
returnReasonTermOptions {
additionalComments {
locale
value
}
description {
locale
value
}
reasonCode
isCommentRequired
}
returnFor {
orderLineItemAmounts {
amount {
unit
value
}
lineItem {
id
amount {
unit
value
}
}
}
}
grading {
summary {
gradedAmount {
unit
value
}
unitWiseCondition {
condition
amount {
unit
value
}
}
}
}
}
aliases {
aliasId
aliasType
}
state
refundTerm {
displayMessage {
locale
value
}
estimatedRefundTotal {
totalAmount {
amount
currencyCode
}
}
paymentTerms {
type
paymentMethodDisplayString {
locale
value
}
estimatedAmount {
amount
currencyCode
}
}
}
returnPackageDetails {
id
labels {
type
url
returnLabelDisplayString {
locale
value
}
}
instructions {
locale
value
}
reason
rma
state
packageTrackerIdentifier {
carrierCode
trackingNumber
}
returnPackageFor {
orderLineItemAmounts {
amount {
unit
value
}
lineItem {
id
}
}
returnLineItemAmounts {
amount {
unit
value
}
returnLineItem {
id
}
}
}
}
returnDeliveryGroups {
returnDeliveryOffer {
details {
id
message {
instructions {
locale
value
}
}
price {
rollupPrices {
type
value {
amount
currencyCode
}
}
totalPrice {
amount
}
}
returnDeliveryTerm {
locator {
url
locatorDisplayString {
locale
value
}
}
}
returnDeliveryOfferFor {
orderLineItemAmounts {
amount {
unit
value
}
lineItem {
id
}
}
returnLineItemAmounts {
amount {
unit
value
}
returnLineItem {
id
}
}
}
}
}
returnDeliveryOfferOptions {
details {
id
message {
instructions {
locale
value
}
returnDeliveryOfferDisplayString {
locale
value
}
}
price {
rollupPrices {
type
value {
amount
currencyCode
}
}
totalPrice {
amount
currencyCode
}
}
returnDeliveryOfferFor {
orderLineItemAmounts {
amount {
unit
value
}
lineItem {
id
}
}
returnLineItemAmounts {
amount {
unit
value
}
returnLineItem {
id
}
}
}
returnDeliveryTerm {
locator {
locatorDisplayString {
locale
value
}
url
}
}
}
}
}
}
}
}
Response
{
"data": {
"return": {
"returnDetails": {
"id": "return-id",
"createdAt": "2024-12-24T08:52:08.592403284Z",
"updatedAt": "2024-12-24T08:52:08.592403284Z",
"expiresAt": "1970-01-21T02:53:16.799Z",
"aliases": null,
"returnLineItems": [
{
"id": "3874-76351",
"product": {
"amazonSku": {
"marketplaceId": "ATVPDKIKX0DER:B002EDAIJY",
"value": "B002EDAIJY"
},
"externalId": null,
"image": {
"altText": null,
"displayReadyUrl": "https://amazon-omni-cdn.com/n0g6ddlbju8/joa75jg440wrv4/31B-oBRVzkL._SS60_.jpeg",
"sourceUrl": "https://amazon-omni-cdn.com/n0g6ddlbju8/joa75jg440wrv4/31B-oBRVzkL._SS60_.jpeg"
},
"offerPrime": true,
"productId": {
"value": "9yk0y80ttcnwi3"
},
"productDetailPageUrl": "https://www.amazon.com/dp/B08Y675271?ref=myi_title_dp",
"sku": {
"value": "B002EDAIJY"
},
"price": {
"amount": 1.0,
"currencyCode": "USD"
}
},
"returnReasonTerm": {
"additionalComments": null,
"description": {
"locale": "en-US",
"value": "Item arrived too late"
},
"reasonCode": "CR-MISSED_ESTIMATED_DELIVERY",
"isCommentRequired": null
},
"returnReasonTermOptions": null,
"returnFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f",
"amount": {
"unit": "ONE",
"value": 1
}
}
}
]
},
"grading": null
}
],
"state": "CREATED",
"refundTerm": {
"displayMessage": {
"locale": "en-US",
"value": "Estimated refund"
},
"estimatedRefundTotal": {
"totalAmount": {
"amount": 1.00,
"currencyCode": "USD"
}
},
"paymentTerms": []
},
"returnPackageDetails": [
{
"id": "9876gf-1g5678#RP",
"labels": [
{
"type": "MERGED",
"url": "https://prod-us-east-1-649346713365-returnlabels.s3.amazonaws.com/Merged/f5c11d73-612e-4f57-a753-d5a50881734d_aec9fbf4-0bf8-82df-786a-15594d3cb50d%23RP?X-Amz-Security-Token=IQoJb3JpZ2luX2VjECEaCXVzLWVhc3QtMSJHMEUCIQCGkgjF2hVuSUtLl%2FGC056DKb0ESRtV5p8shXIi9p72ygIgEzbFJQc4lPB1GEMfvkQNFs%2F%2BeLPbfWH5kMFoIG8vjdoqqgII6f%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARACGgw2NDkzNDY3MTMzNjUiDKBkNjEnU0JQ9wbrrSr%2BASbpGKMHQ5kDr%2B0wqyxTmRUpyOp7%2FyB%2FshMBobGy538l2Kf7puUz4Myw9wSUMAOK5n61BUvuYYo87CBy8ZsDWSCFmYUhmSVYAx9bI8K2P1seKorUTBk4hKrEoL9e4s0sMhrpJI%2F8uNLMvM3BXzE%2FXZrX%2F3jCDj4VB6OtETk7VucKy%2FWIlfOiAaJEfw8GafyPOEFHY9%2BwCGEYgB1CHnnwH3Go84voCGQScgi14sk4KABeKmM%2Brs0%2Birdl0yI%2ByNCL92oX0SudLZaIdlBnkNmhQ8bn7t7d0vbFTf6pExdxy1suZrBa95rwdoSgBuBnUgNk00v%2FJjgWAY6Mv1sk53QaMKPdqbsGOo8BnN%2FDLMJ5o9nKCkDvTgrytTMz%2FbOXxrA%2BSjJpnRBIWCSdVQtF%2FmAXZFF208T9ElaOt12tXsbSfvwRkA2DmWSuCwaIkt9U8YW%2BNuhsh%2F1qGOCnWsiI%2Fh6oLHQYMoCjccS%2BW37J%2FH5m0wOaWt7NZiRKT%2Fqzfo8ajkizMNkuPhL44zi7rR38AH%2Bj%2F7pTe%2B1cC7w%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241224T091523Z&X-Amz-SignedHeaders=host&X-Amz-Credential=ASIAZOMAUQ4K22BT4RR5%2F20241224%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Expires=900&X-Amz-Signature=0aa4c21b34f667f0e5ba5cbf3336b9fff1fe383232ee7157402abc80edb95ad6",
"returnLabelDisplayString": {
"locale": "en-US",
"value": "Merged"
}
},
{
"type": "QR",
"url": "https://prod-us-east-1-649346713365-returnlabels.s3.amazonaws.com/sampleQR.png?X-Amz-Security-Token=IQoJb3JpZ2luX2VjECEaCXVzLWVhc3QtMSJHMEUCIQCGkgjF2hVuSUtLl%2FGC056DKb0ESRtV5p8shXIi9p72ygIgEzbFJQc4lPB1GEMfvkQNFs%2F%2BeLPbfWH5kMFoIG8vjdoqqgII6f%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARACGgw2NDkzNDY3MTMzNjUiDKBkNjEnU0JQ9wbrrSr%2BASbpGKMHQ5kDr%2B0wqyxTmRUpyOp7%2FyB%2FshMBobGy538l2Kf7puUz4Myw9wSUMAOK5n61BUvuYYo87CBy8ZsDWSCFmYUhmSVYAx9bI8K2P1seKorUTBk4hKrEoL9e4s0sMhrpJI%2F8uNLMvM3BXzE%2FXZrX%2F3jCDj4VB6OtETk7VucKy%2FWIlfOiAaJEfw8GafyPOEFHY9%2BwCGEYgB1CHnnwH3Go84voCGQScgi14sk4KABeKmM%2Brs0%2Birdl0yI%2ByNCL92oX0SudLZaIdlBnkNmhQ8bn7t7d0vbFTf6pExdxy1suZrBa95rwdoSgBuBnUgNk00v%2FJjgWAY6Mv1sk53QaMKPdqbsGOo8BnN%2FDLMJ5o9nKCkDvTgrytTMz%2FbOXxrA%2BSjJpnRBIWCSdVQtF%2FmAXZFF208T9ElaOt12tXsbSfvwRkA2DmWSuCwaIkt9U8YW%2BNuhsh%2F1qGOCnWsiI%2Fh6oLHQYMoCjccS%2BW37J%2FH5m0wOaWt7NZiRKT%2Fqzfo8ajkizMNkuPhL44zi7rR38AH%2Bj%2F7pTe%2B1cC7w%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241224T091523Z&X-Amz-SignedHeaders=host&X-Amz-Credential=ASIAZOMAUQ4K22BT4RR5%2F20241224%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Expires=900&X-Amz-Signature=3cfabeacbb317663cf8c779b3e10ac0d6a11806ce31bdb3e1e4f3c3975f11875",
"returnLabelDisplayString": {
"locale": "en-US",
"value": "QR"
}
}
],
"instructions": [
{
"locale": "en-US",
"value": " Show the QR code on your smartphone to a Staples Dropoff - no box or label needed associate in-store. Bring your item in its original manufacturer's packaging. If you assembled the item, please disassemble before returning."
},
{
"locale": "en-US",
"value": " Bring the item(s) you’re returning to any Staples Dropoff - no box or label needed location. Staples Dropoff - no box or label needed will pack, label, and ship your return for free."
}
],
"reason": null,
"rma": "RMA-39ee79d5-43b4-45ab-a7a9-7f774465536a",
"state": "CREATED",
"packageTrackerIdentifier": null,
"returnPackageFor": {
"orderLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"lineItem": {
"id": "e655b7d028-f471152e3f"
}
}
],
"returnLineItemAmounts": [
{
"amount": {
"unit": "ONE",
"value": 1
},
"returnLineItem": {
"id": "3874-76351"
}
}
]
}
}
],
"returnDeliveryGroups": null
}
}
}
}
Updated about 17 hours ago