GET ordersearch

No documentation available.

Request Information

» Expands

Name	Description	Usage
account	This will retrieve the related account.	GET ordersearch?expand=account
orderLineItems	This will retrieve the related list of order line items.	GET ordersearch?expand=orderlineitems
paymentOption	This will retrieve the related payment option.	GET ordersearch?expand=paymentoption
paymentType	This will retrieve the related payment type.	GET ordersearch?expand=paymenttype
shippingOption	This will retrieve the latest shipping option.	GET ordersearch?expand=shippingoption

» Filters

Name	Description	Usage
accountId	This will filter the request by account ID.	GET ordersearch?filter=accountid~{operator}~{value}
companyName	This will filter the request by company name.	GET ordersearch?filter=companyname~{operator}~{value}
countryCode	This will filter the request by country code.	GET ordersearch?filter=countrycode~{operator}~{value}
email	This will filter the request by email.	GET ordersearch?filter=email~{operator}~{value}
externalId	This will filter the request by external ID.	GET ordersearch?filter=externalid~{operator}~{value}
lastName	This will filter the request by last name.	GET ordersearch?filter=lastname~{operator}~{value}
orderDate	This will filter the request by order date.	GET ordersearch?filter=orderdate~{operator}~{value}
orderStateId	This will filter the request by order state ID.	GET ordersearch?filter=orderstateid~{operator}~{value}
portalId	This will filter the request by portal ID.	GET ordersearch?filter=portalid~{operator}~{value}
postalCode	This will filter the request by postal code.	GET ordersearch?filter=postalcode~{operator}~{value}
purchaseOrderNumber	This will filter the request by purchase order number.	GET ordersearch?filter=purchaseordernumber~{operator}~{value}
stateCode	This will filter the request by state code.	GET ordersearch?filter=statecode~{operator}~{value}
total	This will filter the request by total.	GET ordersearch?filter=total~{operator}~{value}
trackingNumber	This will filter the request by tracking number.	GET ordersearch?filter=trackingnumber~{operator}~{value}
transactionId	This will filter the request by transaction ID.	GET ordersearch?filter=transactionid~{operator}~{value}

» Sorting

Name	Description	Usage
city	This will sort the response by city.	GET ordersearch?sort=city
companyName	This will sort the response by company name.	GET ordersearch?sort=companyname
countryCode	This will sort the response by country code.	GET ordersearch?sort=countrycode
lastName	This will sort the response by last name.	GET ordersearch?sort=lastname
orderDate	This will sort the response by order date.	GET ordersearch?sort=orderdate
orderId	This will sort the response by order ID.	GET ordersearch?sort=orderid
postalCode	This will sort the response by portal code.	GET ordersearch?sort=postalcode
stateCode	This will sort the response by state code.	GET ordersearch?sort=statecode
total	This will sort the response by total.	GET ordersearch?sort=total

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET ordersearch?page=index~{value}
size	The size of the page when retrieving paged results.	GET ordersearch?page=size~{value}