Show Supplier
GET/api/v2/suppliers/:supplier
Returns a single supplier. The response includes the supplier's address, default payment term, default shipping method, default incoterm, and warehouses (each with its address) by default.
suppliers:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Use the with query parameter (comma-separated) to include additional relations: pricingTiers (also aliased as pricing), defaultStore, defaultIncoterm, wireInstructionsVerifiedBy, customFieldValues. Passing customFieldValues adds custom_field_values to the response — each stored custom-field value with its field metadata (custom_field_id, name, slug, field_type, options, description, is_visible_in_details). Pass bill_stats to include bill activity statistics for the supplier.
Include last_po_destination in the with parameter to receive last_po_destination_warehouse_id — the destination warehouse of the supplier's most recent purchase order (null when the supplier has none). Useful for defaulting the destination of a new PO.
Include compliance_status in the with parameter to receive the supplier's compliance posture against the certificate types it is required to keep current: required, missing and expired (arrays of document type values) plus is_complete. A supplier that is missing a required certificate, or holding one whose expiry date has passed, reports is_complete: false. The key is OMITTED entirely when the include is not requested — absent means "not evaluated", which is not the same as compliant. Compliance is advisory: it never blocks a purchase order.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.