Buy Port (v3) | Megaport

curl -X POST https://api.megaport.com/v3/networkdesign/buy \
     -H "Content-Type: application/json" \
     -d '[
  {
    "associatedVxcs": [
      {
        "aEnd": {
          "innerVlan": 0
        },
        "bEnd": {
          "partnerConfig": {
            "connectType": "AWSHC",
            "name": "Example VXC",
            "ownerAccount": "{{AWSAccount}}"
          },
          "productUid": "026b1463-a91d-48e6-97c9-3c259f260012"
        },
        "productName": "awshc",
        "rateLimit": 100
      }
    ],
    "productUid": "02ec2091-46bb-4904-bd17-96c752ff826e"
  }
]'

{
  "data": [
    {
      "attributeTags": {},
      "costCentre": {},
      "createDate": 1680242208512,
      "intercapPath": null,
      "nonPayerCompanyId": null,
      "payerCompanyId": null,
      "rateType": "MONTHLY",
      "salesId": null,
      "serviceName": "from greg T to Asia Pacific (Sydney) (ap-southeast-2) [DZ-BLUE]",
      "amazonDirectConnectConfigDto": {},
      "amsixConnectConfigDto": {},
      "asn": {},
      "awsId": {},
      "azureServiceKey": {},
      "bgpPassword": {},
      "connectType": "AWSHC",
      "dealUid": {},
      "discountMonths": {},
      "distanceBand": "METRO",
      "duration": 1,
      "fixedTerm": true,
      "fullyApproved": true,
      "monthlyDiscountAmount": {},
      "nonPayerApproval": 1680242208492,
      "nonPayerApproverId": 50402,
      "nonPayerApproverName": "Greg Brown",
      "nonPayerCompanyName": "AWS",
      "nonPayerConfig": {},
      "nonPayerInnerVlanId": {},
      "nonPayerLocationId": 6,
      "nonPayerMegaPortId": 132573,
      "nonPayerMegaPortName": "Asia Pacific (Sydney) (ap-southeast-2) [DZ-BLUE]",
      "nonPayerMegaPortNsId": 326800,
      "nonPayerStatus": "APPROVED",
      "nonPayerVlanId": 0,
      "oracleVirtualCircuitId": {},
      "orderType": "NEW",
      "originDomain": {},
      "payerApproval": 1680242208455,
      "payerApproverId": 50402,
      "payerApproverName": "Greg Brown",
      "payerCompanyName": "Megaport Lab",
      "payerConfig": {},
      "payerInnerVlanId": 0,
      "payerLocationId": 2,
      "payerMegaPortId": 155354,
      "payerMegaPortName": "greg T",
      "payerMegaPortNsId": 397416,
      "payerStatus": "APPROVED",
      "payerVlanId": 0,
      "promoCode": {},
      "provisionDate": 1680242208440,
      "rate": {},
      "rollover": true,
      "sdrcProvItem": {},
      "serviceKey": {},
      "serviceLicense": {},
      "setup": {},
      "speed": 100,
      "usageAlgorithm": "POST_PAID_HOURLY_SPEED_METRO_VXC",
      "vxc": {
        "aLocation": null,
        "aLocationId": null,
        "accountManager": null,
        "adminContactId": null,
        "adminContactName": null,
        "adminLocked": false,
        "attributeTags": {},
        "attributes": [],
        "bLocation": null,
        "bLocationId": null,
        "bgpShutdownDefault": false,
        "billableId": 147636,
        "billableUsageAlgorithm": null,
        "billingContactId": null,
        "billingContactName": null,
        "buyoutPort": null,
        "companyId": 1153,
        "companyName": "Megaport Lab",
        "components": [],
        "configuredDate": null,
        "contractStartDate": null,
        "contractTermMonths": 1,
        "createDate": 1680242208482,
        "createdBy": "f39b8983-256e-4643-adec-9f0b5da09ab7",
        "currentEstimatedDelivery": null,
        "errorMessage": null,
        "failedReason": null,
        "inAdvanceBillingStatus": null,
        "intercapPath": "",
        "locked": false,
        "market": "Australia",
        "marketplaceVisibility": true,
        "maximumSpeed": null,
        "minimumSpeed": null,
        "name": "awshc",
        "nonPayerCompanyId": null,
        "originDomain": null,
        "payerCompanyId": null,
        "productType": "VXC",
        "promptUid": null,
        "provisioningItems": [],
        "provisioningStatus": "DEPLOYABLE",
        "rateLimit": 100,
        "rateType": "MONTHLY",
        "requestedDate": 1680242208440,
        "salesId": null,
        "salesName": null,
        "secondaryName": null,
        "serviceName": "awshc",
        "tags": [],
        "technicalContactId": null,
        "technicalContactName": null,
        "technicalServiceId": 155731,
        "technicalServiceUid": "5a4d1803-3796-4144-ac35-c582d2f60b6f",
        "terminationDate": null,
        "trialAgreement": false,
        "virtual": false,
        "vxcAutoApproval": false,
        "vxcDistanceBand": "METRO",
        "vxcPermitted": true
      },
      "vxcJTechnicalServiceId": 155731,
      "vxcJTechnicalServiceUid": "5a4d1803-3796-4144-ac35-c582d2f60b6f",
      "vxcOrderId": 114013,
      "webAirProvItem": {}
    }
  ],
  "message": "VXC [5a4d1803-3796-4144-ac35-c582d2f60b6f] created.",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Orders the Port and sends the information to the provisioning system for processing. This request commits the order.

promoCode is an optional string that can be used to enter a promotional code for the service order. The code is not validated, so if the code doesnâ€™t exist or doesnâ€™t work for the service, the call will still be successful.

Request

This endpoint expects a list of objects.

costCentrestringOptional

createDatedoubleOptional

diversityZonestringOptional

locationIddoubleOptional

locationUidany or nullOptional

marketstringOptional

portSpeeddoubleOptional

productNamestringOptional

productTypestringOptional

termdoubleOptional

virtualbooleanOptional

Response

Buy Port (v3) / Buy Port (v3) / Buy a LAG (v3) / Buy a LAG (v3) / Buy Ports in an Existing LAG (v3) / Buy Ports in an Existing LAG (v3) / Buy VXC (v3) / Buy VXC (v3) - 12 Month Contract / Buy VXC (v3) / Buy VXC (v3) - 12 Month Contract / Create VXC to SAP (v3) / Create VXC to SAP (v3) / Buy Megaport Internet (v3) / Buy Megaport Internet (v3) / Create VXC to 3DS Outscale (v3) / Create VXC to 3DS Outscale (v3) / Buy Alibaba Connection (v3) / Buy Alibaba Connection (v3) / Buy AWS - Hosted VIF (v3) / Buy AWS - Hosted VIF (v3) / Buy AWS - Hosted Connection (v3) / Buy AWS - Hosted Connection (v3) / Create VXC to Azure (v3) / Create VXC to Azure (v3) / Create VXC to Google Cloud (v3) / Create VXC to Google Cloud (v3) / Create VXC to IBM (v3) / Create VXC to IBM (v3) / Create VXC to Oracle (v3) / Buy Port With VXC to Oracle (v3) / Buy Port With VXC to Oracle (v3) / Create VXC to Oracle (v3) / Create VXC to Salesforce (v3) / Create VXC to Salesforce (v3) / Create VXC to SAP (v3) / Create VXC to SAP (v3) / Buy AWS - Hosted VIF (v3) / Buy AWS - Hosted VIF (v3) / Create VXC to Azure (v3) / Create VXC to Azure (v3) / Create VXC to Google Cloud (v3) / Create VXC to Google Cloud (v3) / Buy AWS - Hosted VIF (v3) / Buy AWS - Hosted VIF (v3) / Buy AWS - Hosted Connection (v3) / Buy AWS - Hosted Connection (v3) / Create VXC to Azure (v3) / Create VXC to Azure (v3) / Create VXC to Google Cloud (v3) / Create VXC to Google Cloud (v3) / Buy MCR (v3) / Buy MCR (v3) / Buy VXC for MCR (v3) / Buy VXC for MCR (v3) / Buy MVE - 6WIND VSR (v3) / Buy MVE - 6WIND VSR (v3) / Buy MVE - Aruba SD-WAN (v3) / Buy MVE - vNIC example (v3) / Buy MVE - vNIC example (v3) / Buy MVE - Aruba SD-WAN (v3) / Buy MVE - Aviatrix Secure Edge 2/8 (v3) / Buy MVE - Aviatrix Secure Edge 8/32 (v3) / Buy MVE - Aviatrix Secure Edge 2/8 (v3) / Buy MVE - Aviatrix Secure Edge 8/32 (v3) / Buy MVE - Cisco SD-WAN / Buy MVE - Cisco with vNICs (v3) / Buy MVE - Cisco with vNICs (v3) / Buy MVE - Cisco SD-WAN / Buy MVE - Cisco Secure Firewall Threat Defense Virtual (v3) / Buy MVE - Cisco Secure Firewall Threat Defense Virtual (v3) / Buy MVE - Fortinet Secure SD-WAN (v3) / Buy MVE - Fortinet Secure SD-WAN with vNICs (v3) / Buy MVE - Fortinet Secure SD-WAN (v3) / Buy MVE - Fortinet Secure SD-WAN with vNICs (v3) / Buy MVE - Palo Alto Prisma SD-WAN 3104v (v3) / Buy MVE - Palo Alto Prisma SD-WAN 3108v (v3) / Buy MVE - Palo Alto Prisma SD-WAN 7108v (v3) / Buy MVE - Palo Alto Prisma SD-WAN 3104v (v3) / Buy MVE - Palo Alto Prisma SD-WAN 7108v (v3) / Buy MVE - Palo Alto Prisma SD-WAN 3108v (v3) / Buy MVE - Palo Alto VM-Series NGFW (v3) / Buy MVE - Buy MVE - Palo Alto VM-Series NGFW with vNICs (v3) / Buy MVE - Palo Alto VM-Series NGFW (v3) / Buy MVE - Buy MVE - Palo Alto VM-Series NGFW with vNICs (v3) / Buy MVE - Peplink FusionHub (v3) / Buy MVE - Peplink FusionHub (v3) - With Resource Tags / Buy MVE - Peplink FusionHub (v3) - With Resource Tags / Buy MVE - Peplink FusionHub (v3) / Buy MVE - Versa SD-WAN (v3) / Buy MVE - Versa SD-WAN with vNICs (v3) / Buy MVE - Versa SD-WAN with vNICs (v3) / Buy MVE - Versa SD-WAN (v3) / Buy MVE - VMware SD-WAN (v3) / Buy MVE - VMware SD-WAN (v3) / Buy Megaport Internet (v3) / Buy Megaport Internet with vNICs (v3) / Buy Megaport Internet with vNICs (v3) / Buy Megaport Internet (v3) / Buy Palo Alto Megaport Internet (v3) / Buy Palo Alto Megaport Internet (v3) / Buy VXC for MVE (v3) / Buy VXC for MVE (v3) / Buy IX (v3) / Buy IX (v3) / Buy Port for Managed Account (v3) / Buy Port for Managed Account (v3)

datalist of objectsOptional

messagestringOptional

termsstringOptional

Headers

Request

Response