AT&T · Schema

ProductOrder

ProductOrder schema from AT&T API

Fortune 100TelecommunicationsWirelessWirelineMessagingSpeechMobileBroadbandEnterprise

Properties

Name Type Description
id string Unique product order identifier
href string
state string Order state
externalId string External order identifier
View JSON Schema on GitHub

JSON Schema

mvnx-api-product-order-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/at-and-t/refs/heads/main/json-schema/mvnx-api-product-order-schema.json",
  "title": "ProductOrder",
  "description": "ProductOrder schema from AT&T API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique product order identifier",
      "example": "order-500123"
    },
    "href": {
      "type": "string",
      "format": "uri",
      "example": "https://devex-web.att.com/productOrder/order-500123"
    },
    "state": {
      "type": "string",
      "description": "Order state",
      "enum": [
        "inProgress",
        "completed",
        "cancelled",
        "failed"
      ],
      "example": "inProgress"
    },
    "externalId": {
      "type": "string",
      "description": "External order identifier",
      "example": "ext-order-500123"
    }
  }
}