Retrieve your supplier information to view contact details, addresses, and other vendor information. Use the list endpoint to see all suppliers, or get a specific supplier by ID for detailed information.
Use the GET method with /v2/suppliers to retrieve a paginated list of all your suppliers.
| Query Parameter | Type | Description |
|---|---|---|
supplier_name | string | Filter by supplier name (partial match, case-insensitive) |
page_size | integer | Number of results per page (default: 50, minimum: 1, maximum: 500) |
The response includes a suppliers array with the following properties for each supplier:
| Property | Type | Description |
|---|---|---|
supplier_id | string | Unique identifier for the supplier |
supplier_name | string | Name of the supplier company |
supplier_email | string (email) | Email address for purchase order notifications |
address_line_1 | string | First line of supplier's address |
address_line_2 | string | Second line of supplier's address (suite, unit, etc.) |
city | string | City |
state | string | State or province |
postal_code | string | Postal or ZIP code |
country_code | string | ISO 3166-1 alpha-2 country code (e.g., "US", "CA", "GB") |
contact_name | string | Name of the primary contact person |
contact_phone | string | Phone number for the contact person |
The response also includes pagination metadata: total and links. The cursor for the next page is embedded in the links.next.href URL.
GET /v2/suppliers
- Productionhttps://api.shipstation.com/v2/suppliers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.shipstation.com/v2/suppliers?supplier_name=string&page_size=50' \
-H 'api-key: YOUR_API_KEY_HERE'Use the GET method with /v2/suppliers/{supplier_id} to retrieve detailed information about a specific supplier.
| Parameter | Type | Description |
|---|---|---|
supplier_id | string | The unique identifier of the supplier |
Returns a single supplier object with all the properties listed in the table above.
GET /v2/suppliers/{supplier_id}
- Productionhttps://api.shipstation.com/v2/suppliers/{supplier_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api.shipstation.com/v2/suppliers/se-567 \
-H 'api-key: YOUR_API_KEY_HERE'Use the supplier_name query parameter to filter suppliers by name. The search performs a partial, case-insensitive match:
GET /v2/suppliers?supplier_name=AcmeThis returns all suppliers whose name contains "Acme" (e.g., "Acme Widgets Inc", "Acme Supply Co", "Best Acme Parts").
Find suppliers with "Widget" in the name:
GET /v2/suppliers?supplier_name=WidgetFind suppliers and paginate results:
GET /v2/suppliers?supplier_name=Supply&page_size=25Get next page using cursor from response links:
GET /v2/suppliers?cursor=eyJQYWdlIjoyLCJQYWdlU2l6ZSI6MjUsIlN1cHBsaWVyTmFtZSI6IlN1cHBseSJ9&page_size=25List all suppliers (no filter):
GET /v2/suppliers?page_size=100- First page: Make request without
cursorparameter - Next page: Use the
cursorvalue fromlinks.next.hrefin the response - Page size: Control number of results with
page_size(default: 50, max: 500) - End of results: When
links.nextis null, you've reached the last page
- Partial matching: The search matches any part of the supplier name
- Case-insensitive: "acme", "ACME", and "Acme" all return the same results
- Exact matches: For exact matching, filter results in your application code after retrieval
- Create Suppliers - Add new supplier information
- Update Suppliers - Modify existing supplier information
- Create Purchase Orders - Use supplier_id to create orders
- List Purchase Orders - Find orders by supplier