Content

Listings / Search

Searches for existing listings by (url, ad_id, seller_id) tuples. Returns listings matching ANY of the input rows. Within a row, all provided (non-null) fields must match (AND); null fields are ignored.

Route: /api/sys/v{version:apiVersion}/listings/search

Method: POST

Authorisation: Minimum role: USER

Request Arguments

Name	Type	Source
input	DTO_listing_search_input	Body

Request body example

Response object

Response status: 200 (OK)

Response type: DTO_ticket[]

Wrapper: DTO_response_wrap

Other response statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

DTO_listing_search_input

Name	Type	Description
identifiers	ListingIdentifierInputDTO[]	Identifiers
brand_id	Int32	Brand id
tenant_id	Int32	Tenant id

DTO_ticket

Name	Type	ReadOnly	Description
id	Int32	ReadOnly	Id
group	DTO_reference		Group
assignee	DTO_reference		Assignee
requester	DTO_contact		Requester
created	DateTime	ReadOnly	Created
created_by	DTO_reference_user	ReadOnly	Created by
last_updated	DateTime	ReadOnly	Last updated
last_updated_by	DTO_reference_user	ReadOnly	Last updated by
last_message	DateTime (nullable)	ReadOnly	Last message
reply_count	Int32	ReadOnly	Reply count
reply_history	DTO_ticket_reply_history[]	ReadOnly	Reply history
sys_priority	DTO_reference		Sys priority
sys_status	DTO_reference		Sys status
sys_subject	String		Sys subject
sys_content_rich	DTO_rich_text		Sys content rich
suggested_reply_status	ENUM suggested_reply_status		Suggested reply status
sys_attachments	DTO_reference_attachment[]		Sys attachments

DTO_reference

Name	Type	ReadOnly	Description
id	Int32		The id of the reference
label	Object	ReadOnly	Name/Label from referenced object.

DTO_contact

Name	Type	Description
user_id	Int32	User id
email	String	Email
name	String	Name
profile_pic	String	Profile pic

DTO_reference_user

Name	Type	ReadOnly	Description
profile_pic	String	ReadOnly	Profile pic
email	String	ReadOnly	Email
role_enum_id	tenant_user_role (nullable)		Role enum id
id	Int32		Id
label	Object	ReadOnly	Label

DTO_ticket_reply_history

Name	Type	Description
by	DTO_reference_user	By
id	Int32	Id
type	ENUM ticket_conversation_type	Type
created	DateTime	Created

DTO_rich_text

Name	Type	ReadOnly	Description
plain_preview	String	ReadOnly	Plain preview
html	String		Html
editorjs	DTO_editorjs		Editorjs
tiptap	DTO_tiptap		Tiptap
read_minutes	Int32		Read minutes

DTO_editorjs

Name	Type	Description
time	Int64	Time
version	String	Version
blocks	DTO_editorjs_block[]	Blocks

DTO_editorjs_block

Name	Type	Description
id	String	Id
type	String	Type
data	Object	Data

DTO_tiptap

Name	Type	ReadOnly	Description
type	String		Type
content	DTO_tiptap_node[]		Content

DTO_tiptap_node

Name	Type	Description
type	String	Type
attrs	DTO_tiptap_attrs	Attrs
content	DTO_tiptap_node[]	Content
text	String	Text
marks	DTO_tiptap_mark[]	Marks

DTO_tiptap_attrs

Name	Type	Description
textAlign	String	Textalign
level	Int32 (nullable)	Level
checked	Boolean (nullable)	Checked
id	Int32 (nullable)	Id
alt	String	Alt
title	String	Title
width	String	Width
wrapperStyle	String	Wrapperstyle
files	DTO_tiptap_file_ref[]	Files
href	String	Href
target	String	Target
colspan	Int32 (nullable)	Colspan
rowspan	Int32 (nullable)	Rowspan
color	String	Color

DTO_tiptap_file_ref

Name	Type	ReadOnly	Description
id	Int32		Id
label	String		Label

DTO_tiptap_mark

Name	Type	ReadOnly	Description
type	String		Type
attrs	DTO_tiptap_attrs		Attrs

DTO_reference_attachment

Name	Type	ReadOnly	Description
size_kb	Int32	ReadOnly	Size kb
status	ENUM attachment_status	ReadOnly	Status
status_message	String	ReadOnly	Status message
download_url	String	ReadOnly	Download url
id	Int32		Id
label	Object	ReadOnly	Label

ENUM ticket_conversation_type

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	REPLY_INBOUND	REPLY_INBOUND
2	NOTE_PRIVATE	NOTE_PRIVATE
3	NOTE_PUBLIC	NOTE_PUBLIC
4	FORWARD	FORWARD
5	REPLY_OUTBOUND	REPLY_OUTBOUND
6	SUGGESTED_REPLY	SUGGESTED_REPLY

ENUM attachment_status

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	UNAVAILABLE	UNAVAILABLE, processing in progress
2	OK	OK
3	WARNING	WARNING
4	ERROR	ERROR

ENUM suggested_reply_status

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	IN_PROGRESS	In progress
2	DONE	Done
3	ERROR_NO_KNOWLEDGE	Error no knowledge
4	ERROR_UNKNOWN	Error unknown

POST Listings / Create

POST Listings / External dynamic form