EMUN1 ASP.NET

<back to all web services

QueryParcels

The following routes are available for this service:
All Verbs/service/QueryParcels
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Parcel Parameters:
NameParameterData TypeRequiredDescription
CartonNumberformstringNo
OrderNumberformstringNo
OrderStatusformstringNo
OrderedOnformDateTimeNo
InvoiceNumberformstringNo
InvoicedOnformDateTimeNo
ManufacturerIdformstringNo
ShippingMethodformstringNo
TrackingNumberformstringNo
TrackingUrlformstringNo
WarehouseformstringNo
PONumberformstringNo
CartNameformstringNo
RetailerIdformstringNo
RetailerEmailformstringNo
ShippingLocationIdformstringNo
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
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.

POST /service/QueryParcels HTTP/1.1 
Host: www.bernhardthospitality.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			cartonNumber: String,
			orderNumber: String,
			orderStatus: String,
			orderedOn: 0001-01-01,
			invoiceNumber: String,
			invoicedOn: 0001-01-01,
			manufacturerId: String,
			shippingMethod: String,
			trackingNumber: String,
			trackingUrl: String,
			warehouse: String,
			poNumber: String,
			cartName: String,
			retailerId: String,
			retailerEmail: String,
			shippingLocationId: String,
			id: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}