XaitCPQ API

POST document/merge/{quote}

Create a new Quote Document.

Request Information

URI

https://ofd-api.blueprintcpq.net/document/merge/{quote}?template={template}&name={name}&extension={extension}&includeAttachments={includeAttachments}&quoteProduct={quoteProduct}

URI Parameters

NameDescriptionTypeAdditional information
quote

Quote Identifier.

 globally unique identifier

Required
template

Quote template.

 globally unique identifier

Required
name

File name.

 string

Required
extension

File type.

 string

Required
includeAttachments

boolean

Default value is False
quoteProduct

Associated quote product.

 globally unique identifier

None.

Body Parameters

Collection of globally unique identifier

Request Formats

application/json, text/json

Sample: 
[
  "45bd0c3b-e153-4881-bf58-93bf40209a6c",
  "d2f898a0-e63c-4baa-a1f6-3568ee7acd36"
]

text/html

Sample: 
["45bd0c3b-e153-4881-bf58-93bf40209a6c","d2f898a0-e63c-4baa-a1f6-3568ee7acd36"]

application/xml, text/xml

Sample: 
<ArrayOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <guid>45bd0c3b-e153-4881-bf58-93bf40209a6c</guid>
  <guid>d2f898a0-e63c-4baa-a1f6-3568ee7acd36</guid>
</ArrayOfguid>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Identifier of the new document.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.