How to get Refund Status and Timestamps(DateTime) via Shopify GraphQL Refund API?

GraphQL Admin API Troubleshooting
1

Hi,

In the Shopify Admin interface, refund details include various statuses such as:

  • “A x.xx USD refund is pending”
  • “Someone refunded 1 item”
  • “x.xx USD was refunded using a Card ending in XXXX.”

However, when using the Shopify GraphQL Refund API, the refund objects do not include a status field.

  1. How can I obtain the refund status information using the Shopify GraphQL Refund API?
  2. Is there a way to retrieve the timestamps for each refund status change?
2

Looks like there is information in transactions, not sure if it is what you want.

query refund($input: ID!) {
  refund (id: $input) { 
    id
    transactions(first:250) {
      edges {
        nodes {
          status
        }
      }
    }
  }
}
2 Likes
3

@dogowner

Thank you for the explanation.

I do have one question, though. The transactions field is an array, but it only contains a single element.

For example:

  • refund1 shows only the SUCCESS state.
  • refund2 shows only the PENDING state.

I would have expected the transactions array in refund1 to contain two elements, as the state must have been PENDING before transitioning to SUCCESS.

Would you happen to know why this is the case?

4

@Yoonsoo_Shin did you try using the orders sales agreements with the happenedAt filed?
order>agreements>RefundAgreement

something like this:

{
  orders(first: 10) {
    edges {
      node {
        id
        agreements(first: 10) {
          edges {
            node {
              ... on RefundAgreement {
                id
                happenedAt
              }
            }
          }
        }
      }
    }
  }
}

im also looking in to a way to get a list of refunds (and orders sales) timeline but not finding anything consistent :frowning:

5

I see what you mean. I think it is a list/array because it could involve two cards or maybe a credit card transaction AND a gift card transaction. I’m not 100% sure because I’d have to test it.

But I now understand that you are looking for the history of the transaction’s state. I’m not sure that is available, I think I tried to access that information before. You mean the “timeline” as seen below an order in the admin right ?

6

@Yoonsoo_Shin

Actually it seems that you might be able to access the timeline via orders.events:

Looks like you’d need to query out the refund events and it might not be structured to be easily usable, ie. if you have to parse out the refund state. Maybe I’ll try it later if I have time to write up a test query.

7

@Esti_Zeldman
Thank you for your response.

I did not know about the orders sales agreements field you mentioned, so I tried using it. It works well, but it does not provide the timeline with refund status associated lineItem or fulfillmentLineItemId. Therefore, it might be difficult to use it. I need to know which lineItem or fulfillmentLineItem was refunded and when, based on the refund status.

8

@dogowner
Yes, I need to get the timeline based on the refund status.

The orders.events field is very useful, but it doesn’t provide detailed information. Therefore, I can’t determine which lineItem or fulfillmentLineItem had a specific refund status at that time.
Thank you so much.