Order Products and Licenses

All PUT endpoints update only the fields present in the body; see Updating Resources.

GET`/v1/orders/{orderId}/products`GET /v1/orders/{orderId}/products

Code samples

cURL


# You can also use wget
curl -X GET /v1/orders/{orderId}/products \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}/products',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/orders/{orderId}/products";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/orders/\{orderId\}/products

Gets the products for a specific order.

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none
include	query	string	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","orderProducts":[{"productId":0,"orderId":0,"quantity":0,"unitPrice":0.1,"discount":0.1,"taxes":0.1,"description":"string","product":{"id":0,"code":"string","name":"string","description":"string","url":"string","copyright":"string","createdAt":"2019-08-24T14:15:22Z","image":"string","price":0.1,"resellerPrice":0.1,"currency":"string","signatureKeysId":0,"meta":"string","isApplication":true,"updateChannelDefault":"string","renewalUrl":"string","signatureKeys":{"id":0,"name":"string","type":"string","code":"string","description":"string","source":"string","password":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","data":"string","dataFormat":"string","meta":"string"},"productOrders":[{}]},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0}}],"totalOrderProductsCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "orderProducts": [
    {
      "productId": 0,
      "orderId": 0,
      "quantity": 0,
      "unitPrice": 0.1,
      "discount": 0.1,
      "taxes": 0.1,
      "description": "string",
      "product": {
        "id": 0,
        "code": "string",
        "name": "string",
        "description": "string",
        "url": "string",
        "copyright": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "image": "string",
        "price": 0.1,
        "resellerPrice": 0.1,
        "currency": "string",
        "signatureKeysId": 0,
        "meta": "string",
        "isApplication": true,
        "updateChannelDefault": "string",
        "renewalUrl": "string",
        "signatureKeys": {
          "id": 0,
          "name": "string",
          "type": "string",
          "code": "string",
          "description": "string",
          "source": "string",
          "password": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "data": "string",
          "dataFormat": "string",
          "meta": "string"
        },
        "productOrders": [
          {}
        ]
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      }
    }
  ],
  "totalOrderProductsCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetOrderProductsResponse

Authentication: API key (x-api-key).

POST`/v1/orders/{orderId}/products/{productId}`POST /v1/orders/{orderId}/products/{productId}

Code samples

cURL


# You can also use wget
curl -X POST /v1/orders/{orderId}/products/{productId} \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "productOrder": {
    "productId": 0,
    "orderId": 0,
    "quantity": 0,
    "unitPrice": 0.1,
    "discount": 0.1,
    "taxes": 0.1,
    "description": "string",
    "product": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "copyright": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "image": "string",
      "price": 0.1,
      "resellerPrice": 0.1,
      "currency": "string",
      "signatureKeysId": 0,
      "meta": "string",
      "isApplication": true,
      "updateChannelDefault": "string",
      "renewalUrl": "string",
      "signatureKeys": {
        "id": 0,
        "name": "string",
        "type": "string",
        "code": "string",
        "description": "string",
        "source": "string",
        "password": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "data": "string",
        "dataFormat": "string",
        "meta": "string"
      },
      "productOrders": [
        {}
      ]
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    }
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}/products/{productId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/orders/{orderId}/products/{productId}";
      
      string json = @"{
  ""productOrder"": {
    ""productId"": 0,
    ""orderId"": 0,
    ""quantity"": 0,
    ""unitPrice"": 0.1,
    ""discount"": 0.1,
    ""taxes"": 0.1,
    ""description"": ""string"",
    ""product"": {
      ""id"": 0,
      ""code"": ""string"",
      ""name"": ""string"",
      ""description"": ""string"",
      ""url"": ""string"",
      ""copyright"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""image"": ""string"",
      ""price"": 0.1,
      ""resellerPrice"": 0.1,
      ""currency"": ""string"",
      ""signatureKeysId"": 0,
      ""meta"": ""string"",
      ""isApplication"": true,
      ""updateChannelDefault"": ""string"",
      ""renewalUrl"": ""string"",
      ""signatureKeys"": {
        ""id"": 0,
        ""name"": ""string"",
        ""type"": ""string"",
        ""code"": ""string"",
        ""description"": ""string"",
        ""source"": ""string"",
        ""password"": ""string"",
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""data"": ""string"",
        ""dataFormat"": ""string"",
        ""meta"": ""string""
      },
      ""productOrders"": [
        {}
      ]
    },
    ""order"": {
      ""id"": 0,
      ""orderNumber"": ""string"",
      ""status"": ""string"",
      ""processedBy"": ""string"",
      ""purchaseOrder"": ""string"",
      ""total"": 0.1,
      ""currency"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""invoiceNumber"": ""string"",
      ""paymentType"": ""string"",
      ""paymentNumber"": ""string"",
      ""paymentStatus"": ""string"",
      ""paymentDate"": ""2019-08-24T14:15:22Z"",
      ""description"": ""string"",
      ""customerId"": 0,
      ""customer"": {
        ""id"": 0,
        ""title"": ""string"",
        ""firstName"": ""string"",
        ""lastName"": ""string"",
        ""company"": ""string"",
        ""code"": ""string"",
        ""vatCode"": ""string"",
        ""invoiceCode"": ""string"",
        ""rating"": 0,
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""address"": ""string"",
        ""address1"": ""string"",
        ""address2"": ""string"",
        ""postalCode"": ""string"",
        ""region"": ""string"",
        ""city"": ""string"",
        ""country"": ""string"",
        ""countryCode"": ""string"",
        ""mapCoordinates"": ""string"",
        ""mapZoomLevel"": 0.1,
        ""email"": ""string"",
        ""phone"": ""string"",
        ""mobile"": ""string"",
        ""fax"": ""string"",
        ""website"": ""string"",
        ""notes"": ""string"",
        ""isReseller"": true,
        ""image"": ""string"",
        ""meta"": ""string"",
        ""contacts"": [
          {
            ""id"": 0,
            ""title"": ""string"",
            ""firstName"": ""string"",
            ""lastName"": ""string"",
            ""email"": ""string"",
            ""phone"": ""string"",
            ""mobile"": ""string"",
            ""fax"": ""string"",
            ""details"": ""string"",
            ""notify"": true,
            ""customerId"": 0,
            ""meta"": ""string""
          }
        ]
      },
      ""resellerId"": 0
    }
  }
}";
      Management.InsertProductOrderRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertProductOrderRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertProductOrderRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /v1/orders/\{orderId\}/products/\{productId\}

Inserts a new product order.

Body parameter


{
  "productOrder": {
    "productId": 0,
    "orderId": 0,
    "quantity": 0,
    "unitPrice": 0.1,
    "discount": 0.1,
    "taxes": 0.1,
    "description": "string",
    "product": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "copyright": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "image": "string",
      "price": 0.1,
      "resellerPrice": 0.1,
      "currency": "string",
      "signatureKeysId": 0,
      "meta": "string",
      "isApplication": true,
      "updateChannelDefault": "string",
      "renewalUrl": "string",
      "signatureKeys": {
        "id": 0,
        "name": "string",
        "type": "string",
        "code": "string",
        "description": "string",
        "source": "string",
        "password": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "data": "string",
        "dataFormat": "string",
        "meta": "string"
      },
      "productOrders": [
        {}
      ]
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    }
  }
}

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.
productId	path	integer(int32)	true	The product ID.
body	body	Management.InsertProductOrderRequest	false	The request containing the details of the product order to insert.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.InsertProductOrderResponse

Authentication: API key (x-api-key).

PUT`/v1/orders/{orderId}/products/{productId}`PUT /v1/orders/{orderId}/products/{productId}

Code samples

cURL


# You can also use wget
curl -X PUT /v1/orders/{orderId}/products/{productId} \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


const inputBody = '{
  "productOrder": {
    "productId": 0,
    "orderId": 0,
    "quantity": 0,
    "unitPrice": 0.1,
    "discount": 0.1,
    "taxes": 0.1,
    "description": "string",
    "product": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "copyright": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "image": "string",
      "price": 0.1,
      "resellerPrice": 0.1,
      "currency": "string",
      "signatureKeysId": 0,
      "meta": "string",
      "isApplication": true,
      "updateChannelDefault": "string",
      "renewalUrl": "string",
      "signatureKeys": {
        "id": 0,
        "name": "string",
        "type": "string",
        "code": "string",
        "description": "string",
        "source": "string",
        "password": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "data": "string",
        "dataFormat": "string",
        "meta": "string"
      },
      "productOrders": [
        {}
      ]
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    }
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}/products/{productId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/orders/{orderId}/products/{productId}";
 
      
      string json = @"{
  ""productOrder"": {
    ""productId"": 0,
    ""orderId"": 0,
    ""quantity"": 0,
    ""unitPrice"": 0.1,
    ""discount"": 0.1,
    ""taxes"": 0.1,
    ""description"": ""string"",
    ""product"": {
      ""id"": 0,
      ""code"": ""string"",
      ""name"": ""string"",
      ""description"": ""string"",
      ""url"": ""string"",
      ""copyright"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""image"": ""string"",
      ""price"": 0.1,
      ""resellerPrice"": 0.1,
      ""currency"": ""string"",
      ""signatureKeysId"": 0,
      ""meta"": ""string"",
      ""isApplication"": true,
      ""updateChannelDefault"": ""string"",
      ""renewalUrl"": ""string"",
      ""signatureKeys"": {
        ""id"": 0,
        ""name"": ""string"",
        ""type"": ""string"",
        ""code"": ""string"",
        ""description"": ""string"",
        ""source"": ""string"",
        ""password"": ""string"",
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""data"": ""string"",
        ""dataFormat"": ""string"",
        ""meta"": ""string""
      },
      ""productOrders"": [
        {}
      ]
    },
    ""order"": {
      ""id"": 0,
      ""orderNumber"": ""string"",
      ""status"": ""string"",
      ""processedBy"": ""string"",
      ""purchaseOrder"": ""string"",
      ""total"": 0.1,
      ""currency"": ""string"",
      ""createdAt"": ""2019-08-24T14:15:22Z"",
      ""updatedAt"": ""2019-08-24T14:15:22Z"",
      ""invoiceNumber"": ""string"",
      ""paymentType"": ""string"",
      ""paymentNumber"": ""string"",
      ""paymentStatus"": ""string"",
      ""paymentDate"": ""2019-08-24T14:15:22Z"",
      ""description"": ""string"",
      ""customerId"": 0,
      ""customer"": {
        ""id"": 0,
        ""title"": ""string"",
        ""firstName"": ""string"",
        ""lastName"": ""string"",
        ""company"": ""string"",
        ""code"": ""string"",
        ""vatCode"": ""string"",
        ""invoiceCode"": ""string"",
        ""rating"": 0,
        ""createdAt"": ""2019-08-24T14:15:22Z"",
        ""updatedAt"": ""2019-08-24T14:15:22Z"",
        ""address"": ""string"",
        ""address1"": ""string"",
        ""address2"": ""string"",
        ""postalCode"": ""string"",
        ""region"": ""string"",
        ""city"": ""string"",
        ""country"": ""string"",
        ""countryCode"": ""string"",
        ""mapCoordinates"": ""string"",
        ""mapZoomLevel"": 0.1,
        ""email"": ""string"",
        ""phone"": ""string"",
        ""mobile"": ""string"",
        ""fax"": ""string"",
        ""website"": ""string"",
        ""notes"": ""string"",
        ""isReseller"": true,
        ""image"": ""string"",
        ""meta"": ""string"",
        ""contacts"": [
          {
            ""id"": 0,
            ""title"": ""string"",
            ""firstName"": ""string"",
            ""lastName"": ""string"",
            ""email"": ""string"",
            ""phone"": ""string"",
            ""mobile"": ""string"",
            ""fax"": ""string"",
            ""details"": ""string"",
            ""notify"": true,
            ""customerId"": 0,
            ""meta"": ""string""
          }
        ]
      },
      ""resellerId"": 0
    }
  }
}";
      Management.UpdateProductOrderRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateProductOrderRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateProductOrderRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /v1/orders/\{orderId\}/products/\{productId\}

Updates an existing product order.

Body parameter


{
  "productOrder": {
    "productId": 0,
    "orderId": 0,
    "quantity": 0,
    "unitPrice": 0.1,
    "discount": 0.1,
    "taxes": 0.1,
    "description": "string",
    "product": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "copyright": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "image": "string",
      "price": 0.1,
      "resellerPrice": 0.1,
      "currency": "string",
      "signatureKeysId": 0,
      "meta": "string",
      "isApplication": true,
      "updateChannelDefault": "string",
      "renewalUrl": "string",
      "signatureKeys": {
        "id": 0,
        "name": "string",
        "type": "string",
        "code": "string",
        "description": "string",
        "source": "string",
        "password": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "data": "string",
        "dataFormat": "string",
        "meta": "string"
      },
      "productOrders": [
        {}
      ]
    },
    "order": {
      "id": 0,
      "orderNumber": "string",
      "status": "string",
      "processedBy": "string",
      "purchaseOrder": "string",
      "total": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "paymentType": "string",
      "paymentNumber": "string",
      "paymentStatus": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "customerId": 0,
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "resellerId": 0
    }
  }
}

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.
productId	path	integer(int32)	true	The product ID.
body	body	Management.UpdateProductOrderRequest	false	The request containing the details of the product order to update.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.UpdateProductOrderResponse

Authentication: API key (x-api-key).

DELETE`/v1/orders/{orderId}/products/{productId}`DELETE /v1/orders/{orderId}/products/{productId}

Code samples

cURL


# You can also use wget
curl -X DELETE /v1/orders/{orderId}/products/{productId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}/products/{productId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/orders/{orderId}/products/{productId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /v1/orders/\{orderId\}/products/\{productId\}

Deletes a specific product order.

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.
productId	path	integer(int32)	true	The product ID.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.DeleteProductOrderResponse

Authentication: API key (x-api-key).

GET`/v1/orders/{orderId}/licenses`GET /v1/orders/{orderId}/licenses

Code samples

cURL


# You can also use wget
curl -X GET /v1/orders/{orderId}/licenses \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'

JavaScript


 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/orders/{orderId}/licenses',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/orders/{orderId}/licenses";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /v1/orders/\{orderId\}/licenses

Gets the licenses for a specific order.

Parameters

Name	In	Type	Required	Description
orderId	path	integer(int32)	true	The order ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","licenses":[{"id":0,"licenseId":"string","licenseType":"string","format":0,"description":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","issueDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","supportExpireDate":"2019-08-24T14:15:22Z","revoked":true,"trace":true,"licenseKey":"string","maxAllowedSites":0,"userKey":"string","licensingMode":0,"licenseeName":"string","licenseeCompany":"string","licenseeEmail":"string","hash":"string","meta":"string","templateId":0,"signatureKeysId":0,"customerId":0,"orderId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"order":{"id":0,"orderNumber":"string","status":"string","processedBy":"string","purchaseOrder":"string","total":0.1,"currency":"string","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","invoiceNumber":"string","paymentType":"string","paymentNumber":"string","paymentStatus":"string","paymentDate":"2019-08-24T14:15:22Z","description":"string","customerId":0,"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"resellerId":0},"customer":{"id":0,"title":"string","firstName":"string","lastName":"string","company":"string","code":"string","vatCode":"string","invoiceCode":"string","rating":0,"createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","address":"string","address1":"string","address2":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mapCoordinates":"string","mapZoomLevel":0.1,"email":"string","phone":"string","mobile":"string","fax":"string","website":"string","notes":"string","isReseller":true,"image":"string","meta":"string","contacts":[{"id":0,"title":"string","firstName":"string","lastName":"string","email":"string","phone":"string","mobile":"string","fax":"string","details":"string","notify":true,"customerId":0,"meta":"string"}]},"template":{"id":0,"name":"string","code":"string","licenseType":"string","format":0,"licensingMode":0,"licenseFileName":"string","issueDate":true,"expireDays":0,"supportDays":0,"generateKeyInfo":true,"userKey":"string","description":"string","template":"string","productId":0,"signatureKeysId":0,"releaseId":0,"product":{"id":"string","name":"string","version":"string","copyright":"string","url":"string","description":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]},"licensee":{"name":"string","company":"string","contactInfo":"string","url":"string"},"components":["string"],"assemblies":[{"id":0,"name":"string","version":"string","culture":"string","publicKeyToken":"string","mappingFileId":0,"debugSymbolsKey":"string"}],"fields":[{"name":"string","value":"string"}],"features":[{"id":"string","name":"string","description":"string","expireDate":"2019-08-24T14:15:22Z","key":"string","data":"string"}],"restrictions":[{"id":"string","name":"string","expireDate":"2019-08-24T14:15:22Z","properties":{"property1":"string","property2":"string"},"customXmlContent":"string"}]}],"totalLicensesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "licenses": [
    {
      "id": 0,
      "licenseId": "string",
      "licenseType": "string",
      "format": 0,
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "issueDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "supportExpireDate": "2019-08-24T14:15:22Z",
      "revoked": true,
      "trace": true,
      "licenseKey": "string",
      "maxAllowedSites": 0,
      "userKey": "string",
      "licensingMode": 0,
      "licenseeName": "string",
      "licenseeCompany": "string",
      "licenseeEmail": "string",
      "hash": "string",
      "meta": "string",
      "templateId": 0,
      "signatureKeysId": 0,
      "customerId": 0,
      "orderId": 0,
      "product": {
        "id": "string",
        "name": "string",
        "version": "string",
        "copyright": "string",
        "url": "string",
        "description": "string"
      },
      "order": {
        "id": 0,
        "orderNumber": "string",
        "status": "string",
        "processedBy": "string",
        "purchaseOrder": "string",
        "total": 0.1,
        "currency": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "invoiceNumber": "string",
        "paymentType": "string",
        "paymentNumber": "string",
        "paymentStatus": "string",
        "paymentDate": "2019-08-24T14:15:22Z",
        "description": "string",
        "customerId": 0,
        "customer": {
          "id": 0,
          "title": "string",
          "firstName": "string",
          "lastName": "string",
          "company": "string",
          "code": "string",
          "vatCode": "string",
          "invoiceCode": "string",
          "rating": 0,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "address": "string",
          "address1": "string",
          "address2": "string",
          "postalCode": "string",
          "region": "string",
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "mapCoordinates": "string",
          "mapZoomLevel": 0.1,
          "email": "string",
          "phone": "string",
          "mobile": "string",
          "fax": "string",
          "website": "string",
          "notes": "string",
          "isReseller": true,
          "image": "string",
          "meta": "string",
          "contacts": [
            {
              "id": 0,
              "title": "string",
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "mobile": "string",
              "fax": "string",
              "details": "string",
              "notify": true,
              "customerId": 0,
              "meta": "string"
            }
          ]
        },
        "resellerId": 0
      },
      "customer": {
        "id": 0,
        "title": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "code": "string",
        "vatCode": "string",
        "invoiceCode": "string",
        "rating": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "address": "string",
        "address1": "string",
        "address2": "string",
        "postalCode": "string",
        "region": "string",
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "mapCoordinates": "string",
        "mapZoomLevel": 0.1,
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "fax": "string",
        "website": "string",
        "notes": "string",
        "isReseller": true,
        "image": "string",
        "meta": "string",
        "contacts": [
          {
            "id": 0,
            "title": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "mobile": "string",
            "fax": "string",
            "details": "string",
            "notify": true,
            "customerId": 0,
            "meta": "string"
          }
        ]
      },
      "template": {
        "id": 0,
        "name": "string",
        "code": "string",
        "licenseType": "string",
        "format": 0,
        "licensingMode": 0,
        "licenseFileName": "string",
        "issueDate": true,
        "expireDays": 0,
        "supportDays": 0,
        "generateKeyInfo": true,
        "userKey": "string",
        "description": "string",
        "template": "string",
        "productId": 0,
        "signatureKeysId": 0,
        "releaseId": 0,
        "product": {
          "id": "string",
          "name": "string",
          "version": "string",
          "copyright": "string",
          "url": "string",
          "description": "string"
        },
        "components": [
          "string"
        ],
        "assemblies": [
          {
            "id": 0,
            "name": "string",
            "version": "string",
            "culture": "string",
            "publicKeyToken": "string",
            "mappingFileId": 0,
            "debugSymbolsKey": "string"
          }
        ],
        "fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "features": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "key": "string",
            "data": "string"
          }
        ],
        "restrictions": [
          {
            "id": "string",
            "name": "string",
            "expireDate": "2019-08-24T14:15:22Z",
            "properties": {
              "property1": "string",
              "property2": "string"
            },
            "customXmlContent": "string"
          }
        ]
      },
      "licensee": {
        "name": "string",
        "company": "string",
        "contactInfo": "string",
        "url": "string"
      },
      "components": [
        "string"
      ],
      "assemblies": [
        {
          "id": 0,
          "name": "string",
          "version": "string",
          "culture": "string",
          "publicKeyToken": "string",
          "mappingFileId": 0,
          "debugSymbolsKey": "string"
        }
      ],
      "fields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "features": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "key": "string",
          "data": "string"
        }
      ],
      "restrictions": [
        {
          "id": "string",
          "name": "string",
          "expireDate": "2019-08-24T14:15:22Z",
          "properties": {
            "property1": "string",
            "property2": "string"
          },
          "customXmlContent": "string"
        }
      ]
    }
  ],
  "totalLicensesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetOrderLicensesResponse

Authentication: API key (x-api-key).

Order Products and Licenses

GET/v1/orders/{orderId}/productsGET /v1/orders/{orderId}/products

Code samples

cURL

JavaScript

C#

Parameters

Responses

POST/v1/orders/{orderId}/products/{productId}POST /v1/orders/{orderId}/products/{productId}

Code samples

cURL

JavaScript

C#

Parameters

Responses

PUT/v1/orders/{orderId}/products/{productId}PUT /v1/orders/{orderId}/products/{productId}

Code samples

cURL

JavaScript

C#

Parameters

Responses

DELETE/v1/orders/{orderId}/products/{productId}DELETE /v1/orders/{orderId}/products/{productId}

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET/v1/orders/{orderId}/licensesGET /v1/orders/{orderId}/licenses

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET`/v1/orders/{orderId}/products`GET /v1/orders/{orderId}/products

POST`/v1/orders/{orderId}/products/{productId}`POST /v1/orders/{orderId}/products/{productId}

PUT`/v1/orders/{orderId}/products/{productId}`PUT /v1/orders/{orderId}/products/{productId}

DELETE`/v1/orders/{orderId}/products/{productId}`DELETE /v1/orders/{orderId}/products/{productId}

GET`/v1/orders/{orderId}/licenses`GET /v1/orders/{orderId}/licenses