Skip to main content

Get Regular Good by id

GET 
/catalog/goods/regular/:good_id

Returns one regular good (catalog item) with its variations array. When the good has a single variation, that variation's name is null — use the good-level name for display. When there are multiple variations, each variation's name is non-null.

Request​

Path Parameters

    good_id uuidrequired

    Good (catalog item) identifier

Responses​

OK

Schema

    id uuidrequired

    Good identifier (same as catalog item id)

    name stringrequired

    Possible values: >= 2 characters and <= 128 characters

    description stringnullable

    Possible values: >= 2 characters and <= 1024 characters

    external_data

    object

    nullable

    External system reference data linked to this entity.

    id stringrequired

    Possible values: >= 4 characters and <= 128 characters

    Unique identifier in the external system

    property name* any

    External system reference data linked to this entity.

    status GoodStatusPublicDTO (string)required

    Possible values: [active, inactive, unknown]

    Good lifecycle status

    category_id uuidnullable
    business_type RegularGoodBusinessTypePublicDTO (string)required

    Possible values: [regular]

    Business type for goods returned from /catalog/goods/regular. The API always returns regular on this surface.

    uom

    object

    required

    Unit of measure

    id uuidrequired

    UOM identifier; matches uom_id in good

    name stringrequired

    Possible values: >= 2 characters and <= 32 characters

    Full name

    symbol stringrequired

    Possible values: non-empty and <= 16 characters

    Short display label

    exponent integerrequired

    Possible values: <= 3

    Decimal exponent (e.g. 3 means quantities are in thousandths)

    vat

    object

    required

    VAT fee item for the good (all variations share the same item). Values align with the matching entry in GET /fees → fee_items[] for fee_item_id.

    fee_item_id uuidrequired

    Fee item identifier; matches id in fee_items[].

    fee_item_name stringrequired

    Possible values: >= 2 characters and <= 64 characters

    Fee item display name (e.g. tax rate label).

    fee_item_percentage double

    Possible values: <= 100

    Tax rate in percent (decimal, e.g. 5 or 5.25). Omitted when the fee item is exempt or non-percentage.

    variations

    object[]

    required

    Possible values: >= 1, <= 150

    Sellable variations of the good.

  • Array [

    • id uuidrequired

    Variation identifier

    name stringnullable

    Possible values: <= 128 characters

    Variation display name; null when this is the only variation on the good.

    description stringnullable

    Possible values: >= 2 characters and <= 1024 characters

    external_data

    object

    nullable

    External system reference data linked to this entity.

    id stringrequired

    Possible values: >= 4 characters and <= 128 characters

    Unique identifier in the external system

    property name* any

    External system reference data linked to this entity.

    status PublicVariationStatuses (string)required

    Possible values: [active, inactive]

    Variation lifecycle status for public responses

    default_price

    object

    Price (amount + currency). Is used to represent monetary amounts in various currencies. The minimum value includes 0.

    value int64required

    Amount in minimum currency units

    currency_code stringrequired

    ISO 4217 currency code. Available values: AED

    image_url stringnullable

    Possible values: <= 2048 characters

    Link to variation image when available.

    codes

    object[]

    required

    Possible values: <= 20

  • Array [

    • type stringrequired

    Possible values: [ean_8, ean_13, itf_14, upc_a, sku, other]

    Type of code; use other when the value does not map to a listed barcode or SKU kind.

    value stringrequired

    Possible values: >= 4 characters and <= 128 characters

  • ]

  • ]

Loading...