Sellers
Use the Certificate Center API to retrieve a list of sellers.
Base URL:
https://ccservices.vertexsmb.com/certificate-center/v1/
Sellers endpoint | Sellers description |
---|---|
/sellers | GET - Retrieves a list of sellers based on filter criteria, pagination, and sorting parameters. |
Retrieve taxability drivers
Retrieve a list of seller records based on your choice of filter criteria.
Request
All request parameters are optional. Passing a request with no parameters returns all available records.
Retrieve taxability drivers request parameter name | Retrieve taxability drivers request format | Retrieve taxability drivers request description |
---|---|---|
top | int64 | Number of returned records to display per page. Default = 20. |
skip | int64 | Number of records to skip before displaying records. Must be 0 or greater. Default = 0. |
filter | string | Limit the returned records to those including the filter criteria, such as customer name or taxpayer name. |
count | Boolean | If set to true, returns a count of the total records found. Default = false. |
orderBy | string | Order the results according to any response field by entering it here. Results are in alphabetical or numerical order depending on the field format. |
Example request
curl --request GET \
--url https://vertex-enterprise-group.readme.io/certificate-center/v1/sellers \
--header 'accept: application/json'
Response
A response includes any number of seller records. Each seller record can include some or all of these fields.
Retrieve taxability drivers response field | Retrieve taxability drivers response description |
---|---|
UUID | Unique identifier. |
code | Code assigned to the seller. |
name | Seller name. |
address | Seller address. |
city | Seller city. |
stateProvince | Seller state or province. |
postalCode | Seller postal code. |
country | Note about the seller. |
taxpayer | Taxpayer associated with this seller. The taxpayer field includes UUID, code, and name. |
contact | Contact associated with this seller. The contact field includes UUID, name, and email. |
Example response
{
"odata.count": 0,
"value": [
{
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"name": "string",
"address": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"country": "string",
"taxpayer": {
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"name": "string"
},
"contact": {
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"email": "[email protected]"
}
}
]
}
Updated 18 days ago
What’s Next