OrderAPI
The API for interacting with the order, available on the Order Status Page.
Anchor to orderstatusapiOrderStatusApi
The API object provided to this and other customer-account.order-status extension targets.
- Anchor to orderorderStatefulRemoteSubscribable< | undefined>required
Information about the order that was placed.
Docs_OrderStatus_OrderApi
- order
Information about the order that was placed.
StatefulRemoteSubscribable<Order | undefined>
export interface Docs_OrderStatus_OrderApi
extends Pick<OrderStatusApi<any>, 'order'> {}Order
Information about an order that was placed.
- cancelledAt
If cancelled, the time at which the order was cancelled.
string - confirmationNumber
A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.
string - id
A globally-unique identifier.
string - name
Unique identifier for the order that appears on the order.
string - processedAt
The date and time when the order was processed. Processing happens after the checkout has completed, and indicates that the order is available in the admin.
string
export interface Order {
/**
* A globally-unique identifier.
* @example 'gid://shopify/Order/1'
*/
id: string;
/**
* Unique identifier for the order that appears on the order.
* @example '#1000'
*/
name: string;
/**
* If cancelled, the time at which the order was cancelled.
*/
cancelledAt?: string;
/**
* The date and time when the order was processed.
* Processing happens after the checkout has completed, and indicates that the order is available in the admin.
*/
processedAt?: string;
/**
* A randomly generated alpha-numeric identifier for the order.
* For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.
*/
confirmationNumber?: string;
}Anchor to useOrderuse
Returns the order information that's available on the Order Status Page.
Anchor to useOrder-returnsReturns
UseOrderGeneratedType
Returns the order information that's available post-checkout.
Order | undefinedexport function useOrder<
Target extends RenderExtensionTarget = RenderExtensionTarget,
>(): Order | undefined {
const api = useApi<Target>();
if ('order' in api) {
return useSubscription(api.order);
}
throw new ExtensionHasNoMethodError('order', (api as any).extension.target);
}Order
Information about an order that was placed.
- cancelledAt
If cancelled, the time at which the order was cancelled.
string - confirmationNumber
A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.
string - id
A globally-unique identifier.
string - name
Unique identifier for the order that appears on the order.
string - processedAt
The date and time when the order was processed. Processing happens after the checkout has completed, and indicates that the order is available in the admin.
string
export interface Order {
/**
* A globally-unique identifier.
* @example 'gid://shopify/Order/1'
*/
id: string;
/**
* Unique identifier for the order that appears on the order.
* @example '#1000'
*/
name: string;
/**
* If cancelled, the time at which the order was cancelled.
*/
cancelledAt?: string;
/**
* The date and time when the order was processed.
* Processing happens after the checkout has completed, and indicates that the order is available in the admin.
*/
processedAt?: string;
/**
* A randomly generated alpha-numeric identifier for the order.
* For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.
*/
confirmationNumber?: string;
}