Murano - Sales
A powerful API providing easy, secure, scalable integration into the core Sage Murano product which enables third-party developers to rapidly create apps and rich extensions. Sales API exposes resources of Sage Murano related to sales process such as customers, items, quotes, orders, delivery notes, invoices, receipts and payments. Typical integrations use cases are e-commerce, mobile sales, catalogues, invoice brokers, point of sales.
Get sales_orders
Get all the resources of type 'SalesOrder', optionally paged, ordered and filtered.
Try itRequest URL
Request parameters
(optional)
integer
Format - int32. startIndex indicates an absolute “offset” in the complete list of the requested resources. The default value is 1. In case of missing this parameter, then the default value will be 1 which refers to the first object.
(optional)
integer
Format - int32. itemsPerPage enables you to limit the maximum number of objects returned in a request. The default value and the maximum value allowed is 50. In case of specify a value greater than 50, then only 50 objects will be returned.
(optional)
string
Format - date-time (as date-time in RFC3339). updatedOrCreatedSince enables you to return a collection of objects which has been created or updated from the specified date
(optional)
string
Format - date-time (as date-time in RFC3339). deletedSince enables you to return a collection of objects which has been deleted from the specified date
(optional)
string
orderby enables you to return the result in ascending or descending order. The order is based on the field name you specify and the key words asc for ascending and desc for descending. If you want to sort by more than one data filed, then they will be separated by comma (,).
(optional)
string
where enables you to filter the objects that are returned using expressions which includes the following operators: eq (equals), nq (distinct), lt (less than), le (less or equal than), gt (greater than), ge (greater or equal than), in (inside of), like (similarity pattern). Currently only is possible to apply filtering using one of the data fields that has been marked with the flag “where”.
(optional)
boolean
compact enables you to include all the child objects that are linked to the parent object within your results. The default value is true.
Request headers
string
Tenant unique identifier.
string
Company unique identifier.
string
Sage ID Access Token prefixed with the word 'Bearer'.
string
Subscription key which provides access to this API.
Request body
Response 200
OK.
{
"$totalResults": 0,
"$startIndex": 0,
"$itemsPerPage": 0,
"$resources": [
{
"id": "string",
"company_id": "string",
"period": "string",
"serial": "string",
"number": 0,
"date": "string",
"delivery_date": "string",
"customer_id": "string",
"status": "1",
"currency": "string",
"currency_change_rate": 0.0,
"tax_type": "1",
"included_vat": true,
"address_id": "string",
"delivery_address_id": "string",
"payment_method_id": "string",
"sales_person_id": "string",
"commission_percent": 0.0,
"discount_percent": 0.0,
"discount_payment_method_percent": 0.0,
"discount_amount_rappel_percent": 0.0,
"income_tax_rate_id": "string",
"income_tax_rate": 0.0,
"status_published": true,
"your_sales_order_number": "string",
"price_type_id": "string",
"advance_payment": {
"amount": 0.0,
"date": "string",
"payment_method_id": "string"
},
"charges_total": 0.0,
"commission_amount": 0.0,
"discount_amount": 0.0,
"discount_payment_method_amount": 0.0,
"discount_amount_rappel_amount": 0.0,
"net_total": 0.0,
"tax_total": 0.0,
"income_tax_amount": 0.0,
"total": 0.0,
"notes": "string",
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
],
"sales_order_lines": [
{
"id": "string",
"sales_quote_line_id": "string",
"item_id": "string",
"item_set_id": "string",
"order": 0,
"item_barcode": "string",
"item_description": "string",
"item_long_description": "string",
"properties": [
{
"item_property_id": "string",
"value": "string",
"group": "string"
}
],
"vat_tax_rate": 0.0,
"surcharge_tax_rate": 0.0,
"quantity": 0.0,
"price": 0.0,
"item_discount_percent": 0.0,
"commission_percent": 0.0,
"line_included_vat": true,
"location_id": "string",
"item_discount_amount": 0.0,
"net_total": 0.0,
"vat_tax_amount": 0.0,
"surcharge_tax_amount": 0.0,
"total": 0.0,
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
]
}
],
"sales_order_taxes": [
{
"id": "string",
"vat_tax_rate_id": "string",
"base": 0.0,
"vat_tax_rate": 0.0,
"vat_tax_amount": 0.0,
"surcharge_tax_rate": 0.0,
"surcharge_tax_amount": 0.0,
"total_tax_amount": 0.0
}
],
"timestamp": "string"
}
]
}{
"type": "object",
"properties": {
"$totalResults": {
"type": "integer",
"format": "int32",
"description": "Indicates the number of objects returned in a request",
"readOnly": false
},
"$startIndex": {
"type": "integer",
"format": "int32",
"description": "startIndex indicates an absolute “offset” in the complete list of the requested resources. The default value is 1.\r\nIn case of missing this parameter, then the default value will be 1 which refers to the first object.",
"readOnly": false
},
"$itemsPerPage": {
"type": "integer",
"format": "int32",
"description": "itemsPerPage enables you to limit the maximum number of objects returned in a request. The default value and the maximum value allowed is 50. In case of specify a value greater than 50, then only 50 objects will be returned.",
"readOnly": false
},
"$resources": {
"type": "array",
"items": {
"type": "object",
"description": "List of sales order of the company. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Orders",
"x-sage-relatedopeations": [
"companies",
"customers",
"contacts",
"item_type_prices",
"payment_methods",
"zones",
"sales_persons",
"cost_centers",
"customer_groups",
"income_tax_rates"
],
"required": [
"company_id",
"customer_id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "ID of Sales Order",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"company_id": {
"type": "string",
"description": "Company ID of Sales Order",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"period": {
"type": "string",
"maxLength": 4,
"description": "Period Sales Order or Sales Order",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"serial": {
"type": "string",
"maxLength": 10,
"description": "Serial of sales order",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"number": {
"type": "integer",
"format": "int64",
"description": "Number of sales order",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"date": {
"type": "string",
"format": "date-time",
"description": "Date of sales order",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"delivery_date": {
"type": "string",
"format": "date-time",
"description": "Delivery date of sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"customer_id": {
"type": "string",
"maxLength": 16,
"description": "Customer ID of the sales order",
"x-sage-entitylink": "customers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"status": {
"type": "string",
"description": "Status of the document. See <a href=\"/docs#/spain/murano/sales/v1/documentstatustype\">documentstatustype</a>",
"readOnly": false,
"x-sage-enumlink": "documentstatustype",
"enum": [
"1",
"2"
],
"x-sage-queryable": true,
"x-sage-orderable": true
},
"currency": {
"type": "string",
"maxLength": 3,
"description": "Sales Order Currency of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"currency_change_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Currency Change Rate of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"tax_type": {
"type": "string",
"description": "Tax reference of the sales order. See <a href=\"/docs#/spain/murano/sales/v1/taxtype\">taxtype</a>",
"readOnly": false,
"x-sage-enumlink": "taxtype",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"included_vat": {
"type": "boolean",
"description": "Include VAT of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"address_id": {
"type": "string",
"maxLength": 18,
"description": "Address ID of the sales order",
"x-sage-entitylink": "addresses",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"delivery_address_id": {
"type": "string",
"description": "Delivery Address ID of the sales order",
"x-sage-entitylink": "addresses",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"payment_method_id": {
"type": "string",
"maxLength": 16,
"description": "payment method ID for the sales order",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_person_id": {
"type": "string",
"maxLength": 16,
"description": "Sales person ID for the sales order",
"x-sage-entitylink": "sales_persons",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"commission_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Commission Percent of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Discount Percent of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_payment_method_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent discount of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_amount_rappel_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent Discount Amount Rappel of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_rate_id": {
"type": "string",
"maxLength": 16,
"description": "Income tax id",
"x-sage-entitylink": "income_tax_rates",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent INCOME_TAX of th sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"status_published": {
"type": "boolean",
"description": "Status published of the sales order",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"your_sales_order_number": {
"type": "string",
"maxLength": 15,
"description": "Your order of the sales order",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"price_type_id": {
"type": "string",
"maxLength": 16,
"description": "Price list id",
"x-sage-entitylink": "item_type_prices",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"advance_payment": {
"type": "object",
"description": "Advanced Paid Amount of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "amount payed in advance",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"date": {
"type": "string",
"format": "date-time",
"description": "date of the payment",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"payment_method_id": {
"type": "string",
"description": "Payment method",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
},
"charges_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Charges Amount of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"commission_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Commission Amount of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Amount discount of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_payment_method_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Discount Amount payment method of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_amount_rappel_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Discount Rappel Amount of the sales oder",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"net_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "SubTotal of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"tax_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total Tax of th sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"income_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax INCOME_TAX of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"notes": {
"type": "string",
"maxLength": 50,
"description": "Notes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"cost_centers": {
"type": "array",
"description": "associated cost centers",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "string"
}
},
"extended_properties": {
"type": "array",
"description": "List of free properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"description": "value of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"sales_order_lines": {
"type": "array",
"description": "List of sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "ID sales order of Sales Order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_quote_line_id": {
"type": "string",
"description": "Sales quote lines ID relation quote",
"x-sage-entitylink": "sales_quote_lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_id": {
"type": "string",
"maxLength": 16,
"description": "ID Items of sales order lines",
"x-sage-entitylink": "items",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_set_id": {
"type": "string",
"maxLength": 16,
"description": "Set id",
"x-sage-entitylink": "item_sets",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"order": {
"type": "integer",
"format": "int32",
"description": "Presentation order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_barcode": {
"type": "string",
"maxLength": 20,
"description": "Items Bar code of sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_description": {
"type": "string",
"maxLength": 50,
"description": "Items Description of sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_long_description": {
"type": "string",
"maxLength": 16,
"description": "Items long Description of sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"properties": {
"type": "array",
"description": "Property value list of the sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"item_property_id": {
"type": "string",
"description": "Property id",
"x-sage-entitylink": "item_properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"description": "Value",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"group": {
"type": "string",
"description": "Group of the Property",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
}
}
}
},
"vat_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent tax VAT of sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Tax Surcharge of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"quantity": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Quantity of sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"price": {
"type": "number",
"format": "integer 10 decimal 2 dp",
"description": "Sales price of sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_discount_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent discount of sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"commission_percent": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Percent Commission of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"line_included_vat": {
"type": "boolean",
"description": "Lines Included VAT",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"location_id": {
"type": "string",
"maxLength": 16,
"description": "ID Location of the sales order lines",
"x-sage-entitylink": "locations",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"item_discount_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Discount line of sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"net_total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "net amount",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax amount of the sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax Amount VAT_surcharge of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Line amount of the sales order lines",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"cost_centers": {
"type": "array",
"description": "associated cost centers",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "string"
}
},
"extended_properties": {
"type": "array",
"description": "List of free properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"description": "value of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
}
}
}
},
"sales_order_taxes": {
"type": "array",
"description": "List of sales order taxes",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "ID of tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate_id": {
"type": "string",
"maxLength": 16,
"description": "Tax rate id",
"x-sage-entitylink": "vat_tax_rates",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"base": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Taxable base of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Tax VAT of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"vat_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax Amount VAT of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_rate": {
"type": "number",
"format": "integer 3 decimal 2 dp",
"description": "Tax VAT_surcharge of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"surcharge_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Tax Amount VAT_surcharge of Tax table",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total_tax_amount": {
"type": "number",
"format": "integer 13 decimal 2 dp",
"description": "Total tax amount",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the sales order",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
}
}
}Code samples
@ECHO OFF
curl -v -X GET "https://api.columbus.sage.com/es/murano/sales/v1/sales_orders?startIndex={integer}&itemsPerPage={integer}&updatedOrCreatedSince={string}&deletedSince={string}&orderBy={string}&where={string}&compact={boolean}"
-H "X-Site: "
-H "X-Company: "
-H "Authorization: "
-H "Ocp-Apim-Subscription-Key: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("X-Site", "");
client.DefaultRequestHeaders.Add("X-Company", "");
client.DefaultRequestHeaders.Add("Authorization", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["startIndex"] = "{integer}";
queryString["itemsPerPage"] = "{integer}";
queryString["updatedOrCreatedSince"] = "{string}";
queryString["deletedSince"] = "{string}";
queryString["orderBy"] = "{string}";
queryString["where"] = "{string}";
queryString["compact"] = "{boolean}";
var uri = "https://api.columbus.sage.com/es/murano/sales/v1/sales_orders?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.columbus.sage.com/es/murano/sales/v1/sales_orders");
builder.setParameter("startIndex", "{integer}");
builder.setParameter("itemsPerPage", "{integer}");
builder.setParameter("updatedOrCreatedSince", "{string}");
builder.setParameter("deletedSince", "{string}");
builder.setParameter("orderBy", "{string}");
builder.setParameter("where", "{string}");
builder.setParameter("compact", "{boolean}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("X-Site", "");
request.setHeader("X-Company", "");
request.setHeader("Authorization", "");
request.setHeader("Ocp-Apim-Subscription-Key", "");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"startIndex": "{integer}",
"itemsPerPage": "{integer}",
"updatedOrCreatedSince": "{string}",
"deletedSince": "{string}",
"orderBy": "{string}",
"where": "{string}",
"compact": "{boolean}",
};
$.ajax({
url: "https://api.columbus.sage.com/es/murano/sales/v1/sales_orders?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("X-Site","");
xhrObj.setRequestHeader("X-Company","");
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.columbus.sage.com/es/murano/sales/v1/sales_orders";
NSArray* array = @[
// Request parameters
@"entities=true",
@"startIndex={integer}",
@"itemsPerPage={integer}",
@"updatedOrCreatedSince={string}",
@"deletedSince={string}",
@"orderBy={string}",
@"where={string}",
@"compact={boolean}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"X-Site"];
[_request setValue:@"" forHTTPHeaderField:@"X-Company"];
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.columbus.sage.com/es/murano/sales/v1/sales_orders');
$url = $request->getUrl();
$headers = array(
// Request headers
'X-Site' => '',
'X-Company' => '',
'Authorization' => '',
'Ocp-Apim-Subscription-Key' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'startIndex' => '{integer}',
'itemsPerPage' => '{integer}',
'updatedOrCreatedSince' => '{string}',
'deletedSince' => '{string}',
'orderBy' => '{string}',
'where' => '{string}',
'compact' => '{boolean}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'X-Site': '',
'X-Company': '',
'Authorization': '',
'Ocp-Apim-Subscription-Key': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'startIndex': '{integer}',
'itemsPerPage': '{integer}',
'updatedOrCreatedSince': '{string}',
'deletedSince': '{string}',
'orderBy': '{string}',
'where': '{string}',
'compact': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/es/murano/sales/v1/sales_orders?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'X-Site': '',
'X-Company': '',
'Authorization': '',
'Ocp-Apim-Subscription-Key': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'startIndex': '{integer}',
'itemsPerPage': '{integer}',
'updatedOrCreatedSince': '{string}',
'deletedSince': '{string}',
'orderBy': '{string}',
'where': '{string}',
'compact': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/es/murano/sales/v1/sales_orders?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.columbus.sage.com/es/murano/sales/v1/sales_orders')
query = URI.encode_www_form({
# Request parameters
'startIndex' => '{integer}',
'itemsPerPage' => '{integer}',
'updatedOrCreatedSince' => '{string}',
'deletedSince' => '{string}',
'orderBy' => '{string}',
'where' => '{string}',
'compact' => '{boolean}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['X-Site'] = ''
# Request headers
request['X-Company'] = ''
# Request headers
request['Authorization'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body