BMW Online Orders - OpenAPI 3.0

Order

getVehiclesByCondition

Finds vehicles by condition

Retrieves multiple vehicles by condition

/order/{orderByCondition}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"https://bmw.com/api/v3/order/{orderByCondition}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrderApi;

import java.io.File;
import java.util.*;

public class OrderApiExample {

    public static void main(String[] args) {
        
        OrderApi apiInstance = new OrderApi();
        String orderByCondition = orderByCondition_example; // String | Vehicles of condition to return
        try {
            Order result = apiInstance.getVehiclesByCondition(orderByCondition);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#getVehiclesByCondition");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.OrderApi;

public class OrderApiExample {

    public static void main(String[] args) {
        OrderApi apiInstance = new OrderApi();
        String orderByCondition = orderByCondition_example; // String | Vehicles of condition to return
        try {
            Order result = apiInstance.getVehiclesByCondition(orderByCondition);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#getVehiclesByCondition");
            e.printStackTrace();
        }
    }
}

String *orderByCondition = orderByCondition_example; // Vehicles of condition to return

OrderApi *apiInstance = [[OrderApi alloc] init];

// Finds vehicles by condition
[apiInstance getVehiclesByConditionWith:orderByCondition
              completionHandler: ^(Order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var BmwOnlineOrdersOpenApi30 = require('bmw_online_orders___open_api_30');

var api = new BmwOnlineOrdersOpenApi30.OrderApi()
var orderByCondition = orderByCondition_example; // {{String}} Vehicles of condition to return

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVehiclesByCondition(orderByCondition, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVehiclesByConditionExample
    {
        public void main()
        {

            var apiInstance = new OrderApi();
            var orderByCondition = orderByCondition_example;  // String | Vehicles of condition to return

            try
            {
                // Finds vehicles by condition
                Order result = apiInstance.getVehiclesByCondition(orderByCondition);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrderApi.getVehiclesByCondition: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiOrderApi();
$orderByCondition = orderByCondition_example; // String | Vehicles of condition to return

try {
    $result = $api_instance->getVehiclesByCondition($orderByCondition);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->getVehiclesByCondition: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrderApi;

my $api_instance = WWW::SwaggerClient::OrderApi->new();
my $orderByCondition = orderByCondition_example; # String | Vehicles of condition to return

eval { 
    my $result = $api_instance->getVehiclesByCondition(orderByCondition => $orderByCondition);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderApi->getVehiclesByCondition: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.OrderApi()
orderByCondition = orderByCondition_example # String | Vehicles of condition to return

try: 
    # Finds vehicles by condition
    api_response = api_instance.find_vehicles_by_condition(orderByCondition)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderApi->getVehiclesByCondition: %s\n" % e)

Parameters

Path parameters

Name	Description
orderByCondition*	String Vehicles of condition to return Required

Responses

Status: 200 - Successful operation

Schema

Status: 400 - Invalid condition

getOrderById

Finds vehicle by order ID

Returns a vehicle order by ID

/order/{orderId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"https://bmw.com/api/v3/order/{orderId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrderApi;

import java.io.File;
import java.util.*;

public class OrderApiExample {

    public static void main(String[] args) {
        
        OrderApi apiInstance = new OrderApi();
        Long orderId = 789; // Long | ID of vehicle order to return
        try {
            Order result = apiInstance.getOrderById(orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#getOrderById");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.OrderApi;

public class OrderApiExample {

    public static void main(String[] args) {
        OrderApi apiInstance = new OrderApi();
        Long orderId = 789; // Long | ID of vehicle order to return
        try {
            Order result = apiInstance.getOrderById(orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#getOrderById");
            e.printStackTrace();
        }
    }
}

Long *orderId = 789; // ID of vehicle order to return

OrderApi *apiInstance = [[OrderApi alloc] init];

// Finds vehicle by order ID
[apiInstance getOrderByIdWith:orderId
              completionHandler: ^(Order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var BmwOnlineOrdersOpenApi30 = require('bmw_online_orders___open_api_30');

var api = new BmwOnlineOrdersOpenApi30.OrderApi()
var orderId = 789; // {{Long}} ID of vehicle order to return

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrderById(orderId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrderByIdExample
    {
        public void main()
        {

            var apiInstance = new OrderApi();
            var orderId = 789;  // Long | ID of vehicle order to return

            try
            {
                // Finds vehicle by order ID
                Order result = apiInstance.getOrderById(orderId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrderApi.getOrderById: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiOrderApi();
$orderId = 789; // Long | ID of vehicle order to return

try {
    $result = $api_instance->getOrderById($orderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->getOrderById: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrderApi;

my $api_instance = WWW::SwaggerClient::OrderApi->new();
my $orderId = 789; # Long | ID of vehicle order to return

eval { 
    my $result = $api_instance->getOrderById(orderId => $orderId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderApi->getOrderById: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.OrderApi()
orderId = 789 # Long | ID of vehicle order to return

try: 
    # Finds vehicle by order ID
    api_response = api_instance.get_order_by_id(orderId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderApi->getOrderById: %s\n" % e)

Parameters

Path parameters

Name	Description
orderId*	Long (int64) ID of vehicle order to return Required

Responses

Status: 200 - Successful operation

Schema

Status: 400 - Invalid vehicle order ID

newOrder

Create a vehicle order

Create a new vehicle order

/order

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"https://bmw.com/api/v3/order"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrderApi;

import java.io.File;
import java.util.*;

public class OrderApiExample {

    public static void main(String[] args) {
        
        OrderApi apiInstance = new OrderApi();
        Order body = ; // Order | Vehicle order that needs to be created
        try {
            Order result = apiInstance.newOrder(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#newOrder");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.OrderApi;

public class OrderApiExample {

    public static void main(String[] args) {
        OrderApi apiInstance = new OrderApi();
        Order body = ; // Order | Vehicle order that needs to be created
        try {
            Order result = apiInstance.newOrder(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#newOrder");
            e.printStackTrace();
        }
    }
}

Order *body = ; // Vehicle order that needs to be created

OrderApi *apiInstance = [[OrderApi alloc] init];

// Create a vehicle order
[apiInstance newOrderWith:body
              completionHandler: ^(Order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var BmwOnlineOrdersOpenApi30 = require('bmw_online_orders___open_api_30');

var api = new BmwOnlineOrdersOpenApi30.OrderApi()
var body = ; // {{Order}} Vehicle order that needs to be created

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.newOrder(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class newOrderExample
    {
        public void main()
        {

            var apiInstance = new OrderApi();
            var body = new Order(); // Order | Vehicle order that needs to be created

            try
            {
                // Create a vehicle order
                Order result = apiInstance.newOrder(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrderApi.newOrder: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiOrderApi();
$body = ; // Order | Vehicle order that needs to be created

try {
    $result = $api_instance->newOrder($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->newOrder: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrderApi;

my $api_instance = WWW::SwaggerClient::OrderApi->new();
my $body = WWW::SwaggerClient::Object::Order->new(); # Order | Vehicle order that needs to be created

eval { 
    my $result = $api_instance->newOrder(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderApi->newOrder: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.OrderApi()
body =  # Order | Vehicle order that needs to be created

try: 
    # Create a vehicle order
    api_response = api_instance.new_order(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderApi->newOrder: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - Successful operation

Schema

Status: 405 - Invalid input

updateOrder

Update an existing vehicle order

/order

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"https://bmw.com/api/v3/order"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrderApi;

import java.io.File;
import java.util.*;

public class OrderApiExample {

    public static void main(String[] args) {
        
        OrderApi apiInstance = new OrderApi();
        Order body = ; // Order | Update an existing vehicle order
        try {
            Order result = apiInstance.updateOrder(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#updateOrder");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.OrderApi;

public class OrderApiExample {

    public static void main(String[] args) {
        OrderApi apiInstance = new OrderApi();
        Order body = ; // Order | Update an existing vehicle order
        try {
            Order result = apiInstance.updateOrder(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrderApi#updateOrder");
            e.printStackTrace();
        }
    }
}

Order *body = ; // Update an existing vehicle order

OrderApi *apiInstance = [[OrderApi alloc] init];

// Update an existing vehicle order
[apiInstance updateOrderWith:body
              completionHandler: ^(Order output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var BmwOnlineOrdersOpenApi30 = require('bmw_online_orders___open_api_30');

var api = new BmwOnlineOrdersOpenApi30.OrderApi()
var body = ; // {{Order}} Update an existing vehicle order

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateOrder(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateOrderExample
    {
        public void main()
        {

            var apiInstance = new OrderApi();
            var body = new Order(); // Order | Update an existing vehicle order

            try
            {
                // Update an existing vehicle order
                Order result = apiInstance.updateOrder(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrderApi.updateOrder: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiOrderApi();
$body = ; // Order | Update an existing vehicle order

try {
    $result = $api_instance->updateOrder($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->updateOrder: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrderApi;

my $api_instance = WWW::SwaggerClient::OrderApi->new();
my $body = WWW::SwaggerClient::Object::Order->new(); # Order | Update an existing vehicle order

eval { 
    my $result = $api_instance->updateOrder(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrderApi->updateOrder: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.OrderApi()
body =  # Order | Update an existing vehicle order

try: 
    # Update an existing vehicle order
    api_response = api_instance.update_order(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrderApi->updateOrder: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

BMW Online Orders - OpenAPI 3.0

API and SDK Documentation

Order

getVehiclesByCondition

Usage and SDK Samples

Parameters

Responses

Status: 200 - Successful operation

Status: 400 - Invalid condition

getOrderById

Usage and SDK Samples

Parameters

Responses

Status: 200 - Successful operation

Status: 400 - Invalid vehicle order ID

newOrder

Usage and SDK Samples

Parameters

Responses

Status: 200 - Successful operation

Status: 405 - Invalid input

updateOrder

Usage and SDK Samples

Parameters

Responses

Status: 200 - Successful operation

Status: 400 - Invalid ID

Status: 404 - Record not found

Status: 405 - Validation exception