GET api/orders/{orderNumber}/pdf
Retrieve a link to the print out of a specific order.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderNumber |
The order number of the order requested for retrieval. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A url for the pdf.
OrderPdfLinkResponseName | Description | Type | Additional information |
---|---|---|---|
CompanyName |
The name of the company that placed the order. |
string |
None. |
PricingSheetName |
The name of the pricing sheet used on the order. |
string |
None. |
PricingSheetNumber |
The number of the pricing sheet used on the order. |
string |
None. |
LocationName |
The name of the company's location that the order was placed for. |
string |
None. |
AbcShopName |
The name of the ABC shop that has responsibility for the order. |
string |
None. |
AbcShop |
Details of the ABC Shop location. |
Location |
None. |
OrderNumber |
The order number of the requested order. |
integer |
None. |
LastModifiedBy |
Who last modified the requested order. |
string |
None. |
LastModified |
When was the requested order last modified. |
date |
None. |
ResourceId |
Identifier of the storage file for the work order's PDF. |
globally unique identifier |
None. |
Response Formats
application/json, text/json
{ "CompanyName": "sample string 1", "PricingSheetName": "sample string 2", "PricingSheetNumber": "sample string 3", "LocationName": "sample string 4", "AbcShopName": "sample string 5", "AbcShop": { "LocationId": 1, "ShortName": "sample string 2", "Name": "sample string 3", "Code": "sample string 4", "BillingAddress": { "Street1": "sample string 1", "Street2": "sample string 2", "City": "sample string 3", "Region": "sample string 4", "Postalcode": "sample string 5", "PostalZip4": "sample string 6", "CountryCode": "sample string 7" }, "ShippingAddress": { "Street1": "sample string 1", "Street2": "sample string 2", "City": "sample string 3", "Region": "sample string 4", "Postalcode": "sample string 5", "PostalZip4": "sample string 6", "CountryCode": "sample string 7" }, "LocationType": 0, "Email": "sample string 5", "Phone": "sample string 6", "CodCustomerId": 1 }, "OrderNumber": 6, "LastModifiedBy": "sample string 7", "LastModified": "2024-12-25T09:05:42.6136557-05:00", "ResourceId": "57fbcb5a-8c35-4b9d-b350-0020f8ae5acb" }
application/xml, text/xml
<OrderPdfLinkResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <CompanyName>sample string 1</CompanyName> <PricingSheetName>sample string 2</PricingSheetName> <PricingSheetNumber>sample string 3</PricingSheetNumber> <LocationName>sample string 4</LocationName> <AbcShopName>sample string 5</AbcShopName> <AbcShop> <LocationId>1</LocationId> <ShortName>sample string 2</ShortName> <Name>sample string 3</Name> <Code>sample string 4</Code> <BillingAddress> <Street1>sample string 1</Street1> <Street2>sample string 2</Street2> <City>sample string 3</City> <Region>sample string 4</Region> <Postalcode>sample string 5</Postalcode> <PostalZip4>sample string 6</PostalZip4> <CountryCode>sample string 7</CountryCode> </BillingAddress> <ShippingAddress> <Street1>sample string 1</Street1> <Street2>sample string 2</Street2> <City>sample string 3</City> <Region>sample string 4</Region> <Postalcode>sample string 5</Postalcode> <PostalZip4>sample string 6</PostalZip4> <CountryCode>sample string 7</CountryCode> </ShippingAddress> <LocationType>Customer</LocationType> <Email>sample string 5</Email> <Phone>sample string 6</Phone> <CodCustomerId>1</CodCustomerId> </AbcShop> <OrderNumber>6</OrderNumber> <LastModifiedBy>sample string 7</LastModifiedBy> <LastModified>2024-12-25T09:05:42.6136557-05:00</LastModified> <ResourceId>57fbcb5a-8c35-4b9d-b350-0020f8ae5acb</ResourceId> </OrderPdfLinkResponse>