Interface ProductResponse<CustomFields, AttributeCustomFields, ProductVariantCustomFields>

A product on the product service Note: Attributes, Catalogs, Organizations and Variants are always expanded on the response, as the chance of them being needed is high

interface ProductResponse {
    additionalInformation?: string;
    addressLine1?: string;
    addressLine2?: string;
    addressLine3?: string;
    attributes: (AttributeResponse<AttributeCustomFields> & {
        value: string | number | boolean | string[];
    })[];
    category: null | CategoryResponse;
    categoryId: string;
    createdAt: string;
    customFields: CustomFields;
    description: string;
    dimensions?: string;
    features: {
        name: string;
        value: string;
    }[];
    geoCoordinatesField: {
        coordinates: [number, number];
        type: string;
    };
    id: string;
    images: {
        url: string;
    }[];
    isPromoted: boolean;
    name: string;
    organization: null | OrganizationBase<unknown>;
    organizationId: string;
    postalCode?: string;
    publication: ProductPublication;
    tags: string[];
    updatedAt: string;
    variantNote?: string;
    variants: ProductVariantResponse<ProductVariantCustomFields>[];
}

Type Parameters

  • CustomFields = unknown

  • AttributeCustomFields = unknown

  • ProductVariantCustomFields = unknown

Properties

additionalInformation? addressLine1? addressLine2? addressLine3? attributes category categoryId createdAt customFields description dimensions? features geoCoordinatesField id images isPromoted name organization organizationId postalCode? publication tags updatedAt variantNote? variants

Properties

Optional additionalInformation

additionalInformation?: string

Misc additional information

Optional addressLine1

addressLine1?: string

The first line of the address for this product

Optional addressLine2

addressLine2?: string

The second line of the address for this product

Optional addressLine3

addressLine3?: string

The third line of the address for this product

attributes

attributes: (AttributeResponse<AttributeCustomFields> & {
    value: string | number | boolean | string[];
})[]

Array of expanded attributes and their values for this product

category

category: null | CategoryResponse

The category this product is in (null if not present)

categoryId

categoryId: string

The id of the category this product is in

createdAt

createdAt: string

ISO date time string - when the product was created

customFields

customFields: CustomFields

The custom fields for this product

description

description: string

The description of the product

Optional dimensions

dimensions?: string

The dimensions of the product

features

features: {
    name: string;
    value: string;
}[]

The features of the product

Type declaration

  • name: string
  • value: string

geoCoordinatesField

geoCoordinatesField: {
    coordinates: [number, number];
    type: string;
}

The 2D coordinates for this product

Type declaration

  • coordinates: [number, number]
  • type: string

id

id: string

The unique identifier for this product

images

images: {
    url: string;
}[]

The expanded images for this product

Type declaration

  • url: string

isPromoted

isPromoted: boolean

Whether the product has been promoted

name

name: string

The name of the product

organization

organization: null | OrganizationBase<unknown>

The organization the product belongs to

organizationId

organizationId: string

The id of the organization this product belongs to

Optional postalCode

postalCode?: string

The postal code for this product

publication

publication: ProductPublication

The publication info for this product

tags

tags: string[]

List of arbitrary tags for the product

updatedAt

updatedAt: string

ISO date time string - when the product was last updated

Optional variantNote

variantNote?: string

Arbitrary notes about variant information

variants

variants: ProductVariantResponse<ProductVariantCustomFields>[]

The list of variants for this product

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc