DEdepict
Listing (v3)

Get Listing Via External Id

Changed on
get/v3/listings/external_id/{external_id}

Request

  • Base URL
    https://api.depict.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.depict.ai/v3/listings/external_id/{external_id}
  • Auth
    none declared

Path parameters

external_idstring nullable required

Query parameters

merchantstring required
marketstring required
localestring required
listing_idstring uuid nullable
session_idstring

Response

Successful Response

listing_idstring uuid required

Depict ID of the listing.

external_idstring nullable

ID of the listing in the merchant PIM, CMS or similar.

listing_type'long_tail_collection' | 'campaign' | 'category' | 'smart_pick' | 'style' | 'brand' | 'look' required
show_in_breadcrumbsboolean required

Show or hide this listing in navigation breadcrumbs.

show_in_quicklinksboolean required

Show or hide this listing in quicklinks.

image_urlsstring[] required

List of image URLs for the listing.

titlestring required
slugstring nullable
page_urlstring nullable

The listing's own page URL from the merchant's store attributes, when ingested. Absent otherwise; a storefront that composes URLs from ancestors + slug keeps doing so.

Changes

  • f33b8e44a560Revision changes
    • info

      added the optional property // to the response with the status

  • c43d68e5490bRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status