/ 
Regru-API-0.053
River stage zero No dependents
/ Regru::API::Shop

NAME

Regru::API::Shop - REG.API v2 domain shop management functions

VERSION

version 0.053

DESCRIPTION

REG.API domain shop management.

ATTRIBUTES

namespace

Always returns the name of category: shop. For internal uses only.

REG.API METHODS

nop

For testing purposes. Scope: clients. Typical usage:

$resp = $client->shop->nop;

Returns success response.

More info at Shop management: nop.

add_lot

Puts one or more lots to domain shop.

Scope clients. Typical usage:

$resp = $client->shop->add_lot(
    description                 => 'great deal: two by one!',
    category_ids                => [qw( 10 15 )],
    rent                        => 0,
    keywords                    => [qw( foo bar baz )],
    price                       => 200,
    lots                        => [
        { price => 201, rent_price => 0, dname => 'foo.com' },
        { price => 203, rent_price => 0, dname => 'bar.net' },
    ],
    sold_with                   => '',
    deny_bids_lower_rejected    => 1,
    lot_price_type              => 'fixed',
);

Returns success response if lots was added or error otherwise.

More info at Shop management: add_lot.

update_lot

Updates a lot entry at domain shop.

Scope clients. Typical usage:

$resp = $client->shop->update_lot(
    dname                       => 'underwood.com',
    description                 => 'For the House of Cards fans only!',
    category_ids                => [qw( 4 10 )],
    rent                        => 0,
    keywords                    => [qw( spacey hoc vp potus )],
    price                       => 2000,
    sold_with                   => 'tm',
    deny_bids_lower_rejected    => 1,
    lot_price_type              => 'offer',
);

Returns success response if lots was updated or error otherwise.

More info at Shop management: update_lot.

delete_lot

Deletes the lots from domain shop.

Scope clients. Typical usage:

$resp = $client->shop->delete_lot(
    dname => [qw( foo.com bar.net )],
);

Returns success response if lots was deleted or error otherwise.

More info at Shop management: delete_lot.

get_info

Retrieves an information on the lot.

Scope clients. Typical usage:

$resp = $client->shop->get_info(
    dname => 'quux.ru',
);

Answer will contain the set of metrics (such as keywords, start_price, rent_price etc) for requested lot.

More info at Shop management: get_info.

get_lot_list

Retrieves a current list of lots.

Scope clients. Typical usage:

$resp = $client->shop->get_lot_list(
    show_my_lots    => 1,
    itemsonpage     => 25,
    pg              => 2,
);

Answer will contain a lots field with a list of lots and a lots_cnt pointed to total available items.

More info at Shop management: .

get_category_list

Retrieves a categories/subcategories list. Categories are divided into subcategories.

Scope clients. Typical usage:

$resp = $client->shop->get_category_list;

Answer will contain a category_list field with a list of categories each of divided into subcategories. Every subcategory will contain the name and the identiefer.

More info at Shop management: get_category_list.

get_suggested_tags

Retrieves a list of buzz tags.

Scope clients. Typical usage:

$resp = $client->shop->get_suggested_tags(
    limit => 25,
);

Answer will contain a tags field with a list of popular tags.

More info at Shop management: get_suggested_tags.

SEE ALSO

Regru::API

Regru::API::Role::Client

REG.API Domain shop management

REG.API Common error codes

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/regru/regru-api-perl/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHORS

  • Polina Shubina <shubina@reg.ru>

  • Anton Gerasimov <a.gerasimov@reg.ru>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by REG.RU LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.