VendorAddresses
Get the list of Vendor Addresses
Path
GET /odata/VendorAddresses
Description
Returns the list of Vendor Addresses within a logged organization. You can filter the results by the strict match using the $filter parameter–entity eq ‘string’. Or filter the results by the partial match using $filter=contains parameter–contains(entity, ‘string’).
Request parameters
Parameter |
Explanation |
|---|---|
| includeInactiveVendors boolean default: false in query |
Include inactive Vendors. |
| includeInactiveFacilities boolean default: false in query |
Include inactive Facilities. |
| api-version: string default: 1.0 in header |
The requested API version. |
| $filter: string in query |
Restricts the set of items returned. The maximum number of expressions is 100. |
| $orderby: string in query |
Specifies the order in which items are returned. The maximum number of expressions is 5. |
| $search: string in query |
Picks the value in all possible fields. |
| $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 |
|---|---|
| vendorAddressId: string (uuid) | Unique Identifier of the Vendor Address |
| vendorId: string (uuid) | Unique Identifier of the Vendor |
| vendorNo: string | Code of the Supplier who sells products |
| vendorName: string | Name of the Vendor |
| facilityId: string (uuid) | Unique Identifier of the Facility |
| facilityNo: string | Identification Number of the Facility |
| facilityName: string | Name of the Facility |
| description: string | Description of the Vendor Address |
| address: 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 |
| url: string | URL |
| dateAdded: string (date-time) | Date when the Vendor Address was added |
| addedBy: string (uuid) | Unique Identifier of the user who added the Vendor Address |
| addedByName: string | Name of the user who added the Vendor Address |
| lastUpdated: string (date-time) | Last Date when the Vendor Address was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Vendor Address |
| lastUpdatedByName: string | Name of the last user who updated the Vendor Address |
| activeStatus: boolean | Is the Status of the Vendor Address active or not? |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"items": [
{
"vendorAddressId": "00000000-0000-0000-0000-000000000000",
"vendorId": "00000000-0000-0000-0000-000000000000",
"vendorNo": "string",
"vendorName": "string",
"facilityId": "00000000-0000-0000-0000-000000000000",
"facilityNo": "string",
"facilityName": "string",
"description": "string",
"address": "string",
"address2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"url": "string",
"dateAdded": "string (date-time)",
"addedBy": "00000000-0000-0000-0000-000000000000",
"addeddByName": "string",
"lastUpdated": "string (date-time)",
"lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
"lastUpdatedByName": "string",
"activeStatus": "boolean"
}
],
"nextPageLink": "string",
"count": "integer (int64)"
}
Create a new Vendor Address
Path
POST /odata/Vendors({VendorId})/VendorAddresses
Description
Creates a new Vendor Address within a logged organization and a specified Vendor only for active Vendors and active Facilities.
Request body
Parameter |
Explanation |
|---|---|
| description: string required |
Description of the Vendor Address |
| facilityId: string (uuid) required |
Unique Identifier of the Facility |
| address: string required |
The first Address for shipping or billing purposes |
| address2: string | The second Address for shipping or billing purposes |
| city: string required |
City |
| state: string required |
State |
| zip: string required |
Zip |
| country: string | Country |
| url: string | URL |
Request Content-types: APPLICATION/JSON, APPLICATION/XML
Request Example
Request Example
{
"description": "string",
"facilityId": "00000000-0000-0000-0000-000000000000",
"address": "string",
"address2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"url": "string"
}
Request parameters
Parameter |
Explanation |
|---|---|
| vendorId: string (uuid) required in path |
Enter the ID of the Vendor here. |
| api-version: string default: 1.0 in header |
The requested API version. |
| 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. |
| 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. |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response Example (200 OK)
Response Example (200 OK)
"00000000-0000-0000-0000-000000000000"
Get the specified Vendor Address
Path
GET /odata/VendorAddresses({vendorAddressId})
Description
Returns the details of the Vendor Address specified by ID within a logged organization.
Request parameters
Parameter |
Explanation |
|---|---|
| includeInactiveVendors boolean default: false in query |
Include inactive Vendors. |
| includeInactiveFacilities boolean default: false in query |
Include inactive Facilities. |
| vendorAddressId: string (uuid) required in path |
Enter the ID of the Vendor Address here. |
| api-version: string default: 1.0 in header |
The requested API version. |
| 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. |
| 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 |
|---|---|
| vendorAddressId: string (uuid) | Unique Identifier of the Vendor Address |
| vendorId: string (uuid) | Unique Identifier of the Vendor |
| vendorNo: string | Code of the Supplier who sells products |
| vendorName: string | Name of the Vendor |
| facilityId: string (uuid) | Unique Identifier of the Facility |
| facilityNo: string | Identification Number of the Facility |
| facilityName: string | Name of the Facility |
| description: string | Description of the Vendor Address |
| address: 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 |
| url: string | URL |
| dateAdded: string (date-time) | Date when the Vendor Address was added |
| addedBy: string (uuid) | Unique Identifier of the user who added the Vendor Address |
| addedByName: string | Name of the user who added the Vendor Address |
| lastUpdated: string (date-time) | Last Date when the Vendor Address was updated |
| lastUpdatedBy: string (uuid) | Unique Identifier of the last user who updated the Vendor Address |
| lastUpdatedByName: string | Name of the last user who updated the Vendor Address |
| activeStatus: boolean | Is the Status of the Vendor Address active or not? |
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
Response example (200 OK)
{
"vendorAddressId": "00000000-0000-0000-0000-000000000000",
"vendorId": "00000000-0000-0000-0000-000000000000",
"vendorNo": "string",
"vendorName": "string",
"facilityId": "00000000-0000-0000-0000-000000000000",
"facilityNo": "string",
"facilityName": "string",
"description": "string",
"address": "string",
"address2": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string",
"url": "string",
"dateAdded": "string (date-time)",
"addedBy": "00000000-0000-0000-0000-000000000000",
"addeddByName": "string",
"lastUpdated": "string (date-time)",
"lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
"lastUpdatedByName": "string",
"activeStatus": "boolean"
}