GET lookup/getCompanyAddresses?isDefault={isDefault}&page={page}&pageSize={pageSize}

Returns the Addresses registered by a company in FreightPOP application

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

EndPoint

Production Url: https://enterprise.freightpop.com/lookup/getCompanyAddresses?isDefault=true

Sandbox Url: https://sandbox-api.freightpop.com/lookup/getCompanyAddresses?isDefault=true

Request Information

URI Parameters

NameDescriptionTypeAdditional information
isDefault

boolean
Required
page

integer
Default value is 1
pageSize

integer
Default value is 10

Body Parameters

None.

Response Information

Resource Description

List of company Addresses

CompanyAddressesResponse
NameDescriptionTypeAdditional information
Data

Addresses object for Addresses details

CompanyAddressesResponseDto

None.

Code

Response code returned by api

HttpStatusCode

None.

Message

Human readable message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "CompanyAddresses": [
      {
        "Id": 1,
        "Identifier": "sample string 2",
        "CompanyName": "sample string 3",
        "Street1": "sample string 4",
        "Zip": "sample string 5",
        "IsDefault": true
      },
      {
        "Id": 1,
        "Identifier": "sample string 2",
        "CompanyName": "sample string 3",
        "Street1": "sample string 4",
        "Zip": "sample string 5",
        "IsDefault": true
      }
    ],
    "TotalCount": 1,
    "TotalPages": 2
  },
  "Code": 100,
  "Message": "sample string 1"
}