Message API indexes | eBay Developers Program

Index:FieldsTypesEnumerations

This is a list of all fields in the schema. Select a method to learn more about how a call uses a field.

Field

Parent field

Applicable resources and methods

conversationId

(method-level)

POST

/send_messageconversationId - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.conversationId

POST

/update_conversationconversationId - - /api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationId

conversations

POST

/bulk_update_conversationconversationId - conversations - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationId

GET

/conversationconversationId - conversations - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.conversationId

conversationsResponse

POST

/bulk_update_conversationconversationId - conversationsResponse - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#response.conversationsResponse.conversationId

conversationStatus

(method-level)

GET

/conversation/{conversation_id}conversationStatus - - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.conversationStatus

POST

/update_conversationconversationStatus - - /api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationStatus

conversations

POST

/bulk_update_conversationconversationStatus - conversations - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationStatus

GET

/conversationconversationStatus - conversations - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.conversationStatus

conversationTitle

(method-level)

GET

/conversation/{conversation_id}conversationTitle - - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.conversationTitle

conversations

GET

/conversationconversationTitle - conversations - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.conversationTitle

conversationType

(method-level)

GET

/conversation/{conversation_id}conversationType - - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.conversationType

POST

/update_conversationconversationType - - /api-docs/commerce/message/resources/conversation/methods/updateConversation#request.conversationType

conversations

POST

/bulk_update_conversationconversationType - conversations - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations.conversationType

GET

/conversationconversationType - conversations - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.conversationType

conversations

(method-level)

POST

/bulk_update_conversationconversations - - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#request.conversations

GET

/conversationconversations - - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations

conversationsMetadata

(method-level)

POST

/bulk_update_conversationconversationsMetadata - - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#response.conversationsMetadata

conversationsResponse

(method-level)

POST

/bulk_update_conversationconversationsResponse - - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#response.conversationsResponse

createdDate

(method-level)

POST

/send_messagecreatedDate - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.createdDate

conversations

GET

/conversationcreatedDate - conversations - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.createdDate

conversations.latestMessage

GET

/conversationcreatedDate - conversations.latestMessage - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.createdDate

messages

GET

/conversation/{conversation_id}createdDate - messages - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.createdDate

emailCopyToSender

(method-level)

POST

/send_messageemailCopyToSender - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.emailCopyToSender

href

(method-level)

GET

/conversationhref - - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.href

GET

/conversation/{conversation_id}href - - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.href

latestMessage

conversations

GET

/conversationlatestMessage - conversations - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage

limit

(method-level)

GET

/conversationlimit - - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.limit

GET

/conversation/{conversation_id}limit - - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.limit

mediaName

conversations.latestMessage.messageMedia

GET

/conversationmediaName - conversations.latestMessage.messageMedia - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.messageMedia.mediaName

messageMedia

POST

/send_messagemediaName - messageMedia - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.messageMedia.mediaName

POST

/send_messagemediaName - messageMedia - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.messageMedia.mediaName

messages.messageMedia

GET

/conversation/{conversation_id}mediaName - messages.messageMedia - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.messageMedia.mediaName

mediaType

conversations.latestMessage.messageMedia

GET

/conversationmediaType - conversations.latestMessage.messageMedia - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.messageMedia.mediaType

messageMedia

POST

/send_messagemediaType - messageMedia - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.messageMedia.mediaType

POST

/send_messagemediaType - messageMedia - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.messageMedia.mediaType

messages.messageMedia

GET

/conversation/{conversation_id}mediaType - messages.messageMedia - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.messageMedia.mediaType

mediaUrl

conversations.latestMessage.messageMedia

GET

/conversationmediaUrl - conversations.latestMessage.messageMedia - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.messageMedia.mediaUrl

messageMedia

POST

/send_messagemediaUrl - messageMedia - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.messageMedia.mediaUrl

POST

/send_messagemediaUrl - messageMedia - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.messageMedia.mediaUrl

messages.messageMedia

GET

/conversation/{conversation_id}mediaUrl - messages.messageMedia - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.messageMedia.mediaUrl

messageBody

(method-level)

POST

/send_messagemessageBody - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.messageBody

conversations.latestMessage

GET

/conversationmessageBody - conversations.latestMessage - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.messageBody

messages

GET

/conversation/{conversation_id}messageBody - messages - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.messageBody

messageId

(method-level)

POST

/send_messagemessageId - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.messageId

conversations.latestMessage

GET

/conversationmessageId - conversations.latestMessage - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.messageId

messages

GET

/conversation/{conversation_id}messageId - messages - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.messageId

messageMedia

(method-level)

POST

/send_messagemessageMedia - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.messageMedia

POST

/send_messagemessageMedia - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.messageMedia

conversations.latestMessage

GET

/conversationmessageMedia - conversations.latestMessage - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.messageMedia

messages

GET

/conversation/{conversation_id}messageMedia - messages - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.messageMedia

messageText

(method-level)

POST

/send_messagemessageText - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.messageText

messages

(method-level)

GET

/conversation/{conversation_id}messages - - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages

(method-level)

GET

/conversationnext - - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.next

GET

/conversation/{conversation_id}next - - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.next

offset

(method-level)

GET

/conversationoffset - - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.offset

GET

/conversation/{conversation_id}offset - - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.offset

otherPartyUsername

(method-level)

POST

/send_messageotherPartyUsername - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.otherPartyUsername

(method-level)

GET

/conversationprev - - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.prev

GET

/conversation/{conversation_id}prev - - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.prev

read

(method-level)

POST

/update_conversationread - - /api-docs/commerce/message/resources/conversation/methods/updateConversation#request.read

readStatus

(method-level)

POST

/send_messagereadStatus - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.readStatus

conversations.latestMessage

GET

/conversationreadStatus - conversations.latestMessage - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.readStatus

messages

GET

/conversation/{conversation_id}readStatus - messages - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.readStatus

recipientUserName

(method-level)

POST

/send_messagerecipientUserName - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.recipientUserName

recipientUsername

conversations.latestMessage

GET

/conversationrecipientUsername - conversations.latestMessage - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.recipientUsername

messages

GET

/conversation/{conversation_id}recipientUsername - messages - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.recipientUsername

reference

(method-level)

POST

/send_messagereference - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.reference

referenceId

conversations

GET

/conversationreferenceId - conversations - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.referenceId

reference

POST

/send_messagereferenceId - reference - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.reference.referenceId

referenceType

conversations

GET

/conversationreferenceType - conversations - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.referenceType

reference

POST

/send_messagereferenceType - reference - /api-docs/commerce/message/resources/conversation/methods/sendMessage#request.reference.referenceType

senderUserName

(method-level)

POST

/send_messagesenderUserName - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.senderUserName

senderUsername

conversations.latestMessage

GET

/conversationsenderUsername - conversations.latestMessage - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.senderUsername

messages

GET

/conversation/{conversation_id}senderUsername - messages - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.senderUsername

subject

(method-level)

POST

/send_messagesubject - - /api-docs/commerce/message/resources/conversation/methods/sendMessage#response.subject

conversations.latestMessage

GET

/conversationsubject - conversations.latestMessage - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.latestMessage.subject

messages

GET

/conversation/{conversation_id}subject - messages - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.messages.subject

total

(method-level)

GET

/conversationtotal - - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.total

GET

/conversation/{conversation_id}total - - /api-docs/commerce/message/resources/conversation/methods/getConversation#response.total

totalConversationsCount

conversationsMetadata

POST

/bulk_update_conversationtotalConversationsCount - conversationsMetadata - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#response.conversationsMetadata.totalConversationsCount

unreadCount

conversations

GET

/conversationunreadCount - conversations - /api-docs/commerce/message/resources/conversation/methods/getConversations#response.conversations.unreadCount

updateFailureCount

conversationsMetadata

POST

/bulk_update_conversationupdateFailureCount - conversationsMetadata - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#response.conversationsMetadata.updateFailureCount

updateStatus

conversationsResponse

POST

/bulk_update_conversationupdateStatus - conversationsResponse - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#response.conversationsResponse.updateStatus

updateSuccessCount

conversationsMetadata

POST

/bulk_update_conversationupdateSuccessCount - conversationsMetadata - /api-docs/commerce/message/resources/conversation/methods/bulkUpdateConversation#response.conversationsMetadata.updateSuccessCount