Checkout
Version 1.0.1
Endpoint
POST
https://partner.att.com/omni-svcs/v1/checkout
Copy
Retrieves checkout configuration data including fulfillment options, available appointment time slots for technician installation, and contract terms based on the customer's shopping cart. The cartId is used to pull appointment data and terms data for technician installation. If the fulfillmentAddressId is provided, the API fetches fulfillment options based on that alternate address, supporting address change scenarios during checkout.
Checkout configuration request parameters.
Header Parameters
- appnamestringApplication name making the request
Body Parameters
- objectRequest payload for retrieving checkout configuration options.
- cartIdstringRequiredUnique identifier for the shopping cart. This field is required and is used to retrieve appointment data and terms data for technician installation.
- fulfillmentAddressIdstringAddress ID of the fulfillment address. This optional field is used for address change scenarios. When provided, fulfillment options will be returned based on this address. If not provided and fulfillment was already selected for the cart, fulfillment options will not be returned. Otherwise, the default service address will be used as the fulfillment address.
Responses
Successful response containing checkout configuration data including fulfillment options, appointment dates, terms and conditions, and validation status.
Body
application/json
- objectRequiredResponse payload containing checkout configuration data including fulfillment options, appointment dates, terms and conditions, and validation status.
- fulfillmentOptionsarray of objects
List of available fulfillment options including delivery methods, dates, and pricing information.
Represents a fulfillment option with delivery methods, dates, pricing, and availability information. - appointmentDatesobjectThis resource contains available appointment time slots for technician installation. It includes both real-time appointments with specific date/time windows and preferred calendar period slots with flexible scheduling options.
- termsarray of objects
Array of terms and conditions objects that customers must review and accept during checkout. Includes both static and dynamic terms with associated metadata and resources.
- validationobjectValidation result that is associated with the product order