Summary of Cart Prior to Order Submission

EndpointGET
undefined/msapi/sales/shopping-cart-api/v1/orders/summary
Copy
This API will return productOrder along with details of various referred entities in productOrder. It is useful for rendering cart review page prior to order submit or for generating order confirmation page or an order receipt. cartId query parameter to be used prior to order submit.
Security
httpThis API supports Basic Authentication.
scheme:basic
Request
Header Parameters
Query Parameters
Body Parameters
Responses
Bodyapplication/json
REQUEST
curl --request GET \
     --url 'https://example.com/msapi/sales/shopping-cart-api/v1/orders/summary?cartId=string&orderSummaryAccessToken=string&customerOrderId=string&resend=string' \
     --header 'accept: application/json'
RESPONSE
{
  "accountInfo": {
    "accounts": [
      {
        "@type": "billingAccount",
        "accountSubType": "R",
        "accountType": "I",
        "autoBillPayIndicator": "Y",
        "billStructure": {
          "cycleSpecification": {
            "frequency": "month",
            "id": "5",
            "name": "BillingCycleSpecification"
          },
          "presentationMedia": [
            {
              "id": "string",
              "name": "email"
            }
          ]
        },
        "contact": [
          {
            "contactMedium": [
              {
                "characteristic": {
                  "city": "CHULA VISTA",
                  "contactType": "billing",
                  "country": "USA",
                  "place": {
                    "id": "00000NGE5H"
                  },
                  "postCode": "91911-2310",
                  "stateOrProvince": "CA",
                  "street1": "952 HELIX AVE"
                },
                "mediumType": "postalAddress"
              }
            ],
            "contactType": "foo"
          }
        ],
        "createdOn": "2023-09-05T16:53:24.711Z",
        "currencyCode": "USD",
        "defaultPaymentMethod": {
          "cardNumber": "XXXXXXXXXXXX1111",
          "id": "RTB,XX,29f5ca56-b445-460f-bcb9-3f46b5428f93,PK0GTVGZC7R8K5KJZ",
          "paymentMethod": "DebitCard",
          "validFor": {
            "startDateTime": "2023-09-05T16:58:31.303Z"
          }
        },
        "financialAccount": {
          "id": "fin_552373266622"
        },
        "id": "552373266622",
        "lastModified": "2023-09-05T16:53:24.711Z",
        "name": "account",
        "ratingType": "postpaid",
        "relatedParty": [
          {
            "@referredType": "individual",
            "id": "29f5ca56-b445-460f-bcb9-3f46b5428f93",
            "role": "owner"
          },
          {
            "@referredType": "customer",
            "id": "01ed6caf-bf23-4403-9888-2bdbd035281d",
            "role": "customer"
          }
        ],
        "serviceType": [
          "fiber"
        ],
        "state": "defined",
        "stateDate": "2023-09-05T16:53:24.711Z",
        "stateReason": "defined"
      }
    ]
  },
  "accountSecurity": [
    {
      "billingAccount": {
        "id": "552373266622"
      },
      "userinfo": {
        "email_verified": false,
        "legalId": [
          {
            "identificationId": "HR.n",
            "identificationType": "passcode"
          },
          {
            "@type": "SecurityQuestion",
            "identificationId": "&blLT&x`TseEEi`",
            "identificationType": "Who is your favorite childhood hero?"
          }
        ],
        "phone_number_verified": false
      }
    }
  ],
  "addresses": [
    {
      "addressCharacteristic": [
        {
          "name": "addressLine1",
          "value": "952 HELIX AVE "
        },
        {
          "name": "cityAbbreviatedName",
          "value": "CHULA VISTA"
        },
        {
          "name": "addressMatchCode",
          "value": "4S80"
        },
        {
          "name": "addressMatchStatus",
          "value": "S80000"
        }
      ],
      "city": "CHULA VISTA",
      "country": "USA",
      "geographicSubAddress": [
        {
          "subAddressType": "FieldedGlid"
        }
      ],
      "id": "00000NGE5H",
      "postcode": "91911",
      "postcodeExtension": "2310",
      "stateOrProvince": "CA",
      "streetName": "HELIX",
      "streetNr": "952",
      "streetType": "AVE"
    }
  ],
  "appointment": [
    {
      "selected": {
        "@type": "realTime",
        "contactMedium": [
          {
            "characteristic": {
              "contactType": "home",
              "phoneNumber": "2134242223",
              "verified": true
            },
            "mediumType": "telephone",
            "preferred": true
          }
        ],
        "externalId": "W3248670051",
        "id": "4bd806f7-3f2c-42f2-a30d-96700b302220",
        "note": [
          {
            "text": ""
          }
        ],
        "relatedParty": [
          {
            "name": "Surendra Anand",
            "id": "foo",
            "role": "installationDayContact"
          }
        ],
        "validFor": {
          "endDateTime": "2023-09-07T10:00:00.000Z",
          "startDateTime": "2023-09-07T08:00:00.000Z"
        }
      }
    }
  ],
  "customerInfo": {
    "contactMedium": [
      {
        "characteristic": {
          "contactType": "other",
          "emailAddress": "sr1698@att.com",
          "verified": true
        },
        "mediumType": "email",
        "preferred": true
      },
      {
        "characteristic": {
          "contactType": "other",
          "phoneNumber": "2134242223",
          "verified": true
        },
        "mediumType": "telephone",
        "preferred": true
      },
      {
        "characteristic": {
          "city": "CHULA VISTA",
          "contactType": "service",
          "country": "USA",
          "place": {
            "id": "00000NGE5H"
          },
          "postCode": "91911-2310",
          "stateOrProvince": "CA",
          "street1": "952 HELIX AVE",
          "verified": false
        },
        "mediumType": "postalAddress"
      }
    ],
    "familyName": "Anand",
    "givenName": "Surendra",
    "id": "29f5ca56-b445-460f-bcb9-3f46b5428f93"
  },
  "payment": [
    {
      "@type": "tokenizedCard",
      "amount": {
        "unit": "USD",
        "value": 100
      },
      "details": {
        "brand": "VISA",
        "lastFourDigits": "XXXXXXXXXXXX1111",
        "name": "Jill"
      },
      "id": "RTB,XX,29f5ca56-b445-460f-bcb9-3f46b5428f93,PK0GTVGZC7R8K5KJZ",
      "role": "ADVPAY"
    },
    {
      "@type": "tokenizedCard",
      "details": {
        "brand": "VISA",
        "lastFourDigits": "XXXXXXXXXXXX1111",
        "name": "Jill"
      },
      "id": "RTB,XX,29f5ca56-b445-460f-bcb9-3f46b5428f93,PK0GTVGZC7R8K5KJZ",
      "role": "autopay"
    }
  ],
  "productOrder": {
    "@type": "ATTCart",
    "agreement": [
      {
        "extensions": [
          {
            "name": "TermsandConditionsAcceptance",
            "value": "Y"
          },
          {
            "name": "TermsandConditionsConsentText",
            "value": "Check here to acknowledge that the above has been read to the customer."
          },
          {
            "name": "ContentURL",
            "value": "/msapi/termsandconditions/termscontent/ReadAloud_NEW_CUSTOMER"
          },
          {
            "name": "TermsandConditionsContentCategory",
            "value": "ReadAloud"
          },
          {
            "name": "TermsandConditionsVersion",
            "value": "v1"
          },
          {
            "name": "TermsandConditionsAcceptanceDate",
            "value": "2023-09-05T16:58:27.176Z"
          },
          {
            "name": "TermsandConditionsKey",
            "value": "ReadAloud_NEW_CUSTOMER"
          }
        ],
        "name": "ReadAloud_NEW_CUSTOMER"
      },
      {
        "extensions": [
          {
            "name": "TermsandConditionsConsentText",
            "value": "Check here to acknowledge that the above has been read to the customer &amp; the customer agrees"
          },
          {
            "name": "TermsandConditionsAcceptance",
            "value": "Y"
          },
          {
            "name": "TermsandConditionsContentCategory",
            "value": "ReadAloud"
          },
          {
            "name": "TermsandConditionsVersion",
            "value": "v1"
          },
          {
            "name": "TermsandConditionsAcceptanceDate",
            "value": "2023-09-05T16:50:51.172Z"
          },
          {
            "name": "ContentURL",
            "value": "/msapi/termsandconditions/termscontent/ReadAloud_CREDT_DISCLOSR"
          },
          {
            "name": "TermsandConditionsKey",
            "value": "ReadAloud_CREDT_DISCLOSR"
          }
        ],
        "name": "ReadAloud_CREDT_DISCLOSR"
      },
      {
        "extensions": [
          {
            "name": "TermsandConditionsVersion",
            "value": "v14"
          },
          {
            "name": "TermsandConditionsAcceptance",
            "value": "Y"
          },
          {
            "name": "TermsandConditionsAcceptanceDate",
            "value": "2023-09-05T16:58:27.176Z"
          },
          {
            "name": "TermsandConditionsContentCategory",
            "value": "TnC"
          },
          {
            "name": "TermsandConditionsKey",
            "value": "CSA"
          },
          {
            "name": "ContentURL",
            "value": "/idpassets/archive-legal/fragment/legal/prod/lpc/terms/consumerServiceAgreement/v14/consumerServiceAgreement.cmsfeed.js"
          },
          {
            "name": "TermsandConditionsConsentText",
            "value": "I have read and agree to the AT&T Consumer Service Agreement (and the included provisions for binding individual arbitration rather than jury trials or class actions), under which service will auto-renew monthly until cancelled."
          }
        ],
        "name": "CSA"
      },
      {
        "extensions": [
          {
            "name": "TermsandConditionsConsentText",
            "value": "Check here to acknowledge that the above has been read to the customer &amp; the customer agrees"
          },
          {
            "name": "ContentURL",
            "value": "/msapi/termsandconditions/termscontent/ReadAloud_PREPAYMENT_DISCLOSR"
          },
          {
            "name": "TermsandConditionsAcceptance",
            "value": "Y"
          },
          {
            "name": "TermsandConditionsContentCategory",
            "value": "ReadAloud"
          },
          {
            "name": "TermsandConditionsVersion",
            "value": "v1"
          },
          {
            "name": "TermsandConditionsAcceptanceDate",
            "value": "2023-09-05T16:50:52.940Z"
          },
          {
            "name": "TermsandConditionsKey",
            "value": "ReadAloud_PREPAYMENT_DISCLOSR"
          }
        ],
        "name": "ReadAloud_PREPAYMENT_DISCLOSR"
      },
      {
        "name": "PAPERLESS_DISCLOSURE"
      },
      {
        "extensions": [
          {
            "name": "TermsandConditionsAcceptance",
            "value": "Y"
          },
          {
            "name": "TermsandConditionsContentCategory",
            "value": "ReadAloud"
          },
          {
            "name": "TermsandConditionsVersion",
            "value": "v1"
          },
          {
            "name": "TermsandConditionsAcceptanceDate",
            "value": "2023-09-05T16:58:27.176Z"
          },
          {
            "name": "TermsandConditionsKey",
            "value": "ReadAloud_PAPERLESS_BILLING"
          },
          {
            "name": "TermsandConditionsConsentText",
            "value": "Do you understand and agree to the terms as I have explained them?"
          },
          {
            "name": "ContentURL",
            "value": "/msapi/termsandconditions/termscontent/ReadAloud_PAPERLESS_BILLING"
          }
        ],
        "name": "ReadAloud_PAPERLESS_BILLING"
      },
      {
        "extensions": [
          {
            "name": "TermsandConditionsAcceptance",
            "value": "Y"
          },
          {
            "name": "TermsandConditionsConsentText",
            "value": "I have read and agree to the Consent to Electronic Delivery of Disclosures."
          },
          {
            "name": "ContentURL",
            "value": "/idpassets/archive-legal/fragment/legal/prod/lpc/terms/electronicCommunicationsConsent/v7/electronicCommunicationsConsent.cmsfeed.js"
          },
          {
            "name": "TermsandConditionsAcceptanceDate",
            "value": "2023-09-05T16:58:27.176Z"
          },
          {
            "name": "TermsandConditionsContentCategory",
            "value": "TnC"
          },
          {
            "name": "TermsandConditionsKey",
            "value": "ECONSENT"
          },
          {
            "name": "TermsandConditionsVersion",
            "value": "v7"
          }
        ],
        "name": "ECONSENT"
      },
      {
        "extensions": [
          {
            "name": "TermsandConditionsKey",
            "value": "ME"
          },
          {
            "name": "TermsandConditionsAcceptance",
            "value": "Y"
          },
          {
            "name": "TermsandConditionsAcceptanceDate",
            "value": "2023-09-05T16:58:27.176Z"
          },
          {
            "name": "TermsandConditionsContentCategory",
            "value": "TnC"
          },
          {
            "name": "TermsandConditionsVersion",
            "value": "OL_ME_20210824_T"
          },
          {
            "name": "ContentURL",
            "value": "/msapi/termsandconditions/v1/fetchTermsContent/attr_broadband_me"
          },
          {
            "name": "TermsandConditionsConsentText",
            "value": "I have read and agree to the Initial Payment, AutoPay, and Storage of Payment Method Authorization Terms and Conditions. I understand AutoPay will continue automatically until I cancel it at att.com/myatt."
          }
        ],
        "name": "ME"
      }
    ],
    "category": "BB_Offer",
    "channel": [
      {
        "extensions": [
          {
            "name": "agentId",
            "value": "mv0682"
          },
          {
            "name": "storeId",
            "value": ""
          },
          {
            "name": "Application",
            "value": "SF-SALES"
          }
        ],
        "id": "ATTR",
        "name": "ATTR"
      }
    ],
    "externalId": "24-693932461325360",
    "id": "e6ad4390-4c0b-11ee-949b-93df2b345100",
    "immediatePromotion": [
      {
        "id": "PROMOTION_2",
        "promotion": {
          "applyPolicy": "AUTOMATIC",
          "description": "Google Smart Home Accessory Bundle with Fiber",
          "id": "wrlnpr-57800445",
          "name": "Google Smart Home Accessory Bundle with Fiber",
          "type": "discount"
        }
      },
      {
        "id": "PROMOTION_3",
        "promotion": {
          "applyPolicy": "AUTOMATIC",
          "description": "Amazon Smart Home Accessory Bundle with Fiber",
          "id": "wrlnpr-59800660",
          "name": "Amazon Smart Home Accessory Bundle with Fiber",
          "type": "discount"
        }
      },
      {
        "id": "PROMOTION_4",
        "promotion": {
          "applyPolicy": "AUTOMATIC",
          "description": "AT&T ActiveArmor internet security included",
          "id": "wrlnpr-56700034",
          "name": "AT&T ActiveArmor internet security included",
          "type": "discount"
        }
      },
      {
        "id": "PROMOTION_5",
        "promotion": {
          "applyPolicy": "AUTOMATIC",
          "description": "Gaming offer 6 months free of NVIDIA GeForce NOW",
          "id": "wrlnpr-59900106",
          "name": "Gaming offer 6 months free of NVIDIA GeForce NOW",
          "type": "discount"
        }
      },
      {
        "id": "PROMOTION_6",
        "immediatePromotionCharacteristic": [
          {
            "name": "isAutopayAndEbillRequired",
            "value": [
              "true"
            ]
          }
        ],
        "promotion": {
          "applyPolicy": "AUTOMATIC",
          "description": "$5 off per month (price shown includes discount) when you sign up for both AutoPay &amp; paperless billing",
          "id": "wrlnpr-54400006",
          "name": "$5 off per month (price shown includes discount) when you sign up for both AutoPay &amp; paperless billing",
          "type": "discount"
        }
      },
      {
        "id": "PROMOTION_7",
        "promotion": {
          "applyPolicy": "AUTOMATIC",
          "description": "Installation fee waived",
          "id": "wrlnpr-33300220",
          "name": "Installation fee waived",
          "type": "discount"
        }
      }
    ],
    "lastUpdate": "2023-09-05T16:58:37.116Z",
    "orderDate": "2023-09-05T16:47:29.353Z",
    "orderExtensions": [
      {
        "name": "idpctx-session-id",
        "value": "a3CDP000000kbpg2AA"
      }
    ],
    "orderTotalPrice": [
      {
        "finalPrice": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 55
          }
        },
        "price": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 60
          }
        },
        "priceAlteration": [
          {
            "alterationType": "Promotion Price Alteration",
            "chargeType": "credit",
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 0
              },
              "priceReduction": {
                "unit": "USD",
                "value": 0
              }
            },
            "priceType": "RC"
          },
          {
            "alterationType": "Promotion Price Alteration",
            "chargeType": "credit",
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 0
              },
              "priceReduction": {
                "unit": "USD",
                "value": 0
              }
            },
            "priceType": "RC"
          },
          {
            "alterationType": "Promotion Price Alteration",
            "chargeType": "credit",
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 0
              },
              "priceReduction": {
                "unit": "USD",
                "value": 0
              }
            },
            "priceType": "RC"
          },
          {
            "alterationType": "Promotion Price Alteration",
            "chargeType": "credit",
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 0
              },
              "priceReduction": {
                "unit": "USD",
                "value": 0
              }
            },
            "priceType": "RC"
          },
          {
            "alterationType": "Promotion Price Alteration",
            "chargeType": "credit",
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 5
              },
              "priceReduction": {
                "unit": "USD",
                "value": 5
              }
            },
            "priceType": "RC"
          }
        ],
        "priceCategory": "serviceRC",
        "priceType": "RC",
        "recurringChargePeriod": "month",
        "role": "Price",
        "taxIncluded": "Excluded"
      },
      {
        "finalPrice": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 0
          }
        },
        "price": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 0
          }
        },
        "priceCategory": "Reward",
        "priceType": "OTR",
        "role": "Price",
        "taxIncluded": "Excluded"
      },
      {
        "finalPrice": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 0
          }
        },
        "price": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 99
          }
        },
        "priceAlteration": [
          {
            "alterationType": "Promotion Price Alteration",
            "chargeType": "credit",
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 99
              },
              "priceReduction": {
                "unit": "USD",
                "value": 99
              }
            },
            "priceType": "OC"
          }
        ],
        "priceCategory": "serviceOC",
        "priceType": "OC",
        "role": "Price",
        "taxIncluded": "Excluded"
      },
      {
        "finalPrice": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 100
          },
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 100
          }
        },
        "immediatePayOption": {
          "payImmediately": true,
          "payOption": "Mandatory"
        },
        "price": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 100
          },
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 100
          }
        },
        "priceType": "OC",
        "role": "ADVPAY"
      },
      {
        "finalPrice": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 100
          },
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 100
          }
        },
        "immediatePayOption": {
          "payImmediately": true,
          "payOption": "Mandatory"
        },
        "price": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 100
          },
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 100
          }
        },
        "priceType": "Immediate",
        "role": "ADVPAY"
      }
    ],
    "payment": [
      {
        "amount": {
          "unit": "USD",
          "value": 100
        },
        "characteristic": [
          {
            "name": "ownerType",
            "value": "Customer"
          }
        ],
        "id": "RTB,XX,29f5ca56-b445-460f-bcb9-3f46b5428f93,PK0GTVGZC7R8K5KJZ",
        "role": "ADVPAY"
      },
      {
        "account": [
          {
            "id": "552373266622"
          }
        ],
        "characteristic": [
          {
            "name": "ownerType",
            "value": "Customer"
          }
        ],
        "id": "RTB,XX,29f5ca56-b445-460f-bcb9-3f46b5428f93,PK0GTVGZC7R8K5KJZ",
        "role": "autopay"
      }
    ],
    "productOrderItem": [
      {
        "action": "add",
        "billingAccount": {
          "@type": "billingAccount",
          "id": "552373266622"
        },
        "id": "4e92f8a3-b9a9-4518-8a18-f61e2b4ff63e",
        "itemPrice": [
          {
            "finalPrice": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 100
              },
              "taxIncludedAmount": {
                "unit": "USD",
                "value": 100
              }
            },
            "id": "PO_CREDIT_POLICY_ADVPAY_1",
            "immediatePayOption": {
              "payImmediately": true,
              "payOption": "Mandatory"
            },
            "name": "ADVPAY price",
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 100
              },
              "taxIncludedAmount": {
                "unit": "USD",
                "value": 100
              }
            },
            "priceType": "OC",
            "role": "ADVPAY",
            "taxIncluded": "Included"
          }
        ],
        "itemTotalPrice": [
          {
            "finalPrice": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 55
              }
            },
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 60
              }
            },
            "priceAlteration": [
              {
                "alterationType": "Promotion Price Alteration",
                "chargeType": "credit",
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  },
                  "priceReduction": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "priceType": "RC"
              },
              {
                "alterationType": "Promotion Price Alteration",
                "chargeType": "credit",
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  },
                  "priceReduction": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "priceType": "RC"
              },
              {
                "alterationType": "Promotion Price Alteration",
                "chargeType": "credit",
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  },
                  "priceReduction": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "priceType": "RC"
              },
              {
                "alterationType": "Promotion Price Alteration",
                "chargeType": "credit",
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  },
                  "priceReduction": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "priceType": "RC"
              },
              {
                "alterationType": "Promotion Price Alteration",
                "chargeType": "credit",
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 5
                  },
                  "priceReduction": {
                    "unit": "USD",
                    "value": 5
                  }
                },
                "priceType": "RC"
              }
            ],
            "priceCategory": "serviceRC",
            "priceType": "RC",
            "recurringChargePeriod": "month",
            "role": "Price",
            "taxIncluded": "Excluded"
          },
          {
            "finalPrice": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 0
              }
            },
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 0
              }
            },
            "priceCategory": "Reward",
            "priceType": "OTR",
            "role": "Price",
            "taxIncluded": "Excluded"
          },
          {
            "finalPrice": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 0
              }
            },
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 99
              }
            },
            "priceAlteration": [
              {
                "alterationType": "Promotion Price Alteration",
                "chargeType": "credit",
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 99
                  },
                  "priceReduction": {
                    "unit": "USD",
                    "value": 99
                  }
                },
                "priceType": "OC"
              }
            ],
            "priceCategory": "serviceOC",
            "priceType": "OC",
            "role": "Price",
            "taxIncluded": "Excluded"
          },
          {
            "finalPrice": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 100
              },
              "taxIncludedAmount": {
                "unit": "USD",
                "value": 100
              }
            },
            "immediatePayOption": {
              "payImmediately": true,
              "payOption": "Mandatory"
            },
            "price": {
              "dutyFreeAmount": {
                "unit": "USD",
                "value": 100
              },
              "taxIncludedAmount": {
                "unit": "USD",
                "value": 100
              }
            },
            "priceType": "OC",
            "role": "ADVPAY"
          }
        ],
        "payment": [
          {
            "amount": {
              "unit": "USD",
              "value": 100
            },
            "characteristic": [
              {
                "name": "ownerType",
                "value": "Customer"
              }
            ],
            "id": "RTB,XX,29f5ca56-b445-460f-bcb9-3f46b5428f93,PK0GTVGZC7R8K5KJZ",
            "role": "ADVPAY"
          }
        ],
        "product": {
          "isBundle": true,
          "place": [
            {
              "id": "00000NGE5H",
              "name": "ServiceAddress",
              "role": "SA"
            }
          ],
          "productRelationship": [
            {
              "product": {
                "referenceId": "ibbndl_prod11920327_prod8580387_rwd-42900020_prod9040405_ref"
              },
              "relationshipType": "subscriptionRelation"
            }
          ],
          "referenceId": "ibbndl_prod11920327_prod8580387_rwd-42900020_prod9040405_ref"
        },
        "productOffering": {
          "id": "ibbndl_prod11920327_prod8580387_rwd-42900020_prod9040405",
          "name": "AT&T Internet 300",
          "productOfferingType": "BB_Offer"
        },
        "productOrderItem": [
          {
            "action": "add",
            "id": "b37c97e6-3986-454c-a9e8-a989ccabb3ce",
            "itemPrice": [
              {
                "finalPrice": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 55
                  }
                },
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 60
                  }
                },
                "priceAlteration": [
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "immediatePromotionId": "PROMOTION_2",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 0
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 0
                      }
                    },
                    "priceType": "RC"
                  },
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "immediatePromotionId": "PROMOTION_3",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 0
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 0
                      }
                    },
                    "priceType": "RC"
                  },
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "immediatePromotionId": "PROMOTION_4",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 0
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 0
                      }
                    },
                    "priceType": "RC"
                  },
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "immediatePromotionId": "PROMOTION_5",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 0
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 0
                      }
                    },
                    "priceType": "RC"
                  },
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "immediatePromotionId": "PROMOTION_6",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 5
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 5
                      }
                    },
                    "priceType": "RC"
                  }
                ],
                "priceCategory": "serviceRC",
                "priceType": "RC",
                "recurringChargePeriod": "month",
                "role": "Price",
                "taxIncluded": "Excluded"
              }
            ],
            "itemTotalPrice": [
              {
                "finalPrice": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 55
                  }
                },
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 60
                  }
                },
                "priceAlteration": [
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 0
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 0
                      }
                    },
                    "priceType": "RC"
                  },
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 0
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 0
                      }
                    },
                    "priceType": "RC"
                  },
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 0
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 0
                      }
                    },
                    "priceType": "RC"
                  },
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 0
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 0
                      }
                    },
                    "priceType": "RC"
                  },
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 5
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 5
                      }
                    },
                    "priceType": "RC"
                  }
                ],
                "priceCategory": "serviceRC",
                "priceType": "RC",
                "recurringChargePeriod": "month",
                "role": "Price",
                "taxIncluded": "Excluded"
              }
            ],
            "product": {
              "place": [
                {
                  "id": "00000NGE5H",
                  "name": "ServiceAddress",
                  "role": "SA"
                }
              ],
              "productCharacteristic": [
                {
                  "name": "Selected_Network_Type",
                  "value": "FTTP-GPON"
                },
                {
                  "name": "IgnorePricePlan",
                  "value": "false"
                },
                {
                  "name": "hboMaxIncluded",
                  "value": "false"
                }
              ],
              "productRelationship": [
                {
                  "product": {
                    "referenceId": "ibbndl_prod11920327_prod8580387_rwd-42900020_prod9040405_ref"
                  },
                  "relationshipType": "subscriptionRelation"
                }
              ],
              "referenceId": "prod11920327_ref"
            },
            "productOffering": {
              "id": "prod11920327",
              "name": "AT&T Internet 300",
              "productOfferingType": "BB_Plan"
            },
            "productOfferingQualificationItem": {
              "id": "f3b30d46-4813-4602-b69f-26a3cc17f2ac",
              "productOfferingQualificationId": "f3b30d46-4813-4602-b69f-26a3cc17f2ac"
            },
            "quantity": 1
          },
          {
            "action": "add",
            "id": "d51fd19b-9539-40ed-8e24-4d92a0da3a70",
            "itemPrice": [
              {
                "finalPrice": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "priceCategory": "serviceRC",
                "priceType": "RC",
                "recurringChargePeriod": "month",
                "role": "Price",
                "taxIncluded": "Excluded"
              }
            ],
            "itemTotalPrice": [
              {
                "finalPrice": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "priceCategory": "serviceRC",
                "priceType": "RC",
                "recurringChargePeriod": "month",
                "role": "Price",
                "taxIncluded": "Excluded"
              }
            ],
            "product": {
              "place": [
                {
                  "id": "00000NGE5H",
                  "name": "ServiceAddress",
                  "role": "SA"
                }
              ],
              "productCharacteristic": [
                {
                  "name": "IgnorePricePlan",
                  "value": "false"
                }
              ],
              "productRelationship": [
                {
                  "product": {
                    "referenceId": "ibbndl_prod11920327_prod8580387_rwd-42900020_prod9040405_ref"
                  },
                  "relationshipType": "subscriptionRelation"
                }
              ],
              "referenceId": "prod8580387_ref"
            },
            "productOffering": {
              "id": "prod8580387",
              "name": "Includes unlimited internet data",
              "productOfferingType": "BB_UsageAllowance"
            },
            "quantity": 1
          },
          {
            "action": "add",
            "id": "f623f53b-4f13-4efa-b8dd-eeb83aa29769",
            "itemPrice": [
              {
                "finalPrice": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "priceCategory": "Reward",
                "priceType": "OTR",
                "role": "Price",
                "taxIncluded": "Excluded"
              }
            ],
            "itemTotalPrice": [
              {
                "finalPrice": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "priceCategory": "Reward",
                "priceType": "OTR",
                "role": "Price",
                "taxIncluded": "Excluded"
              }
            ],
            "product": {
              "place": [
                {
                  "id": "00000NGE5H",
                  "name": "ServiceAddress",
                  "role": "SA"
                }
              ],
              "productRelationship": [
                {
                  "product": {
                    "referenceId": "ibbndl_prod11920327_prod8580387_rwd-42900020_prod9040405_ref"
                  },
                  "relationshipType": "subscriptionRelation"
                }
              ],
              "referenceId": "rwd-42900020_ref"
            },
            "productOffering": {
              "id": "rwd-42900020",
              "name": "&lt;b&gt;Great News! Your customer can choose between the Amazon or Google Accessory Bundle&lt;/b&gt;",
              "productOfferingType": "BB_Reward"
            },
            "quantity": 1
          },
          {
            "action": "add",
            "appointment": {
              "id": "4bd806f7-3f2c-42f2-a30d-96700b302220"
            },
            "id": "017c07a3-69d7-42f3-a8e1-046082cd7535",
            "itemPrice": [
              {
                "finalPrice": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 99
                  }
                },
                "priceAlteration": [
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "immediatePromotionId": "PROMOTION_7",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 99
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 99
                      }
                    },
                    "priceType": "OC"
                  }
                ],
                "priceCategory": "serviceOC",
                "priceType": "OC",
                "role": "Price",
                "taxIncluded": "Excluded"
              }
            ],
            "itemTotalPrice": [
              {
                "finalPrice": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 0
                  }
                },
                "price": {
                  "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 99
                  }
                },
                "priceAlteration": [
                  {
                    "alterationType": "Promotion Price Alteration",
                    "chargeType": "credit",
                    "price": {
                      "dutyFreeAmount": {
                        "unit": "USD",
                        "value": 99
                      },
                      "priceReduction": {
                        "unit": "USD",
                        "value": 99
                      }
                    },
                    "priceType": "OC"
                  }
                ],
                "priceCategory": "serviceOC",
                "priceType": "OC",
                "role": "Price",
                "taxIncluded": "Excluded"
              }
            ],
            "product": {
              "place": [
                {
                  "id": "00000NGE5H",
                  "name": "ServiceAddress",
                  "role": "SA"
                }
              ],
              "productCharacteristic": [
                {
                  "name": "Delivery_Method",
                  "value": "Indirect_Delivery_Shipping"
                },
                {
                  "name": "Delivery_Method",
                  "value": "Indirect_Delivery_Shipping"
                },
                {
                  "name": "Conflict_Type",
                  "value": "ATT_DIFFERENT_UVERSE_CUSTOMER"
                },
                {
                  "name": "Conflict_Validation_Message",
                  "value": "U-Verse or Non-AT&T services exist. If services are home phone &amp; DSL, customer will need to port their Non-AT&T home phone line to AT&T then disconnect DSL with current provider. If only DSL exists, customer will need to disconnect with current provider."
                },
                {
                  "name": "Conflict_Validation_Code",
                  "value": "SC1-0000"
                },
                {
                  "name": "Installation_Method",
                  "value": "Technician_Installation"
                },
                {
                  "name": "IgnorePricePlan",
                  "value": "true"
                }
              ],
              "productRelationship": [
                {
                  "product": {
                    "referenceId": "ibbndl_prod11920327_prod8580387_rwd-42900020_prod9040405_ref"
                  },
                  "relationshipType": "subscriptionRelation"
                }
              ],
              "referenceId": "prod9040405_ref"
            },
            "productOffering": {
              "id": "prod9040405",
              "name": "Internet Installation Fee",
              "productOfferingType": "BB_Installation"
            },
            "quantity": 1
          }
        ],
        "quantity": 1
      }
    ],
    "relatedParty": [
      {
        "@referredType": "individual",
        "extensions": [
          {
            "name": "unifiedPolicyTransactionId",
            "value": "P20230905000265245"
          },
          {
            "name": "creditApplicationId",
            "value": "309057229676"
          },
          {
            "name": "unifiedCreditTransactionId",
            "value": "U20230905306281580"
          }
        ],
        "id": "29f5ca56-b445-460f-bcb9-3f46b5428f93",
        "role": "owner"
      },
      {
        "id": "d87f0cb4-f377-27bf-e613-7b7de96c2370",
        "role": "profile"
      },
      {
        "@referredType": "customer",
        "extensions": [
          {
            "name": "CustomerType",
            "value": "Consumer"
          },
          {
            "name": "CustomerSubType",
            "value": "Individual"
          }
        ],
        "id": "01ed6caf-bf23-4403-9888-2bdbd035281d",
        "role": "customer"
      }
    ],
    "state": "inProgress",
    "validation": {
      "configuration": [
        {
          "postOrderConfigurable": true,
          "required": false,
          "status": "incomplete",
          "type": "DigitalID"
        },
        {
          "required": true,
          "status": "complete",
          "type": "CustomerProfile"
        },
        {
          "required": true,
          "status": "complete",
          "type": "BillingAccount"
        },
        {
          "properties": [
            {
              "name": "Readonly-LegalReadAloudKeys",
              "value": "ReadAloud_PREPAYMENT_DISCLOSR,ReadAloud_OUTSTANDINGDEBT_DISCLOSR"
            }
          ],
          "required": true,
          "status": "complete",
          "type": "CreditInfo"
        },
        {
          "required": true,
          "status": "complete",
          "type": "FulfillmentOptions"
        },
        {
          "postOrderConfigurable": true,
          "required": true,
          "status": "incomplete",
          "type": "Terms"
        },
        {
          "properties": [
            {
              "name": "Readonly-LegalReadAloudKeys",
              "value": "ReadAloud_PAPERLESS_BILLING"
            },
            {
              "name": "TermsAndConditionsKeys",
              "value": "AP,OA,ME,PAPERLESS_DISCLOSURE"
            },
            {
              "name": "autoPayEligiblePaymentTenders",
              "value": "ACH,CreditCard,DebitCard"
            }
          ],
          "required": true,
          "status": "complete",
          "subtype": "autopay",
          "type": "payment"
        },
        {
          "properties": [
            {
              "name": "TermsAndConditionsKeys",
              "value": "OP,OF"
            },
            {
              "name": "advPayEligiblePaymentTenders",
              "value": "CreditCard,DebitCard"
            }
          ],
          "required": true,
          "status": "complete",
          "subtype": "ADVPAY",
          "type": "payment"
        },
        {
          "required": false,
          "status": "complete",
          "subtype": "Prorated-RC",
          "type": "payment"
        },
        {
          "required": true,
          "status": "complete",
          "type": "Installation"
        },
        {
          "properties": [
            {
              "name": "Questions",
              "value": "Who is your favorite childhood hero?, What is your favorite restaurant?,Who is your favorite actor?,Who is your favorite singer?"
            }
          ],
          "required": true,
          "status": "complete",
          "type": "AccountSecurity"
        }
      ],
      "readyToCheckout": true,
      "readyToSubmit": true,
      "status": "complete"
    }
  }
}
AT&T DevEx

Omni APIs Central | Wireline Solutions | Shop New Fiber

Endpoint

This API will return productOrder along with details of various referred entities in productOrder. It is useful for rendering cart review page prior to order submit or for generating order confirmation page or an order receipt. cartId query parameter to be used prior to order submit.

http

Header Parameters

Query Parameters

Body Parameters

Responses

Body

REQUEST

RESPONSE
