Responses
-
Successfully retrieved the list of carts.
Hide response attribute Show response attribute object
-
The list of carts for the current page.
Hide data attributes Show data attributes object
-
The checkout associated with this cart.
Hide checkout attributes Show checkout attributes object
- actions
object Required The actions that are required to complete the checkout process.
One of: Hide attributes Show attributes
-
The unique identifier of the cart item this action is scoped to, or null if the action applies to the entire transaction.
-
The default value of the action if no value is provided.
-
The description of the action that is required for the cart checkout.
-
The expected format of the input value.
Values are
TEXT,DECIMAL, orEMAIL. -
The localized label of the action.
-
The inclusive maximum value of the action when the format is DECIMAL. Ignored for other formats.
-
The inclusive minimum value of the action when the format is DECIMAL. Ignored for other formats.
-
The name of the action that is required for the cart checkout.
-
Whether the action is optional and does not need to be provided by the client.
-
The regular expression pattern that the action value must match. May be combined with any format.
-
The discriminator type of the action.
Value is
INPUT.
Hide attributes Show attributes
-
The unique identifier of the cart item this action is scoped to, or null if the action applies to the entire transaction.
-
The description of the action that is required for the cart checkout.
-
The localized label of the action.
-
The name of the action that is required for the cart checkout.
-
Whether the action is optional and does not need to be provided by the client.
-
The available options for the action.
Hide options attributes Show options attributes object
-
The localized detail of the option.
-
Whether the option is disabled and cannot be selected.
-
The icon URLs for the option.
-
The localized text of the option.
-
The localized title of the option.
-
The technical value of the option used for submission.
-
-
The discriminator type of the action.
Value is
MULTI_SELECT.
Hide attributes Show attributes
-
The unique identifier of the cart item this action is scoped to, or null if the action applies to the entire transaction.
-
The description of the action that is required for the cart checkout.
-
The localized label of the action.
-
The name of the action that is required for the cart checkout.
-
Whether the action is optional and does not need to be provided by the client.
- options
object Required The alternatives the user can choose between. Exactly one of them must be answered.
One of: Hide attributes Show attributes
-
The unique identifier of the cart item this action is scoped to, or null if the action applies to the entire transaction.
-
The default value of the action if no value is provided.
-
The description of the action that is required for the cart checkout.
-
The expected format of the input value.
Values are
TEXT,DECIMAL, orEMAIL. -
The localized label of the action.
-
The inclusive maximum value of the action when the format is DECIMAL. Ignored for other formats.
-
The inclusive minimum value of the action when the format is DECIMAL. Ignored for other formats.
-
The name of the action that is required for the cart checkout.
-
Whether the action is optional and does not need to be provided by the client.
-
The regular expression pattern that the action value must match. May be combined with any format.
-
The discriminator type of the action.
Value is
INPUT.
Hide attributes Show attributes
-
The unique identifier of the cart item this action is scoped to, or null if the action applies to the entire transaction.
-
The description of the action that is required for the cart checkout.
-
The localized label of the action.
-
The name of the action that is required for the cart checkout.
-
Whether the action is optional and does not need to be provided by the client.
-
The available options for the action.
Hide options attributes Show options attributes object
-
The localized detail of the option.
-
Whether the option is disabled and cannot be selected.
-
The icon URLs for the option.
-
The localized text of the option.
-
The localized title of the option.
-
The technical value of the option used for submission.
-
-
The discriminator type of the action.
Value is
MULTI_SELECT.
Hide attributes Show attributes
-
The unique identifier of the cart item this action is scoped to, or null if the action applies to the entire transaction.
-
The description of the action that is required for the cart checkout.
-
The localized label of the action.
-
The name of the action that is required for the cart checkout.
-
Whether the action is optional and does not need to be provided by the client.
-
The available options for the action.
Hide options attributes Show options attributes object
-
The localized detail of the option.
-
Whether the option is disabled and cannot be selected.
-
The icon URLs for the option.
-
The localized text of the option.
-
The localized title of the option.
-
The technical value of the option used for submission.
-
-
The discriminator type of the action.
Value is
SINGLE_SELECT.
-
-
The type of the action.
Value is
ONE_OF.
Hide attributes Show attributes
-
The unique identifier of the cart item this action is scoped to, or null if the action applies to the entire transaction.
-
The description of the action that is required for the cart checkout.
-
The localized label of the action.
-
The name of the action that is required for the cart checkout.
-
Whether the action is optional and does not need to be provided by the client.
-
The available options for the action.
Hide options attributes Show options attributes object
-
The localized detail of the option.
-
Whether the option is disabled and cannot be selected.
-
The icon URLs for the option.
-
The localized text of the option.
-
The localized title of the option.
-
The technical value of the option used for submission.
-
-
The discriminator type of the action.
Value is
SINGLE_SELECT.
-
-
The URL which the client may follow to complete the checkout process.
-
The timestamp when the cart checkout was cancelled.
-
The timestamp when the cart checkout was completed.
-
The timestamp when the cart checkout failed.
-
The failure code of the cart checkout. Free-form: new codes are introduced without a version change, so treat an unrecognized value as an unspecified failure.
-
The timestamp when the cart checkout was started.
-
The status of the cart checkout.
Values are
PROCESSING,ACTIONS_REQUIRED,COMPLETED,CANCELLED, orFAILED.
-
The unique identifier of the client through which this cart was created.
-
The timestamp when the cart was created.
-
The timestamp at which the cart lapses if nothing interacts with it before then. Every interaction with the cart pushes it further out, so read the current value rather than assuming a fixed window. It is null once the checkout has completed.
-
The unique identifier for the cart.
-
The unique identifier of the selected payment method for this cart.
-
The unique identifier of the POI associated with this cart.
-
The current status of the cart.
Values are
OPEN,PROCESSING,ACTIONS_REQUIRED,COMPLETED,CANCELLED, orFAILED. -
The timestamp when the cart was last updated.
-
The unique identifier of the user who owns this cart.
-
-
-
The request parameters are missing or invalid.
-
Client authentication failed.
-
Missing one or more required scopes.
-
An unexpected error occurred.
curl \
--request GET 'https://api.pace.cloud/cart/2026-2/carts' \
--header "Authorization: Bearer $ACCESS_TOKEN"
{
"data": [
{
"checkout": {
"actions": {
"cartItemId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"default": "7495345",
"description": "The car mileage is required to complete the cart checkout.",
"format": "TEXT",
"label": "Car Mileage",
"maximum": "100.00",
"minimum": "10.00",
"name": "CAR_MILEAGE",
"optional": false,
"pattern": "^[0-9]+$",
"type": "INPUT"
},
"actionsUrl": "https://example.com/checkout/actions",
"cancelledAt": "2023-05-15T14:30:00.000Z",
"completedAt": "2023-05-15T15:00:00.000Z",
"failedAt": "2023-05-15T14:30:00.000Z",
"failureCode": "INSUFFICIENT_FUNDS",
"startedAt": "2023-05-15T14:00:00.000Z",
"status": "PROCESSING"
},
"clientId": "pace-drive-app",
"createdAt": "2023-05-15T14:00:00.000Z",
"expiresAt": "2023-05-16T14:30:00.000Z",
"id": "ae1b58ef-ba5c-4240-b130-51fcf067d40d",
"paymentMethodId": "ecbec75f-7ca4-4017-a485-6a4836de5d25",
"poiId": "96a939ea-28d4-4228-b45c-192904ba91d7",
"status": "OPEN",
"updatedAt": "2023-05-15T14:15:00.000Z",
"userId": "e9166a60-1f92-4a5d-a192-c2f6b662e9d9"
}
]
}