POST api/v4/Orders/PrintDocument

This method enables access to various printable document types available on the Order.

Request Parameters

orderPrintDocumentRequest: object of type OrderPrintDocumentRequest

Name	Description Usage	Type Allowed values	Required?
orderNumber	Unique identifier of the Order within Store Fulfillment	String	yes
orderShipMethod	Identifier of the ship method carrier. This is only necessary if requesting a ShippingLabel document type.	String	no
orderReturnNumber	Identifier of the Return. Required if requesting either a ReturnReceipt or ReturnShippingLabel document type.	String	no
orderDocumentType	note: ReturnShippingLabelPDF is only compatible with Orders that have ship method carrier of Metapack.	Enum – supports either text or integer. ShippingLabel = 1 HoldTicket = 2 ReturnShippingLabel = 3 ReturnReceipt = 4 ReturnShippingLabelPDF = 5 PackSlip = 6	yes

Response Parameters

orderPrintDocumentResponse: object of type OrderPrintDocumentResponse

Name	Description Usage	Type Allowed values	Required?
orderDocumentHTML	Contains the raw HTML of the printable document	String	yes
sessionToken	Session token to be used for maintaining session state across batch operations.	String	yes
baseSystemVersion	Indicates the version of the underlying Store Fulfillment core application.	String	yes

Example - Print Order Pack Slip

XML Request

Content-Type: application/xml; charset=utf-8
Authorization: Basic YWRtaW46YWRtaW40Mjo=
Accept: application/xml

<OrderPrintDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <orderDocumentType>PackSlip</orderDocumentType>
   <orderNumber>MCI111000166</orderNumber>
</OrderPrintDocumentRequest>

XML Response

<OrderPrintDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <baseSystemVersion>45</baseSystemVersion>
   <sessionToken>Q3ELFN0CTWFSEGW9</sessionToken>
   <orderDocumentHTML><!DOCTYPE html>\r\n<html lang=\"en\">\r\n<head>\r\n\t<meta 
     http-equiv=\"x-ua-compatible\" content=\"IE=Edge\" />\r\n\t<meta http-equiv=\"Content-Type\" 
     content=\"text/html; charset=UTF-8\" />\r\n\t<title>Packing 
     Slip</title></head>\r\n\r\n\r\n\r\n<body></body>\r\n</html></orderDocumentHTML>
</OrderPrintDocumentResponse>

JSON Request

{
   "orderNumber": "USG0HQ5U",
   "orderDocumentType": 6
}

JSON Response

{
   "orderDocumentHTML": "<!DOCTYPE html>\r\n<html lang=\"en\">\r\n<head>\r\n\t<meta 
      http-equiv=\"x-ua-compatible\" content=\"IE=Edge\" />\r\n\t<meta http-equiv=\"Content-Type\" 
      content=\"text/html; charset=UTF-8\" />\r\n\t<title>Packing 
      Slip</title></head>\r\n\r\n\r\n\r\n<body></body>\r\n</html>",
   "sessionToken": "SGKE53SKE9WRFLZN",
   "baseSystemVersion": "45"
}