Care Order

Version 1.0.0
download iconDownload spec

Endpoint

POST
https://serverRoot/api/orderingMobility/v1/careOrder

Care order requests are initiated by a client system and sent to AT&T. This transaction is used to update subscriber information such as features, devices, and rate plans.

arrowRequest

Header Parameters

            Body Parameters

            Responses

            Accepted

            arrowBody

            application/json

            REQUEST

            1
            2
            3
            4
            5
            6
            7
            8
            9
            10
            11
            12
            13
            14
            15
            16
            17
            18
            19
            20
            21
            22
            23
            24
            25
            26
            27
            28
            29
            30
            31
            32
            33
            34
            35
            36
            37
            38
            39
            40
            41
            42
            43
            44
            45
            46
            47
            48
            49
            50
            51
            52
            53
            54
            55
            56
            57
            58
            59
            60
            61
            62
            63
            64
            65
            66
            67
            68
            69
            70
            71
            72
            73
            74
            75
            76
            77
            78
            79
            80
            81
            82
            83
            84
            85
            86
            87
            88
            89
            90
            91
            92
            93
            94
            95
            96
            97
            98
            99
            100
            101
            curl --request POST \
                 --url https://serverroot/api/orderingMobility/v1/careOrder \
                 --header 'Accept: string' \
                 --header 'Content-Length: integer' \
                 --header 'X-ATT-ClientId: string' \
                 --header 'X-ATT-ConversationId: string' \
                 --header 'X-ATT-MessageId: string' \
                 --header 'content-type: application/json' \
                 --data '
            {
              "careOrderRequest": {
                "foundationAccountNumber": "81730304",
                "accountGroupId": "73001012763",
                "poNumber": "202405040001",
                "consentToRecurringCharges": true,
                "orderContact": {
                  "contact": {
                    "lastName": "Bell",
                    "firstName": "Alex"
                  },
                  "phone": {
                    "number": "1234567890",
                    "extension": "1885"
                  },
                  "email": "alexbell@att.com"
                },
                "changeRequest": [
                  {
                    "type": "updateSubscriber",
                    "changeRequestId": "ChangeID1",
                    "effectiveDate": "nextBillingCycle",
                    "ctn": "1234567890",
                    "items": [
                      {
                        "id": "sku12037300017",
                        "action": "add",
                        "effectiveDate": "2022-02-15T19:00:00.000-05:00",
                        "expirationDate": "2023-02-15T19:00:00.000-05:00"
                      }
                    ],
                    "udl": [
                      {
                        "type": "User Name",
                        "value": "Laura Madison"
                      }
                    ],
                    "suspendServiceReason": "Lost",
                    "resumeServiceReason": "CustomerRequest",
                    "cancellationReason": "CorporateCustomerCancel",
                    "cancelServiceReason": "EmployeeLeftCompany",
                    "cancelEffectiveDate": "immediate",
                    "replaceDuplicateFeatures": true,
                    "replaceConflictingFeatures": true,
                    "resetVoiceMail": {
                      "pin": "1234",
                      "autogeneratedPin": true
                    },
                    "billingContact": {
                      "contactName": {
                        "lastName": "Bell",
                        "firstName": "Alex"
                      },
                      "attentionTo": "Jay Watson",
                      "address": {
                        "addressLine1": "123 Main St",
                        "addressLine2": "Suite 400",
                        "city": "Dallas",
                        "state": "TX",
                        "zipCode": "75201"
                      },
                      "addressIndicator": false,
                      "phone": {
                        "number": "1234567890"
                      }
                    },
                    "subscriberContact": {
                      "name": {
                        "lastName": "Bell",
                        "firstName": "Alex"
                      },
                      "address": {
                        "addressLine1": "123 Main St",
                        "addressLine2": "Suite 400",
                        "city": "Dallas",
                        "state": "TX",
                        "zipCode": "75201"
                      },
                      "phone": {
                        "number": "1234567890"
                      }
                    },
                    "device": {
                      "imei": "359194077165207",
                      "iccid": "89014704272630325832",
                      "networkBlock": "True"
                    }
                  }
                ]
              }
            }
            '