att/openapi/att-product-ordering-api-openapi.yml at master · api-evangelist/att · GitHub

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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
openapi: 3.2.0
info:
  title: AT&T Enterprise Connectivity Product Ordering API
  description: Enterprise-grade APIs for AT&T wireline business services including service qualification, quoting, ordering, and provisioning. The Alliance API suite supports automated ordering of AVPN, IPBB, ATTPhone, ASE, and AT&T Internet Air for Business services.
  version: 1.0.0
  contact:
    name: AT&T Alliance Developer Portal
    url: https://devex-web.att.com/alliance
  termsOfService: https://www.att.com/gen/general?pid=11561
servers:
- url: https://devex-web.att.com
  description: AT&T Enterprise API Server
security:
- oauth2: []
tags:
- name: Product Ordering
  description: Place and manage service orders
paths:
  /alliance/productOrder/v1:
    post:
      operationId: createProductOrder
      summary: Create AT&T Enterprise Product Order
      description: Submit a product order for AT&T wireline business services including AVPN, IPBB, ATTPhone, ASE, or Internet Air for Business.
      tags:
      - Product Ordering
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductOrderRequest'
            examples:
              avpnOrder:
                summary: AVPN Service Order
                value:
                  externalId: ext_order_001
                  description: AVPN service order for Dallas HQ
                  requestedStartDate: '2026-05-01'
                  orderItem:
                  - id: item_001
                    action: add
                    productOffering:
                      name: AVPN
      responses:
        '201':
          description: Product order created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductOrder'
              examples:
                created:
                  summary: Order Created
                  value:
                    id: ord_xyz789
                    externalId: ext_order_001
                    state: acknowledged
                    orderDate: '2026-04-19T10:00:00Z'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ProductOrderRequest:
      type: object
      required:
      - orderItem
      properties:
        externalId:
          type: string
          description: Customer-provided external order reference
        description:
          type: string
          description: Order description
        requestedStartDate:
          type: string
          format: date
          description: Requested service start date
        orderItem:
          type: array
          items:
            $ref: '#/components/schemas/OrderItem'
    ProductOrder:
      type: object
      properties:
        id:
          type: string
          description: AT&T order identifier
        externalId:
          type: string
          description: Customer external reference
        state:
          type: string
          enum:
          - acknowledged
          - inProgress
          - pending
          - held
          - assessingCancellation
          - pendingCancellation
          - cancelled
          - completed
          - failed
          - partial
          description: Current order state
        orderDate:
          type: string
          format: date-time
          description: Order submission timestamp
        completionDate:
          type:
          - string
          - 'null'
          format: date-time
          description: Order completion timestamp
    OrderItem:
      type: object
      required:
      - id
      - action
      - productOffering
      properties:
        id:
          type: string
          description: Order item identifier
        action:
          type: string
          enum:
          - add
          - modify
          - delete
          - noChange
          description: Order action type
        productOffering:
          type: object
          properties:
            name:
              type: string
              description: Product offering name
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
        reason:
          type: string
          description: Error reason
        message:
          type: string
          description: Detailed error message
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://devex-web.att.com/oauth/token
          scopes:
            enterprise: Access AT&T enterprise connectivity APIs