Skip to content

Addresses

Get the list of Addresses

Path

GET /odata/Addresses

Description

Returns a paged list of existing Addresses within the logged-in organization.

Note

You can filter the results as follows:

  • For an exact match, use: $filter parameter–entity eq ‘string’
  • For a partial match, use: $filter=contains parameter–contains(entity, ‘string’)

Request parameters

Parameter
Explanation
api-version: string default: 1.0
in header		 The requested API version.
$search: string
in query		 Picks the value in all possible fields.
$filter: string
in query		 Filters the results, based on the Boolean condition.
$orderby: string
in query		 Sorts the results.
$top: string
in query		 Returns only the first n results.
$skip: string
in query		 Skips the first n results.
Authorization: string default:
Bearer access_token
in header		 Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication.

Responses

Response
Explanation
200 OK OK
400 Bad Request Incorrect input data or organization ID does not match with the organization ID user is logged in.
400 Bad Request The limit for the $top query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here.
401 Unauthorized Incorrect specified access_token or access_token got expired.
403 Forbidden User doesn’t have appropriate privileges.
500 Internal Server Error Server encountered an unexpected condition that prevented it from fulfilling the request.

Properties

Property
Explanation
addressId: string (uuid) Unique Identifier of the Address
organizationId: string (uuid) Unique Identifier of the Organization
organizationNo: string Identification Number of the Organization
organizationName: string Name of the Organization
addressNo: string Identification Number of the Address
addressName: string Name of the Address
addressTypeId: integer (int32) Unique Identifier of the Address Type
addressType: string Address where to send the invoices (Billing) or products (Shipping)
facilityId: string (uuid) Unique Identifier of the Facility
facilityNo: string Identification Number of the Facility
facilityName: string Name of the Facility
addressDescription: string Description of the Address
address1: string The first Address for shipping or billing purposes
address2: string The second Address for shipping or billing purposes
city: string City
state: string State
zip: string Zip
country: string Country
contactName: string Name of the main contact point
contactEmail: string Email of the main contact point
phone: string Phone of main the contact point
phoneExt: string Phone Extension of the main contact point
fax: string Fax of the main contact point
isDefaultAddress: boolean Is the Address default or not?
activeStatus: boolean Is the Status of the Address active or not?
dateCreated: string (date-time) Date when the Address was created
createdBy: string (uuid) Unique Identifier of the user who created the Address
createdByName: string Name of the user who created the Address
lastUpdated: string (date-time) Last Date when the Address was updated
lastUpdatedBy: string (uuid) Unique Identifier of the last user who updated the Address
lastUpdatedByName: string Name of the last user who updated the Address
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response Example (200 OK)
{
    "@odata.context": "link",
    "@odata.count": "number",
    "value": [
        {
            "addressId": "00000000-0000-0000-0000-000000000000",
            "organizationId": "00000000-0000-0000-0000-000000000000",
            "organizationNo": "string",
            "organizationName": "string",
            "addressNo": "string",
            "addressName": "string",
            "addressTypeId": "integer (int32)",
            "addressType": "string",
            "facilityId": "00000000-0000-0000-0000-000000000000",
            "facilityNo": "string",
            "facilityName": "string",
            "addressDescription": "string",
            "address1": "string",
            "address2": "string",
            "city": "string",
            "state": "string",
            "zip": "string",
            "country": "string",
            "contactName": "string",
            "contactEmail": "string",
            "phone": "string",
            "phoneExt": "string",
            "fax": "string",
            "isDefaultAddress": "boolean",
            "activeStatus": "boolean",
            "dateCreated": "string (date-time)",
            "createdBy": "00000000-0000-0000-0000-000000000000",
            "createdByName": "string",
            "lastUpdated": "string (date-time)",
            "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
            "lastUpdatedByName": "string"

        }
    ],
    "@odata.nextLink": "link"
}

Get the specified Address

Path

GET /odata/Addresses({addressId})

Description

Returns the details of the Address specified by ID.

Request parameters

Parameter
Explanation
addressId: string (uuid)
required
in path		 Enter the ID of the Address here.
api-version: string default: 1.0
in header		 The requested API version.
Authorization: string dafault:
Bearer access_token
in header		 Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication.

Responses

Response
Explanation
200 OK OK
400 Bad Request Incorrect input data or organization ID does not match with the organization ID user is logged in.
401 Unauthorized Incorrect specified access_token or access_token got expired.
403 Forbidden User doesn’t have appropriate privileges.
404 Not Found Specified ID is absent in the system.
500 Internal Server Error Server encountered an unexpected condition that prevented it from fulfilling the request.

Properties

Property
Explanation
addressId: string (uuid) Unique Identifier of the Address
organizationId: string (uuid) Unique Identifier of the Organization
organizationNo: string Identification Number of the Organization
organizationName: string Name of the Organization
addressNo: string Identification Number of the Address
addressName: string Name of the Address
addressTypeId: integer (int32) Unique Identifier of the Address Type
addressType: string Address where to send the invoices (Billing) or products (Shipping)
facilityId: string (uuid) Unique Identifier of the Facility
facilityNo: string Identification Number of the Facility
facilityName: string Name of the Facility
addressDescription: string Description of the Address
address1: string The first Address for shipping or billing purposes
address2: string The second Address for shipping or billing purposes
city: string City
state: string State
zip: string Zip
country: string Country
contactName: string Name of the main contact point
contactEmail: string Email of the main contact point
phone: string Phone of the main contact point
phoneExt: string Phone Extension of the main contact point
fax: string Fax of the main contact point
isDefaultAddress: boolean Is the Address default or not?
activeStatus: boolean Is the Status of the Address active or not?
dateCreated: string (date-time) Date when the Address was created
createdBy: string (uuid) Unique Identifier of the user who created the Address
createdByName: string Name of the user who created the Address
lastUpdated: string (date-time) Last Date when the Address was updated
lastUpdatedBy: string (uuid) Unique Identifier of the last user who updated the Address
lastUpdatedByName: string Name of the last user who updated the Address
Response content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
{
    "@odata.context": "link",
    "addressId": "00000000-0000-0000-0000-000000000000",
    "organizationId": "00000000-0000-0000-0000-000000000000",
    "organizationNo": "string",
    "organizationName": "string",
    "addressNo": "string",
    "addressName": "string",
    "addressTypeId": "integer (int32)",
    "addressType": "string",
    "facilityId": "00000000-0000-0000-0000-000000000000",
    "facilityNo": "string",
    "facilityName": "string",
    "addressDescription": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "contactName": "string",
    "contactEmail": "string",
    "phone": "string",
    "phoneExt": "string",
    "fax": "string",
    "isDefaultAddress": "boolean",
    "activeStatus": "boolean",
    "dateCreated": "string (date-time)",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "createdByName": "string",
    "lastUpdated": "string (date-time)",
    "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
    "lastUpdatedByName": "string"
}