The checkout object

A checkout object is an object that represents checkout information.

The following table lists the attributes of the checkout object:

Name	Type	Description
total	float	Required.Final price paid including tax and other fees.
order_id	string	Required.Website order ID to track the order.
subtotal	float	Optional.Subtotal of the products' purchase price excluding tax and shipping cost.
tax	float	Optional.Tax for the order.
shipping_cost	float	Optional.Shipping cost.Default value: 0.
shipping_address	Address object	Optional.User's address information.If this is not provided, defaults to address in the user object.
store	Store object	Optional.An object that represents the store this product is being shipped or picked up from.NoteA store specified in the checkout object overrides a store specified in the context object.
shipping_method	string	Optional.Used to identify the type of order. For valid values, refer to the following shipping methods.

Shipping methods

The shipping_method attribute indicates the type of order.

The following table lists valid values for the shipping_method attribute:

Method	Description
`bopis`	Buy online, pick up in store.
`bopcs`	Buy online, pick up curbside.
`ropis`	Reserve online, pick up in store.
`same_day_shipping`	Regular web transaction shipped to home the same day.
`one_to_two_day_shipping`	Regular web transaction shipped to home in one or two days.
`standard_shipping`	Regular web transaction shipped to a provided address within an unspecified timeline.

The following is an example of a checkout object:

"checkout": {
  "subtotal": 29.98,
  "total": 35.97,
  "order_id": "1234"
  }

If you have suggestions for improving this article, let us know!