Skip to main content

OrderHistory

Overview​

The OrderHistory type represents the order history for a customer in the High Velocity front-end app. It includes an order summaries list and paging information.

Attributes​

orders​

type: OrderHistoryOrderReference[]

The summary list of orders in the order history.

paging​

type: object


The paging information for the order history.

paging.total​

type: number


The total number of items.

paging.offset​

type: number


The offset of the current page.

paging.limit​

type: number


The limit of items per page.

OrderHistoryOrderReference​

The OrderHistoryOrderReference type represents a reference to order detail in the order history. It includes a summary of order attributes.

note

You are not stuck with these attributes, since you have full control of the code in High Velocity, you are free to modify, remove, or add attributes

Attributes​

id​

type: string


The unique identifier for the order.

status​

type: OrderStatus


The status of the order. Possible values are:

  • pending
  • shipped
  • delivered
  • cancelled

orderPlaced​

type: DateModel

The date when the order was placed.

itemCount​

type: number


The total number of items in the order.

lineItems​

type: object[]


A summary list of line items in the order.

lineItems[].id​

type: string


The unique identifier for the line item.

lineItems[].name​

type: string


The name of the product.

lineItems[].imageUrl​

type: string


The URL of the product image.