Class ProductsResource

Hierarchy

  • Resource
    • ProductsResource

Constructors

constructor

Methods

catalogs create createCatalog iterate list

Constructors

constructor

Methods

catalogs

  • catalogs(
        idOrganization: string,
        idAccount: string,
        options?: PageOptions & RequestOptions,
    ): Promise<
        Paginated<
            {
                default_image_url?: string;
                feed_count?: number;
                id?: string;
                is_catalog_segment?: boolean;
                is_local_catalog?: boolean;
                name?: string;
                product_count?: number;
            } & { [key: string]: unknown },
        >,
    >

    Los catálogos de la cuenta. Es de donde sale el idCatalog de todo lo demás.

    total es la longitud de la página, así que nunca dice que haya otra.

    Parameters

    Returns Promise<
        Paginated<
            {
                default_image_url?: string;
                feed_count?: number;
                id?: string;
                is_catalog_segment?: boolean;
                is_local_catalog?: boolean;
                name?: string;
                product_count?: number;
            } & { [key: string]: unknown },
        >,
    >

create

  • create(
        idOrganization: string,
        idAccount: string,
        idCatalog: string,
        product: {
            additional_image_urls?: string[];
            availability?:
                | "pending"
                | "in stock"
                | "out of stock"
                | "preorder"
                | "available for order"
                | "discontinued"
                | "mark_as_sold";
            brand?: string;
            category?: string;
            color?: string;
            condition?: | "new"
            | "refurbished"
            | "used"
            | "used_like_new"
            | "used_good"
            | "used_fair"
            | "cpo"
            | "open_box_new";
            currency: string;
            description?: string;
            id?: string;
            image_url: string;
            name: string;
            price: number;
            retailer_id: string;
            url?: string;
        } & { [key: string]: unknown },
        options?: RequestOptions,
    ): Promise<string>

    Da de alta un producto en un catálogo, o actualiza uno existente si el cuerpo trae id. Devuelve el identificador en la red, no el producto.

    Parameters

    • idOrganization: string
    • idAccount: string
    • idCatalog: string
    • product: {
          additional_image_urls?: string[];
          availability?:
              | "pending"
              | "in stock"
              | "out of stock"
              | "preorder"
              | "available for order"
              | "discontinued"
              | "mark_as_sold";
          brand?: string;
          category?: string;
          color?: string;
          condition?: | "new"
          | "refurbished"
          | "used"
          | "used_like_new"
          | "used_good"
          | "used_fair"
          | "cpo"
          | "open_box_new";
          currency: string;
          description?: string;
          id?: string;
          image_url: string;
          name: string;
          price: number;
          retailer_id: string;
          url?: string;
      } & { [key: string]: unknown }
      • Optionaladditional_image_urls?: string[]
      • Optionalavailability?:
            | "pending"
            | "in stock"
            | "out of stock"
            | "preorder"
            | "available for order"
            | "discontinued"
            | "mark_as_sold"
      • Optionalbrand?: string
      • Optionalcategory?: string
      • Optionalcolor?: string
      • Optionalcondition?:
            | "new"
            | "refurbished"
            | "used"
            | "used_like_new"
            | "used_good"
            | "used_fair"
            | "cpo"
            | "open_box_new"
      • currency: string

        Description

        ISO 4217 code, for example EUR.

      • Optionaldescription?: string
      • Optionalid?: string

        Description

        Send it to update an existing product. Leave it out to create one.

      • image_url: string
      • name: string
      • price: number

        Description

        In cents of currency. 1250 is 12,50.

      • retailer_id: string

        Description

        Your identifier for the product. It is what ties the Meta catalogue to your system.

      • Optionalurl?: string

        Description

        The product's page on your site.

      • [key: string]: unknown
    • options: RequestOptions = {}

    Returns Promise<string>

createCatalog

  • createCatalog(
        idOrganization: string,
        idAccount: string,
        catalog: { name: string },
        options?: RequestOptions,
    ): Promise<string>

    Crea un catálogo y devuelve su identificador, no el catálogo.

    El campo de la respuesta se llama product_catalog y lleva una cadena; para ver el resto hay que volver a pedir catalogs.

    Parameters

    • idOrganization: string
    • idAccount: string
    • catalog: { name: string }
    • options: RequestOptions = {}

    Returns Promise<string>

iterate

  • iterate(
        idOrganization: string,
        idAccount: string,
        idCatalog: string,
        options?: PageOptions & RequestOptions,
    ): AsyncGenerator<
        {
            additional_image_urls?: string[];
            availability?: | "pending"
            | "in stock"
            | "out of stock"
            | "preorder"
            | "available for order"
            | "discontinued"
            | "mark_as_sold";
            brand?: string;
            category?: string;
            color?: string;
            condition?: | "new"
            | "refurbished"
            | "used"
            | "used_like_new"
            | "used_good"
            | "used_fair"
            | "cpo"
            | "open_box_new";
            currency: string;
            description?: string;
            id?: string;
            image_url: string;
            name: string;
            price: number;
            retailer_id: string;
            url?: string;
        } & { [key: string]: unknown },
    >

    Los productos de un catálogo, encadenando páginas.

    Corta cuando llega una página más corta que el limit, no cuando llega a total: en esta lista total vale 0 siempre.

    Parameters

    Returns AsyncGenerator<
        {
            additional_image_urls?: string[];
            availability?: | "pending"
            | "in stock"
            | "out of stock"
            | "preorder"
            | "available for order"
            | "discontinued"
            | "mark_as_sold";
            brand?: string;
            category?: string;
            color?: string;
            condition?: | "new"
            | "refurbished"
            | "used"
            | "used_like_new"
            | "used_good"
            | "used_fair"
            | "cpo"
            | "open_box_new";
            currency: string;
            description?: string;
            id?: string;
            image_url: string;
            name: string;
            price: number;
            retailer_id: string;
            url?: string;
        } & { [key: string]: unknown },
    >

list

  • list(
        idOrganization: string,
        idAccount: string,
        idCatalog: string,
        options?: PageOptions & RequestOptions,
    ): Promise<
        Paginated<
            {
                additional_image_urls?: string[];
                availability?: | "pending"
                | "in stock"
                | "out of stock"
                | "preorder"
                | "available for order"
                | "discontinued"
                | "mark_as_sold";
                brand?: string;
                category?: string;
                color?: string;
                condition?: | "new"
                | "refurbished"
                | "used"
                | "used_like_new"
                | "used_good"
                | "used_fair"
                | "cpo"
                | "open_box_new";
                currency: string;
                description?: string;
                id?: string;
                image_url: string;
                name: string;
                price: number;
                retailer_id: string;
                url?: string;
            } & { [key: string]: unknown },
        >,
    >

    Los productos de un catálogo.

    idCatalog es obligatorio de hecho aunque la API lo pinte opcional: sin él la petición falla con el error 2000. Hay un product_id documentado para pedir uno suelto que no funciona — el servidor lo reenvía con un nombre que el SDK no lee—, así que no se expone aquí.

    const { data } = await pv.products.list(orgId, accountId, catalogId, { limit: 50 });

    Parameters

    Returns Promise<
        Paginated<
            {
                additional_image_urls?: string[];
                availability?: | "pending"
                | "in stock"
                | "out of stock"
                | "preorder"
                | "available for order"
                | "discontinued"
                | "mark_as_sold";
                brand?: string;
                category?: string;
                color?: string;
                condition?: | "new"
                | "refurbished"
                | "used"
                | "used_like_new"
                | "used_good"
                | "used_fair"
                | "cpo"
                | "open_box_new";
                currency: string;
                description?: string;
                id?: string;
                image_url: string;
                name: string;
                price: number;
                retailer_id: string;
                url?: string;
            } & { [key: string]: unknown },
        >,
    >

Settings

Member Visibility

On This Page

Constructors
Methods