useOrders

The useOrders hook fetches the user's recent order history from all Shop stores, sorted by most recent first. Use this for order history pages, reorder functionality, tracking shipments, or customer support features. Orders are aggregated across all merchants the user has purchased from through Shop.

Caution

This hook requires adding the following scopes to the manifest file:

orders

For more details, see manifest.json.

Anchor to useOrders
useOrders(
params
)

Anchor to useOrders-parametersParameters

Anchor to params params

Anchor to useOrders-returnsReturns

UseOrdersParams

fetchPolicy
```
DataHookFetchPolicy
```
first
```
number
```
skip
```
boolean
```

DataHookFetchPolicy

'cache-first' | 'network-only'

UseOrdersReturns

error
```
Error | null
```
fetchMore
```
() => Promise<void>
```
hasNextPage
```
boolean
```
loading
```
boolean
```
orders
```
Order[] | null
```
refetch
```
() => Promise<void>
```

Order

id
```
string
```

lineItems

{ productTitle: string; variantTitle: string; quantity: number; product: Product; }[]

name
```
string
```
shop
```
Shop | null
```

Product

compareAtPrice
```
Money | null
```
defaultVariantId
```
string
```
featuredImage
```
ProductImage | null
```
id
```
string
```
isFavorited
```
boolean
```
price
```
Money
```
referral
```
boolean
```

reviewAnalytics

{ averageRating?: number; reviewCount?: number; }

selectedVariant
```
ProductVariant
```
shop
```
ProductShop
```
title
```
string
```
variants
```
ProductVariant[]
```

Money

amount
```
Decimal
```
currencyCode
```
CurrencyCode
```

Decimal

string

CurrencyCode

'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KID' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'XXX' | 'YER' | 'ZAR' | 'ZMW'

ProductImage

altText
```
string | null
```
height
```
number | null
```
id
```
string | null
```
sensitive
```
boolean | null
```
thumbhash
```
string | null
```
url
```
string
```
width
```
number | null
```

ProductVariant

availableForSale
Whether the variant can be purchased. When `false`, calls to add the variant to cart or buy it through the SDK will fail. UI should be gated on this flag. May be `undefined` if the variant was sourced from an API that does not expose stock state.
```
boolean
```
compareAtPrice
```
Money | null
```
id
```
string
```
image
```
ProductImage | null
```
isFavorited
```
boolean
```
price
```
Money
```
title
```
string
```

ProductShop

id
```
string
```
name
```
string
```

Shop

id
```
string
```
isFollowing
```
boolean | null
```
logoImage
```
ProductImage | null
```
name
```
string
```
primaryDomain
```
{ url: string; }
```

reviewAnalytics

{ averageRating?: number; reviewCount: number; }

shareUrl
```
string | null
```
visualTheme
```
VisualTheme | null
```

VisualTheme

brandSettings
```
BrandSettings | null
```
description
```
string | null
```
featuredImages
```
ImageType[]
```
id
```
string
```
logoImage
```
ImageType | null
```

BrandSettings

colors
```
ColorTheme | null
```
headerTheme
```
HeaderTheme | null
```
id
```
string
```
logos
```
LogoTheme | null
```

ColorTheme

coverDominant
```
string | null
```
id
```
string
```
logoAverage
```
string | null
```
logoDominant
```
string | null
```
primary
```
string | null
```
secondary
```
string | null
```
secondaryText
```
string | null
```
statusBarStyle
```
string | null
```

HeaderTheme

coverImage
```
ImageType | null
```
endingScrimColor
```
string | null
```
id
```
string
```
startingScrimColor
```
string | null
```
thumbnailImage
```
ImageType | null
```
videoUrl
```
string | null
```
wordmark
```
ImageType | null
```

ImageType

altText
```
string | null
```
height
```
number | null
```
sensitive
```
boolean
```
thumbhash
```
string | null
```
url
```
string
```
width
```
number | null
```

LogoTheme

id
```
string
```
logoImage
```
ImageType | null
```

Examples

tsx

import {useOrders} from '@shopify/shop-minis-react'

export default function MyComponent() {

const {orders, loading, error} = useOrders()

console.log({orders, loading, error})

}

Was this page helpful?