# BorderguruApi.OrdersApi

All URIs are relative to *http://localhost:9090*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createOrder**](OrdersApi.md#createOrder) | **POST** /orders | Creates a new order in the database
[**deleteOrder**](OrdersApi.md#deleteOrder) | **DELETE** /orders/{orderId} | Deletes an order by id
[**getOrderById**](OrdersApi.md#getOrderById) | **GET** /orders/{orderId} | Returns an order by id
[**listOrders**](OrdersApi.md#listOrders) | **GET** /orders | Lists all orders


<a name="createOrder"></a>
# **createOrder**
> Order createOrder(order)

Creates a new order in the database

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.OrdersApi();

var order = new BorderguruApi.CreateOrderBody(); // CreateOrderBody | Order data


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createOrder(order, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **order** | [**CreateOrderBody**](CreateOrderBody.md)| Order data | 

### Return type

[**Order**](Order.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="deleteOrder"></a>
# **deleteOrder**
> deleteOrder(orderId)

Deletes an order by id

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.OrdersApi();

var orderId = "orderId_example"; // String | Unique Id for an order


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteOrder(orderId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **orderId** | **String**| Unique Id for an order | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: 

<a name="getOrderById"></a>
# **getOrderById**
> Order getOrderById(orderId)

Returns an order by id

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.OrdersApi();

var orderId = "orderId_example"; // String | Unique Id for an order


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **orderId** | **String**| Unique Id for an order | 

### Return type

[**Order**](Order.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="listOrders"></a>
# **listOrders**
> [Order] listOrders(opts)

Lists all orders

### Example
```javascript
var BorderguruApi = require('borderguru_api');

var apiInstance = new BorderguruApi.OrdersApi();

var opts = { 
  'companyId': "companyId_example", // String | Unique id for a company for filtering
  'deliveryAddress': "deliveryAddress_example" // String | Full or partial delivery address of an order for filtering
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.listOrders(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **companyId** | **String**| Unique id for a company for filtering | [optional] 
 **deliveryAddress** | **String**| Full or partial delivery address of an order for filtering | [optional] 

### Return type

[**[Order]**](Order.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json