GET api/companies/{companyId}/ShippingProfiles?page={page}&pageSize={pageSize}&orderBy={orderBy}&ascending={ascending}

List Company Shipping Profiles

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId	The company ID	integer	Required
page	Page number	integer	Default value is 1
pageSize	Number of records a page can hold	integer	Default value is 50
orderBy	Order By	string	Default value is Id
ascending	Asc/Desc	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

A page of Shipping Profiles

PagedResultSetOfShippingProfileDTO

None.

Response Formats

application/json, text/json

Sample:

{
  "metadata": {
    "pageNumber": 1,
    "pageSize": 2,
    "totalNumberOfPages": 3,
    "totalNumberOfRecords": 4,
    "nextPageUrl": "sample string 5"
  },
  "results": [
    {
      "id": 1,
      "companyId": 1,
      "isDefault": true,
      "profileName": "sample string 2",
      "profileDescription": "sample string 3",
      "destinationCompanyName": "sample string 4",
      "attention_FreeText": "sample string 5",
      "phoneNumber": "sample string 6",
      "emailAddress": "sample string 7",
      "address": {
        "id": 1,
        "country": "sample string 1",
        "stateOrProvinceName": "sample string 2",
        "city": "sample string 3",
        "addressLine1": "sample string 4",
        "addressLine2": "sample string 5",
        "zipCode": "sample string 6",
        "postalCode": "sample string 7",
        "isBilling": true,
        "isShipping": true,
        "isMainAddress": true
      },
      "shippingAccount": {
        "id": 1,
        "companyId": 1,
        "isDefault": true,
        "name": "sample string 2",
        "carrier": "sample string 3",
        "carrierType": 1,
        "accountNumber": "sample string 4"
      }
    },
    {
      "id": 1,
      "companyId": 1,
      "isDefault": true,
      "profileName": "sample string 2",
      "profileDescription": "sample string 3",
      "destinationCompanyName": "sample string 4",
      "attention_FreeText": "sample string 5",
      "phoneNumber": "sample string 6",
      "emailAddress": "sample string 7",
      "address": {
        "id": 1,
        "country": "sample string 1",
        "stateOrProvinceName": "sample string 2",
        "city": "sample string 3",
        "addressLine1": "sample string 4",
        "addressLine2": "sample string 5",
        "zipCode": "sample string 6",
        "postalCode": "sample string 7",
        "isBilling": true,
        "isShipping": true,
        "isMainAddress": true
      },
      "shippingAccount": {
        "id": 1,
        "companyId": 1,
        "isDefault": true,
        "name": "sample string 2",
        "carrier": "sample string 3",
        "carrierType": 1,
        "accountNumber": "sample string 4"
      }
    }
  ]
}