Skip to navigation
API Reference

Ordering Services

View as Markdown

Megaport uses a two-step process to set up services:

  • you validate and price the configuration with the /v3/networkdesign/validate endpoint
  • you order the service with the /v3/networkdesign/buy endpoint

The validate and buy endpoints use a customized Body to define the configuration.

You can copy the Body definition from the validate request to the buy request to ensure the configuration stays the same.

You can combine several service orders into one API call.

Different Megaport endpoints are on different versions, for example, v2 or v3. Therefore, make sure that you are calling and integrating with the correct versions. You should use the v3 endpoints for the validation, ordering, and updating (VXCs only) of network services. Specifically, this relates to these endpoints:

  • Validate and order of all service types
    • POST v3/networkdesign/validate
    • POST v3/networkdesign/buy
  • Fetch prices of MVE and VXC
    • GET v3/pricebook/mve?locationId={locationId}&vendor={vendor}&size={size}
    • GET v3/pricebook/vxc?bLocationId={bLocationId}&aLocationId={aLocationId}&connectType=TRANSIT
  • Update VXCs
    • PUT v3/product/vxc/{productUid}