Create, retrieve, replace, and cancel customer offers.
List Offers by Customer
Returns all offers associated with the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
List Offers by Customer › Responses
Request accepted
CountList Offers by Third-Party Customer ID
Returns all offers associated with the customer identified by the given ID in a third-party system.
path Parameters
idThe customer ID in the third-party system.
tpidThe third-party system identifier.
List Offers by Third-Party Customer ID › Responses
Request accepted
CountAccept Offer
Accepts the specified offer in FreshSales and triggers contract creation. Fetches the contract data associated with the opportunity from FreshSales and initiates an asynchronous contract creation request.
path Parameters
idThe FreshSales opportunity ID.
Accept Offer › Responses
Request forwarded
MessageList Offers
Create Offer
Creates a new offer for a customer.
Create Offer › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
OwnerIdTextTemplateGuidStartDateIf empty, then according to market requirements. Can be overriden according to market expectations and standards.
EndDateStartOfSupplyDateStartOfSupplyRequestID^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
CreateANewAccountForEachAccountingPointCreate Offer › Responses
Valid request
OfferGuid^([0-9A-Fa-f]{32}$|^…UC Identifier
Get Offer
Returns the offer with the specified ID.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe offer ID.
UC Identifier
Get Offer › Responses
Success
CustomerGuid^([0-9A-Fa-f]{32}$|^…UC Identifier
Guid^([0-9A-Fa-f]{32}$|^…UC Identifier
RequestedChannelStatusReplace Offer
Replaces the specified offer with the values provided in the request body.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe offer ID.
UC Identifier
Replace Offer › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
OwnerIdTextTemplateGuidStartDateIf empty, then according to market requirements. Can be overriden according to market expectations and standards.
EndDateStartOfSupplyDateStartOfSupplyRequestID^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
CreateANewAccountForEachAccountingPointReplace Offer › Responses
Valid request
MessageCancel Offer
Cancels the specified offer, preventing further processing.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe offer ID.
UC Identifier
Cancel Offer › Request Body
RequestId^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
CommentAn explanation from the clerk
RequestedChannelCancel Offer › Responses
Request accepted
MessageDelete Offer
Permanently erases the specified offer and its associated data.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe offer ID.
UC Identifier
Delete Offer › Request Body
RequestId^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
CommentAn explanation from the clerk
RequestedChannelDelete Offer › Responses
Request accepted
Message