ApexERPHost

<back to all web services

GetCrmOrderExternals

Requires Authentication
The following routes are available for this service:
GET/Crm/Orders/External/{OrderId}
GET/Crm/Orders/External
GetCrmOrderExternals Parameters:
NameParameterData TypeRequiredDescription
order_datequeryDateTime[]No
delivery_datequeryDateTime[]No
Statusqueryint[]No
OrderTypequeryint[]No
SupplierBranchIdqueryint?No
RecipientBranchIdqueryint?No
Idqueryint?No
GetCrmOrderExternalsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<GetExtRequestInfoResponse>No
GetExtRequestInfoResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
RequestIdformintNo
RequestTypeformintNo
RequestStatusformintNo
RequestDataformList<ExternalOrderReference>No
OrderIdformintNo
ExternalOrderReference Parameters:
NameParameterData TypeRequiredDescription
OrderIdformintNo
StatusformintNo
ReceiveDocIdformstringNo
ReceiveWarehouseAccformstringNo
VanWarehouseAccformstringNo
ExtSupplierBranchIdformint?No
SubOrderIdformint?No
LocalSubOrderIdformint?No

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/External/{OrderId} HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	[
		{
			ResponseStatus: 
			{
				ErrorCode: String,
				Message: String,
				StackTrace: String,
				Errors: 
				[
					{
						ErrorCode: String,
						FieldName: String,
						Message: String,
						Meta: 
						{
							String: String
						}
					}
				],
				Meta: 
				{
					String: String
				}
			},
			RequestId: 0,
			RequestType: 0,
			RequestStatus: 0,
			RequestData: 
			[
				{
					OrderId: 0,
					Status: 0,
					ReceiveDocId: String,
					ReceiveWarehouseAcc: String,
					VanWarehouseAcc: String,
					ExtSupplierBranchId: 0,
					SubOrderId: 0,
					LocalSubOrderId: 0
				}
			],
			OrderId: 0
		}
	]
}