MoxiWorks.Platform.SellerTransactionService Class Reference

Moxi Works Platform SellerTransaction entities represent seller-side transactions that agents are working on. More...

Inheritance diagram for MoxiWorks.Platform.SellerTransactionService:

Public Member Functions
	SellerTransactionService (IMoxiWorksClient client)
async Task< Response< SellerTransaction > >	CreateSellerTransactionAsync (SellerTransaction sellerTransaction)
	Create new SellerTransaction More...
async Task< Response< SellerTransaction > >	UpdateSellerTransactionAsync (SellerTransaction sellerTransaction)
	Update existing Seller Transaction More...
async Task< Response< SellerTransaction > >	GetSellerTransactionAsync (string agentId, AgentIdType agentIdType, string moxiworksTransactionId)
	Requests a SellerTransaction More...
async Task< Response< SellerTransactionResults > >	GetSellerTransactionsAsync (string agentId, AgentIdType agentIdType, string moxiworksContactId=null, string partnerContactId=null, int pageNumber=1)
	Request a list of seller transactions More...

Properties
IMoxiWorksClient	Client [get, set]
Properties inherited from MoxiWorks.Platform.Interfaces.ISellerTransactionService
IMoxiWorksClient	Client [get, set]

Detailed Description

Moxi Works Platform SellerTransaction entities represent seller-side transactions that agents are working on.

Member Function Documentation

CreateSellerTransactionAsync()

async Task<Response<SellerTransaction> > MoxiWorks.Platform.SellerTransactionService.CreateSellerTransactionAsync

(

SellerTransaction

sellerTransaction

)

Create new SellerTransaction

Parameters

sellerTransaction

The SellerTransaction to be created.

Returns

Created SellerTransaction

Implements MoxiWorks.Platform.Interfaces.ISellerTransactionService.

GetSellerTransactionAsync()

async Task<Response<SellerTransaction> > MoxiWorks.Platform.SellerTransactionService.GetSellerTransactionAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	moxiworksTransactionId
	)

Requests a SellerTransaction

Parameters

agentId

Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an SellerTransaction entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your SellerTransaction request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an SellerTransaction entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your SellerTransaction request to be accepted. Agent ID for your Group request to be accepted.

Parameters

agentIdType	What agentId type you are using.
moxiworksTransactionId	This is the Moxi Works Platform ID of the SellerTransaction which you have created. This will be an RFC 4122 compliant UUID.This ID should be recorded on response as it is the key ID for updating the SellerTransaction.

Returns

SellerTransaction or an empty SellerTransaction of no match is found

Implements MoxiWorks.Platform.Interfaces.ISellerTransactionService.

GetSellerTransactionsAsync()

async Task<Response<SellerTransactionResults> > MoxiWorks.Platform.SellerTransactionService.GetSellerTransactionsAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	moxiworksContactId = null,
		string	partnerContactId = null,
		int	pageNumber = 1
	)

Request a list of seller transactions

Parameters

agentId

Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an SellerTransaction entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your SellerTransaction request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an SellerTransaction entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your SellerTransaction request to be accepted. Agent ID for your Group request to be accepted.

Parameters

agentIdType	What agentId type you are using.
moxiworksContactId	This is the Moxi Works Platform ID of the Contact which this SellerTransaction has been associated with. This will be an RFC 4122 compliant UUID.
partnerContactId	If this Contact was created by your sytem in the Moxi Works Platform, then this is the unique identifer you use in your system that has been associated with the Contact that you are creating this SellerTransaction for. If the Contact was not created by you, then partner_contact_id will be empty.
pageNumber	Page of SellerTransaction records to return. Use if total_pages indicates that there is more than one page of data available.

Returns

List of SellerTransactions

Implements MoxiWorks.Platform.Interfaces.ISellerTransactionService.

UpdateSellerTransactionAsync()

async Task<Response<SellerTransaction> > MoxiWorks.Platform.SellerTransactionService.UpdateSellerTransactionAsync

(

SellerTransaction

sellerTransaction

)

Update existing Seller Transaction

Parameters

sellerTransaction

The Seller Transaction to be updated.

Returns

Updated SellerTransaction

Implements MoxiWorks.Platform.Interfaces.ISellerTransactionService.

---

The documentation for this class was generated from the following file:

• SellerTransactionService.cs