ApexERPHost

<back to all web services

CrmOrdersQuery

Requires Authentication
The following routes are available for this service:
GET/Crm/Orders/View/Query
CrmOrdersQuery Parameters:
NameParameterData TypeRequiredDescription
order_dateBetweenqueryDateTime[]No
delivery_dateBetweenqueryDateTime[]No
order_statusInqueryint[]No
recipient_idInqueryint[]No
ForMobilequeryboolNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CrmOrderView Parameters:
NameParameterData TypeRequiredDescription
order_idformintNo
currency_idformstringNo
rateformdecimalNo
order_typeformintNo
order_statusformintNo
order_dateformDateTimeNo
pay_dateformDateTime?No
recipient_idformint?No
supplier_idformintNo
contract_idformint?No
vat_typeformbyteNo
noteformstringNo
presaler_idformint?No
unidformGuidNo
cuserformstringNo
crtimeformDateTimeNo
prod_amountformdecimalNo
service_amountformdecimalNo
payed_amountformdecimalNo
total_amountformdecimal?No
total_rem_amountformdecimal?No
document_numbersformstringNo
supplier_snformstringNo
supplier_company_nameformstringNo
supplier_branch_nameformstringNo
recipient_snformstringNo
recipient_company_nameformstringNo
recipient_branch_nameformstringNo
delivery_typeformint?No
delivery_dateformDateTime?No
transport_numberformstringNo
transport_descriptionformstringNo
delivery_recipient_snformstringNo
delivery_recipientformstringNo
from_addressformstringNo
to_addressformstringNo
prepare_list_numberformstringNo
is_giftformboolNo
sub_order_idformint?No
forwarder_user_idformint?No
booked_prod_amountformdecimal?No
booked_service_amountformdecimal?No
market_part_idformstringNo
market_part_nameformstringNo
loyalty_card_idformstringNo
loyalty_card_owner_pernumformstringNo
loyalty_card_owner_nameformstringNo
driver_snformstringNo
driver_nameformstringNo
forwarder_nameformstringNo
transit_docs_idformstringNo
transit_statusformintNo
delivery_idformint?No
transit_wbidformint?No
transit_tdidformlong?No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Crm/Orders/View/Query HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			order_id: 0,
			currency_id: String,
			rate: 0,
			order_type: 0,
			order_status: 0,
			order_date: 0001-01-01,
			pay_date: 0001-01-01,
			recipient_id: 0,
			supplier_id: 0,
			contract_id: 0,
			vat_type: 0,
			note: String,
			presaler_id: 0,
			unid: 00000000000000000000000000000000,
			cuser: String,
			crtime: 0001-01-01,
			prod_amount: 0,
			service_amount: 0,
			payed_amount: 0,
			total_amount: 0,
			total_rem_amount: 0,
			document_numbers: String,
			supplier_sn: String,
			supplier_company_name: String,
			supplier_branch_name: String,
			recipient_sn: String,
			recipient_company_name: String,
			recipient_branch_name: String,
			delivery_type: 0,
			delivery_date: 0001-01-01,
			transport_number: String,
			transport_description: String,
			delivery_recipient_sn: String,
			delivery_recipient: String,
			from_address: String,
			to_address: String,
			prepare_list_number: String,
			is_gift: False,
			sub_order_id: 0,
			forwarder_user_id: 0,
			booked_prod_amount: 0,
			booked_service_amount: 0,
			market_part_id: String,
			market_part_name: String,
			loyalty_card_id: String,
			loyalty_card_owner_pernum: String,
			loyalty_card_owner_name: String,
			driver_sn: String,
			driver_name: String,
			forwarder_name: String,
			transit_docs_id: String,
			transit_status: 0,
			delivery_id: 0,
			transit_wbid: 0,
			transit_tdid: 0
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}