Get a product by ERP-supplied external_id

GET

/api/public/v1/products/by-external-id/{external_id}

Code sample: cURL

curl --request GET \
  --url 'https://api.getzutax.com/api/public/v1/products/by-external-id/erp-resource-001' \
  --header 'Authorization: Bearer <token>'

• Production API
• Staging API

Authorizations

• HTTPBearer

Parameters

Path Parameters

external_id

required

External Id

string

Responses

200

Successful Response

Media type application/json

ProductResponse

Stable response shape for public-API product endpoints.

The Product DB model uses default_unit_price (naira-denominated Numeric) and default_tax_rate (percentage stored 0-100, e.g. 7.5). The public-API surface exposes them as default_unit_price_naira and default_vat_rate (0-1 fractional rate) — a model validator rewrites the inbound attributes so ERPs see a consistent shape across all public-API resources.

object

id

required

Id

string format: uuid

external_id

required

Any of:

string

string

null

null

name

required

Name

string

description

Any of:

string

string

null

null

sku

Any of:

string

string

null

null

item_type

required

Item Type

string

Allowed values: good service

hsn_code

Any of:

string

string

null

null

product_category

Any of:

string

string

null

null

isic_code

Any of:

string

string

null

null

service_category

Any of:

string

string

null

null

default_unit_code

required

Default Unit Code

string

default_unit_price_naira

required

Default Unit Price Naira

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

default_tax_category_code

required

Default Tax Category Code

string

default_vat_rate

required

Default Vat Rate

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

is_active

required

Is Active

boolean

Examples

Example Sample response

200 response example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "external_id": "string",
  "name": "string",
  "description": "string",
  "sku": "string",
  "item_type": "good",
  "hsn_code": "string",
  "product_category": "string",
  "default_unit_code": "string",
  "default_unit_price_naira": "100.00",
  "default_tax_category_code": "string",
  "default_vat_rate": "100.00",
  "is_active": true
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Examples

Example Sample response

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}