Aurora API: Order Document

Get

Allow retrieval of order documentation for a user’s order.

Example request

Example request

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Order>
        <Document>
          <Get>
            <OrderID>123</OrderID>
            <TemplateName>invoice.tpl.html</TemplateName>
            <Format>html</Format>
            <RenderContext>invoice</RenderContext>
          </Get>
        </Document>
      </Order>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example response

Example response

<?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
    <Header>
        <Version>1.5</Version>
        <Timestamp>2017-07-03T07:18:16+01:00</Timestamp>
        <RequestDetails></RequestDetails>
        <Summary>
            <Ack>OK</Ack>
            <RequestsProcessed>1</RequestsProcessed>
            <RequestsSucceeded>1</RequestsSucceeded>
            <RequestErrors>0</RequestErrors>
        </Summary>
    </Header>
    <Responses>
        <Response>
            <RequestID>1</RequestID>
            <Ack>OK</Ack>
            <Data>
                <FileMimeType>text/html</FileMimeType>
                <FileData>VGhpcyBpcyBhIHNhbXBsZSBzdHJpbmcgdG8gc2ltdWxhdGUgYmFzZTY0IGVuY29kZWQgRmlsZURhdGEu</FileData>
            </Data>
        </Response>
    </Responses>
</AuroraResponseEnvelope>

Request fields

Field	Values	Example Data	API Version	Description	Required
OrderID	Integer		1.5+	Must be a valid Order ID. Failure to match to an existing order results in an API error.	Conditional (one of "OrderID" or "PartOrderID" required)
PartOrderID	Integer		1.5+	Must be a valid Part Dispatch ID. Failure to match to an existing part dispatch results in an API error. Specifying the PartOrderID effects the render context as follows: only items associated to the part dispatch are available shipping fields on the part dispatch hide/override those of the order	Conditional (one of "OrderID" or "PartOrderID" required)
TemplateName	String	invoice.tpl.html	1.5+	Specify File from site template directory. If omitted the default Aurora template will be used.	No
Format	String	html	1.5+	Selected from pre-defined list: html pdf	Yes
RenderContext	String	invoice	1.5+	The variables made available to the template. Selected from pre-defined list: * invoice	Yes

Response fields

Aurora Field	Type	Example Data	Description
FileMimeType	String	text/html	Mime type of the encoded file data
FileData	String		Base64 encoded binary file data

Updated over 2 years ago