Syntax
GET /api/suppliers/{id}/
Returns a JSON object that contains several core and custom fields for a supplier identified by its {id}. The user performing this request has to be authorized to View Suppliers.
Example:
GET /api/suppliers/20100/
Request Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| id | Number | Supplier identifier | GET /api/suppliers/20100/ will return all core and custom fields for the supplier 20100. |
Sample Response
An example JSON response can be seen here:
{
"id": 9631991,
"connection_status": {
"is_connected": true,
"connected_acct_has_company": true
},
"vendor_num": "777",
"site_code": "1",
"supplier_name": "Other",
"address_type": 0,
"address_pay_to": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"country": "US",
"zipcode": null,
"tin": "112233445",
"ts": "2023-01-26T12:18:41.867431-05:00",
"last_modified": "2023-01-26T12:22:12.691297-05:00",
"normalized_vendor_num": "777",
"contact_email": null,
"request_id": "19938",
"status": null,
"additional_field_1": null,
"additional_field_2": null,
"additional_field_3": null,
"additional_field_4": null,
"additional_field_5": null,
"bank_acct_num": null,
"bank_name": null,
"routing_num": null,
"name_on_acct": null,
"bank_country": null,
"payment_method": null,
"hashed_bank_acct_num": null,
"virtual_card_category": null,
"acct": 17075,
"acct_company": 15007
}
JSON Response Key/Value Explanations
| Key | Type | Sample Value | Description |
|---|---|---|---|
| id | Number | 20100 | |
| address_type | String | R | Type of address. Possible values are:
|
HTTP Response Codes
| Status Code | Description |
|---|---|
| 200 OK | The request was processed successfully. |
| 400 Bad Request | The request could not be understood by the server due to incorrect syntax. |
| 401 Unauthenticated | The request requires user authentication information. Your API token is missing or invalid. |
| 403 Forbidden | Permission Denied – User does not have permission to perform this request |
| 404 Not Found | The resource you requested on the server does not exist |
| 500 | The request has failed due to a temporary failure of the server. You can try this request at a later time. |
| 503 | The request has failed due to a temporary failure of the server. You can try this request at a later time. |
Calling the API
Postman
Call Syntax:
{
"name": "get_one_supplier",
"request": {
"auth": {
"type": "apikey",
"apikey": {
"value": "Token 500a3XXXXXXXXXXXXXXXXXXXXXb1cf",
"key": "Authorization"
}
},
"method": "GET",
"header": [],
"url": "https://sandbox.paymentworks.com/api/suppliers/7049117/"
},
"response": []
}
Sample PostMan call:
cURL
Python
