Fetches the details of a Supplier by supplier id from the external/ERP system. For calling the API, you will need the external-supplier-id.
Request URI
GET https://api.appzen.com/dictionary-data-services/
supplier/external-supplier-id/{{external-supplier-id}}
Header Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| x-api-key | String | The x-api-key provided to authorize the request. | Yes |
| customer-id | String | The Customer ID provided to authorize the request. | Yes |
| customer-key | String | The Customer Key provided to authorize the request. | Yes |
Path Parameters
| Name | Type | Description | Required |
|---|---|---|---|
|
external-supplier-id |
String |
The Supplier id from your System. |
Yes |
Sample Request
curl -X GET "https://api.appzen.com/dictionary-data-services/supplier/external-supplier-id/erpSupplier1"
-H "accept: application/json"
-H "x-api-key: R7wsFxxxx"
-H "customer-id: 1004xxxx"
-H "customer-key: 15d1xxxx"
Sample Response
Success
{
"addresses": [
{
"address_type": "REMIT_TO",
"address": {
"address_line1": "12345 MARKET STREET",
"address_line2": "SUITE 1234",
"address_line3": "",
"area_code": "415",
"city": "SAN FRANCISCO",
"company": "Preferred Supplier Inc.",
"contact": "Jane Doe",
"country": "US",
"country_iso3": "USA",
"email": "janedoe@supplier.com",
"phone": "4042965282",
"province": "",
"state": "CA",
"zip": "94016"
},
"site_id": "913838",
"site_name": "California HQ",
"custom_json": {
"key1": "value1"
},
"is_active": true,
"valid_start_date": "2020-11-01T11:01:00Z",
"valid_end_date": "2020-11-01T11:01:00Z"
}
],
"bank_information": {
"bank_account_name": "ABC Bank",
"bank_account_type": "Checking",
"bank_acct_last4": "8674",
"routing_number_last4": "string"
},
"contacts": [
{
"email": "john.doe@abc.com",
"external_contact_id": "4266477",
"first_name": "John",
"last_name": "Doe",
"phone_number": "4081234567"
}
],
"customer_id": "488059",
"payment_term_id": "652402",
"supplier_core": {
"deactive_date": "2020-11-01T11:01:00Z",
"deactived_by": "JOHN.DOE@ABC.COM",
"external_supplier_id": "691759",
"fed_tax_id": "GI19E",
"is_active": true,
"valid_start_date": "2020-11-01T11:01:00Z",
"valid_end_date": "2020-11-01T11:01:00Z",
"note": "Category A Supplier",
"on_file_1099": "3DMWWFF",
"supplier_name": "ABC Suppliers Inc.",
"supplier_number": "MZ342F1",
"vat_registration_number": "D08J66",
"web_site": "abcsuppliers.com"
},
"custom_json": {
"key1": "value1"
},
"uuid": "6731fb82-2e69-4d0e-a71b-4b1576dad163"
}
Failure
The request fails if you enter an invalid URL.
{
"timestamp": "2023-01-15T16:12:45.977+0000",
"status": 404,
"error": "Not Found",
"message": "Error code : 17e3338d - The resource you specified cannot be not found"
}
Response Code
| Response Code | Description |
| 200 | The request is successful. |
|
400 |
The request failed due to a malformed request syntax. Check the requested URL, including the parameters. |
| 401 |
The request failed due to an authorization issue. For example, the Customer Key could be missing or invalid. |
| 403 |
The request failed due to a permission issue. The x-api key may not have permission to perform the request. |
| 404 |
The request failed as the resource is not found. Check the requested URL. |
| 500 |
The request failed due to an AppZen server issue. |
See Also
Comments
Article is closed for comments.