Shipping Companies

The Shipping Companies resource allows Shipping Companies to be listed.

/ShippingCompanies - returns a list of all ShippingCompanies;
/ShippingCompanies/E6E8163F-6911-40e9-B740-90E5A0A3A996 - returns details of a particular shipping companies;

The full range of URIs and HTTP Verbs supported are:

Operation	HTTP Action
List all non-obsolete Shipping Companies	GET `/ShippingCompanies`
View any Shipping Companies	GET `/ShippingCompanies/{id}`

GET ShippingCompanies

These filters can be used with the GET ShippingCompanies endpoint:

Filter	Description
`pageSize`	Specifies the page size for pagination. Default page size is 200 shipping companies. Note: Requesting large numbers of shipping companies can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
`includeObsolete`	Returns all shipping companies, including obsolete, if set to `true`. If set to `false` or if it is not specified then returns only active (ie. non-obsolete) shipping companies

Filters are used by adding the filter and value to the URI: /ShippingCompanies?includeObsolete=true

Note: Default ordering is done by CreatedOn ascending

Available Fields for ShippingCompany:

Property	Type	Length	Required	Notes
CreatedBy	String
Guid	Guid		Yes	Unique identifier. Can only be set when adding a record.
LastModifiedOn	Nullable DateTime
Name	String	250	Yes
Obsolete	Boolean	`true`, `false`

Examples for Request GET `/ShippingCompanies`

show xml example

 
<?xml version="1.0"?>
<ShippingCompanies xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.unleashedsoftware.com/version/1">
  <Pagination>
    <NumberOfItems>1</NumberOfItems>
    <PageSize>200</PageSize>
    <PageNumber>1</PageNumber>
    <NumberOfPages>1</NumberOfPages>
  </Pagination>
  <ShippingCompany>
    <Guid>cff35bd6-c57e-4a73-a9f3-e0068fd1f339</Guid>
    <LastModifiedOn>2016-03-29T02:43:40.1884177</LastModifiedOn>
    <Name>UPS Tracking Services</Name>
    <Obsolete>false</Obsolete>
    <CreatedBy>franck+newdemo@unleashedsoftware.com</CreatedBy>
  </ShippingCompany>
</ShippingCompanies>

show json example