Listing Manager Listings - All Listings Summary

[base module url]/{lm_id}/listings/all

The listing manager listings endpoint is used to list the different listings in a listing manager.

Sort parameters ( ?sort=param,param,etc )

Default: -id

Boolean sort behavior will sort as integer 0/1 respectively for false/true for purposes of sort order ( asc/desc )

Filter parameters ( ?parameter=value&parameter=value&etc )

Default: none

This endpoint has no filters.

Sample Response

The "next_page" will contain an integer for the next page number to retrieve the next set of results using ?page. If "next_page" is false, there are no more pages of results to retrieve

{
    "listings":[
        {
            "id":"1",
            "name":"Item 1",
            "slug":"item-1",
            "description":"",
            "active":true,
            "order":0,
            "created":"2018-09-28T06:51:02-06:00",
            "created_ip":"127.0.0.1",
            "created_user_id":"1",
            "modified":"2018-11-08T12:33:55-07:00",
            "modified_user_id":"1"
        },
        {
            "id":"2",
            "name":"Item 2",
            "slug":"item-2",
            "description":"",
            "active":true,
            "order":0,
            "created":"2018-11-12T15:38:41-07:00",
            "created_ip":"127.0.0.1",
            "created_user_id":"1",
            "modified":"2018-11-13T08:04:55-07:00",
            "modified_user_id":"1"
        },
        .....
    ],
    "next_page":2
}

Listing Manager Listings - Individual Listing Details

[base module url]/{lm_id}/listings/{listing_id}

The listing manager listing details endpoint is used to list the details for a listing in a listing manager.

Sort parameters ( ?sort=param,param,etc )

Default: -id

Boolean sort behavior will sort as integer 0/1 respectively for false/true for purposes of sort order ( asc/desc )

Filter parameters ( ?parameter=value&parameter=value&etc )

Default: none

This endpoint has no filters.

Sample Response

{
  "listings": [
    {
      "id": "1",
      "site_id": "1",
      "package_id": null,
      "listing_mgr_id": "1",
      "listing_mgr_loc_state_id": null,
      "listing_mgr_loc_city_id": null,
      "user_id": "4",
      "affiliate_user_id": null,
      "title": "Item 1",
      "slug": "item-1",
      "asking_price": "0.00",
      "description": "",
      "region_1": null,
      "keywords": null,
      "url": "",
      "seo_title": null,
      "seo_description": null,
      "seo_keywords": null,
      "content_field": null,
      "protected": "0",
      "email": "",
      "contact_name": "",
      "address": "",
      "address2": "",
      "city": "",
      "state": "",
      "county": "",
      "zip": "",
      "country": "",
      "phone": "",
      "fax": "",
      "custom_latlon": "0",
      "latitude": "0.0",
      "longitude": "0.0",
      "is_geocoded": "0",
      "featured": "0",
      "bolded": "0",
      "top_listing": "0",
      "top_link": "0",
      "editors_pick": "0",
      "most_views": "0",
      "order": "0",
      "primary_pic": "",
      "is_premium": "0",
      "youtube_1": null,
      "youtube_2": null,
      "youtube_3": null,
      "wistia_video_hash_id_1": null,
      "wistia_video_img_url_1": null,
      "wistia_video_hash_id_2": null,
      "wistia_video_img_url_2": null,
      "wistia_video_hash_id_3": null,
      "wistia_video_img_url_3": null,
      "social_link_facebook": null,
      "social_link_twitter": null,
      "social_link_googleplus": null,
      "social_link_linkedin": null,
      "social_link_youtube": null,
      "social_link_pinterest": null,
      "social_link_instagram": null,
      "hours_specified": "0",
      "hours_detail": null,
      "active": "1",
      "activated_once": "1",
      "deactive_reason": "",
      "is_paid": "0",
      "payment_option": "",
      "payment_option_type": "",
      "payment_option_id": "0",
      "is_removed": "0",
      "verified_link": "0",
      "verify_link_url": null,
      "verify_link_url_last": "0000-00-00 00:00:00",
      "expires": "0000-00-00",
      "expired": "0000-00-00",
      "auto_renew": "0",
      "trial_end_date": "0000-00-00",
      "active_promo_code": "",
      "promo_code_id": null,
      "promo_discounted": "0.00",
      "promo_discounted_shipping": "0.00",
      "promo_uses": "0",
      "promo_use_limit": "0",
      "promo_desc": null,
      "page_views": "0",
      "rating_total": "0",
      "rating_average": "0",
      "transfer_code": "",
      "timezone": "",
      "reservation_increment": "60",
      "sms_sent_this_month": "0",
      "sms_sent_month": "0",
      "pedigree_dam_id": "0",
      "pedigree_sire_id": "0",
      "created": "2009-04-16 09:25:21",
      "created_ip": "",
      "created_user_id": null,
      "modified": "2018-10-16 17:00:44",
      "modified_user_id": null
    }
  ]
}

Listing Manager Listings - Update Listing

[base module url]/{lm_id}/listings/update

The listing manager listing update endpoint is used to update the details of a listing in a listing manager.

Request Information

When doing an Update, include only the field(s) that you would like to change as well as the id of the listing(s).

{
    "listings":[
        {
            "id":"1",
            "title":"Item 1",
        },
        {
            "id":"2",
            "title":"Item 2",
        }
    ]
}

Sample Response

The response is the same as when requesting a listing's details.

Listing Manager Listings - Create Listing

[base module url]/{lm_id}/listings/create

The listing manager listing create endpoint is used to create a listing in a listing manager.

Request Information

When creating a new listing, include only the field(s) that you would like. The id field will be ignored. The only required field is the title.

{
    "listings":[
        {
            "title":"Item 1",
        },
        {
            "title":"Item 2",
        }
    ]
}

Sample Response

The response is the same as when requesting a listing's details.

Listing Manager Listings - Delete Listing

[base module url]/{lm_id}/listings/delete

The listing manager listing delete endpoint is used to delete listings in a listing manager.

Request Information

When doing a delete, pass in a JSON array of id fields. This must be in the post data.

{
    "listings":{
        "id":[1,2]
    ]
}

Sample Response

The response is the same as when requesting a listing's details.