Totals

The totals resource calculates the total costs for:

• cart
• line-item
• order
• shipment
• shipment-line-item

Read Cart Total

Retrieve the total cost of all cart line items before cart total discounts are applied.

Workflow

1. Start with cart
2. GET the link with rel: total
3. Render the response

Response Fields

Type: totals.total

Name	Description	Type
cost	The total costs. This is an array because the total cost have multiple currencies. For example, $20 USD + 20,000 loyalty points.	array
currency	The currency the cost is in.	string
amount	The decimal value of the cost.	decimal
display	Formatted currency string that can be displayed on the client application.	string

Read Cart Line Item Total

Retrieve the total cost of a single cart line item for a requested quantity, after cart line item discounts are applied.

Workflow

1. Start with line-item
2. GET the link with rel: total
3. Render the response

Response Fields

Type: totals.total

Name	Description	Type
cost	The total costs. This is an array because the total cost have multiple currencies. For example, $20 USD + 20,000 loyalty points.	array
currency	The currency the cost is in.	string
amount	The decimal value of the cost.	decimal
display	Formatted currency string that can be displayed on the client application.	string

Read Order Total

Retrieve the total cost of the shopper’s order including taxes and shipping costs.

Workflow

1. Start with order
2. GET the link with rel: total
3. Render the response

Response Fields

Type: totals.total

Name	Description	Type
cost	The total costs. This is an array because the total cost have multiple currencies. For example, $20 USD + 20,000 loyalty points.	array
currency	The currency the cost is in.	string
amount	The decimal value of the cost.	decimal
display	Formatted currency string that can be displayed on the client application.	string

Read Shipment Total

Retrieve the total cost for a shipment.

Workflow

1. Start with shipment
2. GET the link with rel: total
3. Render the response

Response Fields

Type: totals.total

Name	Description	Type
cost	The total costs. This is an array because the total cost have multiple currencies. For example, $20 USD + 20,000 loyalty points.	array
currency	The currency the cost is in.	string
amount	The decimal value of the cost.	decimal
display	Formatted currency string that can be displayed on the client application.	string

Read Shipment Line Item Total

Retrieve the total cost for a shipment line item.

Workflow

1. Start with shipment-line-item
2. GET the link with rel: total
3. Render the response

Response Fields

Type: totals.total

Name	Description	Type
cost	The total costs. This is an array because the total cost have multiple currencies. For example, $20 USD + 20,000 loyalty points.	array
currency	The currency the cost is in.	string
amount	The decimal value of the cost.	decimal
display	Formatted currency string that can be displayed on the client application.	string