Queries
returnByID
Returns a ReturnOrder object by ID. This query can be used to retrieve information about the individual return request.
Arguments
input
required
The input object. See ReturnByIdInput.
Returns
ReturnOrder.*
Any requested field from the ReturnOrder
object.
Example - request
Query arguments
{
"input":{
"orderId": "b380dcf1-1d68-48c7-b70c-ff0f7d63bcf5",
"returnId": "cdb475e6-466d-4def-a5fa-602e1fa7d8e3"
}
}
GraphQL
query ReturnById($input: ReturnByIdInput!) {
returnByID(input: $input) {
...on ReturnAmazon {
marketplace
amazonOrderId
lineItems {
status
productId
quantity
}
}
...on ReturnShopify {
marketplace
orderId
lineItems {
status
variantId
quantity
currencyCode
price
}
}
}
}
Example - response
Response
{
"data": {
"returnByID": {
"marketplace": "SHOPIFY",
"orderId": "5776005693737",
"lineItems": [
{
"status": "RETURN_CLOSED",
"variantId": "46579981844777",
"quantity": 1,
"currencyCode": "USD",
"price": "24.99"
}
]
}
}
}
Was this page helpful?