Choose a version:

OrderReturnStatus

enum

The order's aggregated return status that's used for display purposes. An order might have multiple returns, so this field communicates the prioritized return status. The OrderReturnStatus enum is a supported filter parameter in the orders query.

Anchor to Valid valuesValid values

Anchor to IN_PROGRESSIN_PROGRESS: Some items in the order are being returned.
Anchor to INSPECTION_COMPLETEINSPECTION_COMPLETE: All return shipments from a return in this order were inspected.
Anchor to NO_RETURNNO_RETURN: No items in the order were returned.
Anchor to RETURN_FAILEDRETURN_FAILED: Some returns in the order were not completed successfully.
Anchor to RETURN_REQUESTEDRETURN_REQUESTED: A return was requested for some items in the order.
Anchor to RETURNEDRETURNED: Some items in the order were returned.

Was this section helpful?

Anchor to FieldsFields

Anchor to Order.returnStatus Order.returnStatus •OBJECT: The Order object represents a customer's request to purchase one or more products from a store. Use the Order object to handle the complete purchase lifecycle from checkout to fulfillment.

Use the Order object when you need to:

Display order details on customer account pages or admin dashboards.

Create orders for phone sales, wholesale customers, or subscription services.

Update order information like shipping addresses, notes, or fulfillment status.

Process returns, exchanges, and partial refunds.

Generate invoices, receipts, and shipping labels.

The Order object serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema.

Note
Only the last 60 days' worth of orders from a store are accessible from the Order object by default. If you want to access older records, then you need to request access to all orders. If your app is granted access, then you can add the read_all_orders, read_orders, and write_orders scopes.
Caution
Only use orders data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Learn more about building apps for orders and fulfillment.

Was this section helpful?