Pressero Web Services API Introduction

PRESSERO > *Integration information & Supported Services
PLEASE NOTE: The information in this article refers to the API for Pressero v4/v5. For v6 please visit one of the following links: 
Any new integrations should use the V6 API.
 
Pressero uses a unique system architecture that allows it to be the most “open” web-to-print system on the market. Using an extensive SOAP (XML) based web services API, you can access the same methods Aleyant developers used to create the administrative and storefront applications. This means that every single user function available in the admin or storefront applications is available via the API.

This document provides a brief introduction to the API and demonstrates the usage of a few common methods typically used to integrate with management systems.  Please keep in mind these methods are a small subset of the available commands.  Please contact us for additional information.

Credentials

Every call to the Admin API requires four unique pieces of information to be provided as a means of authenticating your request:
  • ConsumerID: This is a GUID which is unique to your application. This GUID is provided to you by Aleyant Systems. For security purposes, the ConsumerID may limit what you can and cannot do. Be sure to explain the goals of your application to Aleyant so that the correct permissions can be configured.
  • SubscriberID: This GUID is unique to your Pressero account. This GUID will be provided to you by Aleyant Systems. Also see http://support.aleyant.com/kb/a90/where-can-i-find-my-subscriberid.aspx
  • User ID: This string is the user name or email for an administrative account you assign in the Pressero administrative interface. This User ID is subject to the group permissions you assign in the admin application.
  • Password: This is a MD5 Hash of the password you assigned when creating the User ID.
  • adminDomain: This string is the URL you have been assigned to access the administrative application. Generally this is “admin.pressero.com”.
Generally the Credentials are supplied as part of the request:
 

 
  1. <creds>
  2.   <consumerid>guid</consumerid>
  3.   <userName>string</userName>
  4.   <password>base64Binary</password>
  5.   <adminDomain>string</adminDomain>
  6.   <SubscriberID>guid</SubscriberID>
  7. </creds>
 
Note that calls to the SiteMgr API do not require a credentials object. A consumerID is still required, but admin user and password is not. Generally the site domain is also part of the call.  
 

getOrderItemList

Pressero allows multiple items per order. As each item is often processed differently by the printing company, the getOrderItemList presents the list of orders on a “per item” basis rather than a “per order” basis.  The request to retrieve a list of ordered items is issued as follows:
 

 
  1. <getOrderItemList xmlns="http://w2p.aleyant.com/">
  2.       <creds>
  3.         <consumerid>guid</consumerid>
  4.         <userName>string</userName>
  5.         <password>base64Binary</password>
  6.         <adminDomain>string</adminDomain>
  7.         <SubscriberID>guid</SubscriberID>
  8.       </creds>
  9.       <siteDomains>
  10.         <string>string</string>
  11.         <string>string</string>
  12.       </siteDomains>
  13.       <beginDate>dateTime</beginDate>
  14.       <endDate>dateTime</endDate>
  15.       <maxrecords>int</maxrecords>
  16.     </getOrderItemList>
 

Please note the following when issuing a getOrderItemList request:
  • To limit the ordered items by one or more Pressero sites, specify one or more domain names in siteDomains. To retrieve items for all stores, do not specify any domain names. 
  • The date range for the items requested is specified in beginDate and endDate. All dates are specified in UTC (GMT) using ISO 8601 format (yyyy-mm-ddThh-mm-ssZ). For example: 2001-10-26T21:32:52, 2001-10-26T21:32:52+02:00, 2001-10-26T19:32:52Z, 2001-10-26T19:32:52+00:00, -2001-10-26T21:32:52, or 2001-10-26T21:32:52.12679
  • To prevent the returned XML from being too large (and thus too slow), consider providing a maxRecords integer to limit the number of items returned.

getOrderItemList returns an array of OrderItemInfo structures:
 

 
  1. <OrderItemInfo>
  2.           <orderID>guid</orderID>
  3.           <orderitemid>guid</orderitemid>
  4.           <orderDate>dateTime</orderDate>
  5.           <printerOrderID>int</printerOrderID>
  6.           <seq>int</seq>
  7.           <itemName>string</itemName>
  8.           <jobNum>string</jobNum>
  9.           <poNum>string</poNum>
  10.           <reqShipDate>dateTime</reqShipDate>
  11.           <quantity>int</quantity>
  12.           <price>decimal</price>
  13.           <requestedBy>string</requestedBy>
  14.           <shipTo>
  15.             <AddressID>guid</AddressID>
  16.             <isPreferred>boolean</isPreferred>
  17.             <Business>string</Business>
  18.             <FirstName>string</FirstName>
  19.             <LastName>string</LastName>
  20.             <Title>string</Title>
  21.             <Address1>string</Address1>
  22.             <Address2>string</Address2>
  23.             <Address3>string</Address3>
  24.             <City>string</City>
  25.             <StateProvince>string</StateProvince>
  26.             <Postal>string</Postal>
  27.             <Country>string</Country>
  28.             <Phone>string</Phone>
  29.             <Fax>string</Fax>
  30.             <Email>string</Email>
  31.           </shipTo>
  32.           <currentWorkflowStatus>string</currentWorkflowStatus>
  33.           <currentWorkflowStatusDate>dateTime</currentWorkflowStatusDate>
  34.           <currentWorkflowStatusNote>string</currentWorkflowStatusNote>
  35.           <workflowName>string</workflowName>
  36.           <printLocation>
  37.             <locationID>guid</locationID>
  38.             <Code>string</Code>
  39.             <GeneralInfo>string</GeneralInfo>
  40.             <remove>boolean</remove>
  41.           </printLocation>
  42.           <billToLocation>
  43.             <locationID>guid</locationID>
  44.             <Code>string</Code>
  45.             <GeneralInfo>string</GeneralInfo>
  46.             <remove>boolean</remove>
  47.           </billToLocation>
  48.           <vendorName>string</vendorName>
  49.           <isApproved>boolean</isApproved>
  50.           <isPaid>boolean</isPaid>
  51.           <productName>string</productName>
  52.           <cultureCode>string</cultureCode>
  53.           <pricingOptions>string</pricingOptions>
  54.           <canonicalUrl>string</canonicalUrl>
  55.           <company>string</company>
  56.           <siteID>guid</siteID>
  57.           <siteDomain>string</siteDomain>
  58.         </OrderItemInfo>
 
Please note the following:
 
  • Pressero stores refers to all Orders and Items by a GUID. This GUID is not seen in the administrative application. Instead, the printerOrderID as an integer that represents the order and seq represents the item number.
  • As each item within an order may ship to a different location, the shipTo structure will be included in each OrderItemInfo result.
 

getOrderDetail

After receiving the list of ordered items, you may wish to get more detail about the entire order. Use the orderID GUID returned from getOrderItemList to call getOrderDetail:

 

 
  1. <getOrderDetail xmlns="http://w2p.aleyant.com/">
  2.       <creds>
  3.         <consumerid>guid</consumerid>
  4.         <userName>string</userName>
  5.         <password>base64Binary</password>
  6.         <adminDomain>string</adminDomain>
  7.         <SubscriberID>guid</SubscriberID>
  8.       </creds>
  9.       <orderID>guid</orderID>
  10.     </getOrderDetail>
  11.   </soap:Body>
 

This will return a detailed structure containing information about the order as well as an array of orderInfoItem:

 

 
  1. <getOrderDetailResult>
  2.   <OrderID>guid</OrderID>
  3.   <OrderNumber>int</OrderNumber>
  4.   <OrderDate>dateTime</OrderDate>
  5.   <OrderedBy>
  6.     <userType>char</userType>
  7.     <UserID>guid</UserID>
  8.     <Email>string</Email>
  9.     <Login>string</Login>
  10.     <Password>base64Binary</Password>
  11.     <isActive>boolean</isActive>
  12.     <FirstName>string</FirstName>
  13.     <LastName>string</LastName>
  14.     <Title>string</Title>
  15.     <MISID>string</MISID>
  16.     <ReceiveNotifications>boolean</ReceiveNotifications>
  17.     <ReceiveAllNotifications>boolean</ReceiveAllNotifications>
  18.     <TZ>string</TZ>
  19.     <Culture>string</Culture>
  20.     <photoURLs>
  21.       <string>string</string>
  22.       <string>string</string>
  23.     </photoURLs>
  24.     <newPhotoURL>string</newPhotoURL>
  25.     <addressbook>
  26.       <uAddress xsi:nil="true" />
  27.       <uAddress xsi:nil="true" />
  28.     </addressbook>
  29.     <Phone>string</Phone>
  30.     <Fax>string</Fax>
  31.     <canViewPricing>boolean</canViewPricing>
  32.     <isTaxExempt>boolean</isTaxExempt>
  33.     <isApproved>boolean</isApproved>
  34.     <isShared>boolean</isShared>
  35.     <defaultPONumber>string</defaultPONumber>
  36.     <department>string</department>
  37.     <shouldPrefillCheckout>boolean</shouldPrefillCheckout>
  38.     <cartid>guid</cartid>
  39.     <boss>
  40.       <userType>char</userType>
  41.       <UserID>guid</UserID>
  42.       <Email>string</Email>
  43.       <Login>string</Login>
  44.       <Password>base64Binary</Password>
  45.       <isActive>boolean</isActive>
  46.       <FirstName>string</FirstName>
  47.       <LastName>string</LastName>
  48.       <Title>string</Title>
  49.       <MISID>string</MISID>
  50.       <ReceiveNotifications>boolean</ReceiveNotifications>
  51.       <ReceiveAllNotifications>boolean</ReceiveAllNotifications>
  52.       <TZ>string</TZ>
  53.       <Culture>string</Culture>
  54.       <photoURLs xsi:nil="true" />
  55.       <newPhotoURL>string</newPhotoURL>
  56.       <addressbook xsi:nil="true" />
  57.       <Phone>string</Phone>
  58.       <Fax>string</Fax>
  59.       <canViewPricing>boolean</canViewPricing>
  60.       <isTaxExempt>boolean</isTaxExempt>
  61.       <isApproved>boolean</isApproved>
  62.       <isShared>boolean</isShared>
  63.       <defaultPONumber>string</defaultPONumber>
  64.       <department>string</department>
  65.       <shouldPrefillCheckout>boolean</shouldPrefillCheckout>
  66.       <cartid>guid</cartid>
  67.       <boss xsi:nil="true" />
  68.       <bossName>string</bossName>
  69.       <locationAddress xsi:nil="true" />
  70.       <approvalgroupname>string</approvalgroupname>
  71.       <approvalPlanID>guid</approvalPlanID>
  72.       <CreateDate>dateTime</CreateDate>
  73.       <LastLogin>dateTime</LastLogin>
  74.       <LastOrder>dateTime</LastOrder>
  75.       <TaxID>string</TaxID>
  76.       <captureTaxID>boolean</captureTaxID>
  77.       <siteTaxID>string</siteTaxID>
  78.       <userTaxID>string</userTaxID>
  79.       <CapturePurchaseOrder>int</CapturePurchaseOrder>
  80.       <isGuestUser>boolean</isGuestUser>
  81.     </boss>
  82.     <bossName>string</bossName>
  83.     <locationAddress>
  84.       <AddressID>guid</AddressID>
  85.       <isPreferred>boolean</isPreferred>
  86.       <Business>string</Business>
  87.       <FirstName>string</FirstName>
  88.       <LastName>string</LastName>
  89.       <Title>string</Title>
  90.       <Address1>string</Address1>
  91.       <Address2>string</Address2>
  92.       <Address3>string</Address3>
  93.       <City>string</City>
  94.       <StateProvince>string</StateProvince>
  95.       <Postal>string</Postal>
  96.       <Country>string</Country>
  97.       <Phone>string</Phone>
  98.       <Fax>string</Fax>
  99.       <Email>string</Email>
  100.     </locationAddress>
  101.     <approvalgroupname>string</approvalgroupname>
  102.     <approvalPlanID>guid</approvalPlanID>
  103.     <CreateDate>dateTime</CreateDate>
  104.     <LastLogin>dateTime</LastLogin>
  105.     <LastOrder>dateTime</LastOrder>
  106.     <TaxID>string</TaxID>
  107.     <captureTaxID>boolean</captureTaxID>
  108.     <siteTaxID>string</siteTaxID>
  109.     <userTaxID>string</userTaxID>
  110.     <CapturePurchaseOrder>int</CapturePurchaseOrder>
  111.     <isGuestUser>boolean</isGuestUser>
  112.   </OrderedBy>
  113.   <OrderedByImageURLs>
  114.     <string>string</string>
  115.     <string>string</string>
  116.   </OrderedByImageURLs>
  117.   <PONumber>string</PONumber>
  118.   <billTo>
  119.     <AddressID>guid</AddressID>
  120.     <isPreferred>boolean</isPreferred>
  121.     <Business>string</Business>
  122.     <FirstName>string</FirstName>
  123.     <LastName>string</LastName>
  124.     <Title>string</Title>
  125.     <Address1>string</Address1>
  126.     <Address2>string</Address2>
  127.     <Address3>string</Address3>
  128.     <City>string</City>
  129.     <StateProvince>string</StateProvince>
  130.     <Postal>string</Postal>
  131.     <Country>string</Country>
  132.     <Phone>string</Phone>
  133.     <Fax>string</Fax>
  134.     <Email>string</Email>
  135.   </billTo>
  136.   <HasMultipleShipTos>boolean</HasMultipleShipTos>
  137.   <OrderShipTo>
  138.     <AddressID>guid</AddressID>
  139.     <isPreferred>boolean</isPreferred>
  140.     <Business>string</Business>
  141.     <FirstName>string</FirstName>
  142.     <LastName>string</LastName>
  143.     <Title>string</Title>
  144.     <Address1>string</Address1>
  145.     <Address2>string</Address2>
  146.     <Address3>string</Address3>
  147.     <City>string</City>
  148.     <StateProvince>string</StateProvince>
  149.     <Postal>string</Postal>
  150.     <Country>string</Country>
  151.     <Phone>string</Phone>
  152.     <Fax>string</Fax>
  153.     <Email>string</Email>
  154.   </OrderShipTo>
  155.   <SubTotal>decimal</SubTotal>
  156.   <SubTotalNoMarkup>decimal</SubTotalNoMarkup>
  157.   <Tax1>decimal</Tax1>
  158.   <Tax2>decimal</Tax2>
  159.   <Tax3>decimal</Tax3>
  160.   <Shipping>decimal</Shipping>
  161.   <VAT>decimal</VAT>
  162.   <PromoDiscount>decimal</PromoDiscount>
  163.   <PromoCode>string</PromoCode>
  164.   <PromoText>string</PromoText>
  165.   <Total>decimal</Total>
  166.   <Notes>string</Notes>
  167.   <Location>
  168.     <locationID>guid</locationID>
  169.     <Code>string</Code>
  170.     <GeneralInfo>string</GeneralInfo>
  171.     <remove>boolean</remove>
  172.   </Location>
  173.   <OrderItems>
  174.     <orderInfoItem>
  175.       <CartId>guid</CartId>
  176.       <ItemId>guid</ItemId>
  177.       <Seq>int</Seq>
  178.       <itemName>string</itemName>
  179.       <productName>string</productName>
  180.       <productURL>string</productURL>
  181.       <productID>guid</productID>
  182.       <productShortDescription>string</productShortDescription>
  183.       <AcceptanceControl>string</AcceptanceControl>
  184.       <AcceptanceLabel>string</AcceptanceLabel>
  185.       <AcceptanceText>string</AcceptanceText>
  186.       <edocBuilderApprovalText>string</edocBuilderApprovalText>
  187.       <productImageURLs xsi:nil="true" />
  188.       <ShipMethod>string</ShipMethod>
  189.       <ShipMethod_Carrier>string</ShipMethod_Carrier>
  190.       <ShipMethod_Code>string</ShipMethod_Code>
  191.       <shipTo xsi:nil="true" />
  192.       <ShipMethodID>guid</ShipMethodID>
  193.       <RequestedDelivery>dateTime</RequestedDelivery>
  194.       <ProjectedDelivery>dateTime</ProjectedDelivery>
  195.       <Quantity>int</Quantity>
  196.       <Price>decimal</Price>
  197.       <NonMarkupPrice>decimal</NonMarkupPrice>
  198.       <optionsText>string</optionsText>
  199.       <pricingParms xsi:nil="true" />
  200.       <pricingOptions xsi:nil="true" />
  201.       <pricingEngineID>guid</pricingEngineID>
  202.       <Notes>string</Notes>
  203.       <VendorInfo xsi:nil="true" />
  204.       <PrintersPartNumber>string</PrintersPartNumber>
  205.       <PublicPartNumber>string</PublicPartNumber>
  206.       <BindingJDF>string</BindingJDF>
  207.       <FinishingJDF>string</FinishingJDF>
  208.       <FoldingJDF>string</FoldingJDF>
  209.       <PackagingJDF>string</PackagingJDF>
  210.       <OrderItemFiles xsi:nil="true" />
  211.       <Assets xsi:nil="true" />
  212.       <edocEditURL>string</edocEditURL>
  213.       <eDocProofs xsi:nil="true" />
  214.       <Shipments xsi:nil="true" />
  215.       <WorkflowID>guid</WorkflowID>
  216.       <WorkflowChanges xsi:nil="true" />
  217.       <IsProofApproved>boolean</IsProofApproved>
  218.       <NeedsProofApproval>boolean</NeedsProofApproval>
  219.       <isApproved>boolean</isApproved>
  220.       <isDenied>boolean</isDenied>
  221.       <NeedsApproval>boolean</NeedsApproval>
  222.       <canApprove>boolean</canApprove>
  223.       <canEdit>boolean</canEdit>
  224.       <approvalID>guid</approvalID>
  225.       <Status>string</Status>
  226.       <CustomerStage>string</CustomerStage>
  227.       <LastStatusdate>dateTime</LastStatusdate>
  228.       <OpenState>open or closed or cancelled</OpenState>
  229.       <form xsi:nil="true" />
  230.       <totalItems>int</totalItems>
  231.       <productMisID>string</productMisID>
  232.       <productLocation>string</productLocation>
  233.       <MISID>string</MISID>
  234.       <productCategory>string</productCategory>
  235.       <ShowEdocProofInCart>boolean</ShowEdocProofInCart>
  236.       <isApprovedWithModifications>boolean</isApprovedWithModifications>
  237.     </orderInfoItem>
  238.     <orderInfoItem>
  239.       <CartId>guid</CartId>
  240.       <ItemId>guid</ItemId>
  241.       <Seq>int</Seq>
  242.       <itemName>string</itemName>
  243.       <productName>string</productName>
  244.       <productURL>string</productURL>
  245.       <productID>guid</productID>
  246.       <productShortDescription>string</productShortDescription>
  247.       <AcceptanceControl>string</AcceptanceControl>
  248.       <AcceptanceLabel>string</AcceptanceLabel>
  249.       <AcceptanceText>string</AcceptanceText>
  250.       <edocBuilderApprovalText>string</edocBuilderApprovalText>
  251.       <productImageURLs xsi:nil="true" />
  252.       <ShipMethod>string</ShipMethod>
  253.       <ShipMethod_Carrier>string</ShipMethod_Carrier>
  254.       <ShipMethod_Code>string</ShipMethod_Code>
  255.       <shipTo xsi:nil="true" />
  256.       <ShipMethodID>guid</ShipMethodID>
  257.       <RequestedDelivery>dateTime</RequestedDelivery>
  258.       <ProjectedDelivery>dateTime</ProjectedDelivery>
  259.       <Quantity>int</Quantity>
  260.       <Price>decimal</Price>
  261.       <NonMarkupPrice>decimal</NonMarkupPrice>
  262.       <optionsText>string</optionsText>
  263.       <pricingParms xsi:nil="true" />
  264.       <pricingOptions xsi:nil="true" />
  265.       <pricingEngineID>guid</pricingEngineID>
  266.       <Notes>string</Notes>
  267.       <VendorInfo xsi:nil="true" />
  268.       <PrintersPartNumber>string</PrintersPartNumber>
  269.       <PublicPartNumber>string</PublicPartNumber>
  270.       <BindingJDF>string</BindingJDF>
  271.       <FinishingJDF>string</FinishingJDF>
  272.       <FoldingJDF>string</FoldingJDF>
  273.       <PackagingJDF>string</PackagingJDF>
  274.       <OrderItemFiles xsi:nil="true" />
  275.       <Assets xsi:nil="true" />
  276.       <edocEditURL>string</edocEditURL>
  277.       <eDocProofs xsi:nil="true" />
  278.       <Shipments xsi:nil="true" />
  279.       <WorkflowID>guid</WorkflowID>
  280.       <WorkflowChanges xsi:nil="true" />
  281.       <IsProofApproved>boolean</IsProofApproved>
  282.       <NeedsProofApproval>boolean</NeedsProofApproval>
  283.       <isApproved>boolean</isApproved>
  284.       <isDenied>boolean</isDenied>
  285.       <NeedsApproval>boolean</NeedsApproval>
  286.       <canApprove>boolean</canApprove>
  287.       <canEdit>boolean</canEdit>
  288.       <approvalID>guid</approvalID>
  289.       <Status>string</Status>
  290.       <CustomerStage>string</CustomerStage>
  291.       <LastStatusdate>dateTime</LastStatusdate>
  292.       <OpenState>open or closed or cancelled</OpenState>
  293.       <form xsi:nil="true" />
  294.       <totalItems>int</totalItems>
  295.       <productMisID>string</productMisID>
  296.       <productLocation>string</productLocation>
  297.       <MISID>string</MISID>
  298.       <productCategory>string</productCategory>
  299.       <ShowEdocProofInCart>boolean</ShowEdocProofInCart>
  300.       <isApprovedWithModifications>boolean</isApprovedWithModifications>
  301.     </orderInfoItem>
  302.   </OrderItems>
  303.   <forms>
  304.     <FilledForm>
  305.       <formid>guid</formid>
  306.       <formname>string</formname>
  307.       <title>string</title>
  308.       <prompts xsi:nil="true" />
  309.       <responses xsi:nil="true" />
  310.     </FilledForm>
  311.     <FilledForm>
  312.       <formid>guid</formid>
  313.       <formname>string</formname>
  314.       <title>string</title>
  315.       <prompts xsi:nil="true" />
  316.       <responses xsi:nil="true" />
  317.     </FilledForm>
  318.   </forms>
  319.   <siteDomain>string</siteDomain>
  320.   <siteID>guid</siteID>
  321.   <IsPayComplete>boolean</IsPayComplete>
  322.   <payments>
  323.     <paymentData>
  324.       <id>guid</id>
  325.       <amount>decimal</amount>
  326.       <orderID>guid</orderID>
  327.       <paymentDate>dateTime</paymentDate>
  328.       <paymentID>guid</paymentID>
  329.       <paymentInfo>string</paymentInfo>
  330.       <seq>byte</seq>
  331.       <sitePaymentMethodID>guid</sitePaymentMethodID>
  332.       <remove>boolean</remove>
  333.       <paymentMethodName>string</paymentMethodName>
  334.       <paymentSubscriberMethodName>string</paymentSubscriberMethodName>
  335.     </paymentData>
  336.     <paymentData>
  337.       <id>guid</id>
  338.       <amount>decimal</amount>
  339.       <orderID>guid</orderID>
  340.       <paymentDate>dateTime</paymentDate>
  341.       <paymentID>guid</paymentID>
  342.       <paymentInfo>string</paymentInfo>
  343.       <seq>byte</seq>
  344.       <sitePaymentMethodID>guid</sitePaymentMethodID>
  345.       <remove>boolean</remove>
  346.       <paymentMethodName>string</paymentMethodName>
  347.       <paymentSubscriberMethodName>string</paymentSubscriberMethodName>
  348.     </paymentData>
  349.   </payments>
  350.   <RequestShipDate>dateTime</RequestShipDate>
  351.   <siteMisID>string</siteMisID>
  352.   <taxID>string</taxID>
  353.   <isOpenTerms>boolean</isOpenTerms>
  354.   <checkoutPaymentMethodID>guid</checkoutPaymentMethodID>
  355.   <checkoutPaymentMethodName>string</checkoutPaymentMethodName>
  356.   <checkoutPaymentSubscriberMethodName>string</checkoutPaymentSubscriberMethodName>
  357.   <IsOrderEdited>boolean</IsOrderEdited>
  358. </getOrderDetailResult>
  359.     </getOrderDetailResponse>
  360.  
 
 

getProduct

After receiving the list of ordered items, you may wish to retrieve more information about the product being ordered. Use the siteDomain string returned getOrderDetail as well as the productURL found in orderInfoItem (also from getOrderDetail) to retrieve more information about the product.

 

 
  1. <getProduct xmlns="http://w2p.aleyant.com/">
  2.       <Creds>
  3.         <consumerid>guid</consumerid>
  4.         <userName>string</userName>
  5.         <password>base64Binary</password>
  6.         <adminDomain>string</adminDomain>
  7.         <SubscriberID>guid</SubscriberID>
  8.       </Creds>
  9.       <siteDomain>string</siteDomain>
  10.       <urlName>string</urlName>
  11.     </getProduct>
 

This will return information about the product ordered:
 

 
  1. <getProductResult>
  2.         <origUrlName>string</origUrlName>
  3.         <MISID>string</MISID>
  4.         <IsInventoryTrack>boolean</IsInventoryTrack>
  5.         <IsFeatured>boolean</IsFeatured>
  6.         <IsDigitalOnly>boolean</IsDigitalOnly>
  7.         <ExpirationDate>dateTime</ExpirationDate>
  8.         <AcceptanceText>string</AcceptanceText>
  9.         <AcceptanceControl>string</AcceptanceControl>
  10.         <AllowNameEditinCart>boolean</AllowNameEditinCart>
  11.         <ProductLocationNotes>string</ProductLocationNotes>
  12.         <VendorID>guid</VendorID>
  13.         <VendorInstructions>string</VendorInstructions>
  14.         <DisplayProductImage>boolean</DisplayProductImage>
  15.         <UploadFields>string</UploadFields>
  16.         <UploadFieldDimensions>
  17.           <width>decimal</width>
  18.           <height>decimal</height>
  19.           <bleed>decimal</bleed>
  20.           <unit>points or inches or cm or mm</unit>
  21.         </UploadFieldDimensions>
  22.         <ShowScaledPreview>boolean</ShowScaledPreview>
  23.         <UploadLocksQuantity>string</UploadLocksQuantity>
  24.         <FileUploadRequired>boolean</FileUploadRequired>
  25.         <eDoc_Code>guid</eDoc_Code>
  26.         <eDoc_CaptureInfo>boolean</eDoc_CaptureInfo>
  27.         <eDoc_Instructions>string</eDoc_Instructions>
  28.         <eDoc_ApprovalText>string</eDoc_ApprovalText>
  29.         <Folding>string</Folding>
  30.         <Finishing>string</Finishing>
  31.         <Binding>string</Binding>
  32.         <Packaging>string</Packaging>
  33.         <ShortDescription>string</ShortDescription>
  34.         <LongDescription>string</LongDescription>
  35.         <uploadedProductImage>string</uploadedProductImage>
  36.         <ShowShippingEstimator>boolean</ShowShippingEstimator>
  37.         <MinimumPrice>decimal</MinimumPrice>
  38.         <TeaserPrice>decimal</TeaserPrice>
  39.         <AllowBackOrder>boolean</AllowBackOrder>
  40.         <ShowPricePerPiece>boolean</ShowPricePerPiece>
  41.         <VendorGetsNonMarkupPrice>boolean</VendorGetsNonMarkupPrice>
  42.         <MarkupQtyParam>string</MarkupQtyParam>
  43.         <CalculatorStyle>string</CalculatorStyle>
  44.         <CalculatorImageLinks>boolean</CalculatorImageLinks>
  45.         <CalculatorAllowArbQty1>boolean</CalculatorAllowArbQty1>
  46.         <CalculatorAllowArbQty2>boolean</CalculatorAllowArbQty2>
  47.         <CalculatorAllowArbQty3>boolean</CalculatorAllowArbQty3>
  48.         <CalculatorAllowArbQty4>boolean</CalculatorAllowArbQty4>
  49.         <CalculatorAllowArbQty5>boolean</CalculatorAllowArbQty5>
  50.         <CalculatorAllowDecimal1>boolean</CalculatorAllowDecimal1>
  51.         <CalculatorAllowDecimal2>boolean</CalculatorAllowDecimal2>
  52.         <CalculatorAllowDecimal3>boolean</CalculatorAllowDecimal3>
  53.         <CalculatorAllowDecimal4>boolean</CalculatorAllowDecimal4>
  54.         <CalculatorAllowDecimal5>boolean</CalculatorAllowDecimal5>
  55.         <DaysToShipInStock>int</DaysToShipInStock>
  56.         <DaysToShipOutofStock>int</DaysToShipOutofStock>
  57.         <GroupCalcs>
  58.           <ProductGroupCalcItem>
  59.             <CalcName>string</CalcName>
  60.             <productUrlName>string</productUrlName>
  61.             <groupName>string</groupName>
  62.             <priority>byte</priority>
  63.             <IsActive>boolean</IsActive>
  64.           </ProductGroupCalcItem>
  65.           <ProductGroupCalcItem>
  66.             <CalcName>string</CalcName>
  67.             <productUrlName>string</productUrlName>
  68.             <groupName>string</groupName>
  69.             <priority>byte</priority>
  70.             <IsActive>boolean</IsActive>
  71.           </ProductGroupCalcItem>
  72.         </GroupCalcs>
  73.         <ProductMarkups>
  74.           <ProductMarkup>
  75.             <ProductMarkupID />
  76.             <MarkupPercent>decimal</MarkupPercent>
  77.             <MaxQty>decimal</MaxQty>
  78.             <MinQty>decimal</MinQty>
  79.           </ProductMarkup>
  80.           <ProductMarkup>
  81.             <ProductMarkupID />
  82.             <MarkupPercent>decimal</MarkupPercent>
  83.             <MaxQty>decimal</MaxQty>
  84.             <MinQty>decimal</MinQty>
  85.           </ProductMarkup>
  86.         </ProductMarkups>
  87.         <AssignedCategories>
  88.           <categoryListItem>
  89.             <categoryName>string</categoryName>
  90.             <shortDescription>string</shortDescription>
  91.             <urlName>string</urlName>
  92.             <parentUrlName>string</parentUrlName>
  93.             <images xsi:nil="true" />
  94.             <isActive>boolean</isActive>
  95.           </categoryListItem>
  96.           <categoryListItem>
  97.             <categoryName>string</categoryName>
  98.             <shortDescription>string</shortDescription>
  99.             <urlName>string</urlName>
  100.             <parentUrlName>string</parentUrlName>
  101.             <images xsi:nil="true" />
  102.             <isActive>boolean</isActive>
  103.           </categoryListItem>
  104.         </AssignedCategories>
  105.         <SEO>
  106.           <content_language>string</content_language>
  107.           <title>string</title>
  108.           <keywords>string</keywords>
  109.           <description>string</description>
  110.           <revisit_after>string</revisit_after>
  111.           <robots>string</robots>
  112.           <author>string</author>
  113.           <copyright>string</copyright>
  114.         </SEO>
  115.         <HeadHTML>string</HeadHTML>
  116.         <FormName>string</FormName>
  117.         <WorkflowName>string</WorkflowName>
  118.         <KitOption>either or onlyInKit or onlyStandalone or isKit</KitOption>
  119.         <StockID>guid</StockID>
  120.         <Attributes>
  121.           <productAttributeItem>
  122.             <name>string</name>
  123.             <value>string</value>
  124.             <affectsPricing>boolean</affectsPricing>
  125.           </productAttributeItem>
  126.           <productAttributeItem>
  127.             <name>string</name>
  128.             <value>string</value>
  129.             <affectsPricing>boolean</affectsPricing>
  130.           </productAttributeItem>
  131.         </Attributes>
  132.         <AllowedGroups>
  133.           <string>string</string>
  134.           <string>string</string>
  135.         </AllowedGroups>
  136.         <MinQty>int</MinQty>
  137.         <MaxQty>int</MaxQty>
  138.         <ShowEdocProofInCart>boolean</ShowEdocProofInCart>
  139.         <MinQty1>decimal</MinQty1>
  140.         <MinQty2>decimal</MinQty2>
  141.         <MinQty3>decimal</MinQty3>
  142.         <MinQty4>decimal</MinQty4>
  143.         <MinQty5>decimal</MinQty5>
  144.         <MaxQty1>decimal</MaxQty1>
  145.         <MaxQty2>decimal</MaxQty2>
  146.         <MaxQty3>decimal</MaxQty3>
  147.         <MaxQty4>decimal</MaxQty4>
  148.         <MaxQty5>decimal</MaxQty5>
  149.         <DecPlaces1>int</DecPlaces1>
  150.         <DecPlaces2>int</DecPlaces2>
  151.         <DecPlaces3>int</DecPlaces3>
  152.         <DecPlaces4>int</DecPlaces4>
  153.         <DecPlaces5>int</DecPlaces5>
  154.         <VDPtech>string</VDPtech>
  155.         <OverrideTax>decimal</OverrideTax>
  156.         <MustShipSeparately>boolean</MustShipSeparately>
  157.         <EnableQuickView>boolean</EnableQuickView>
  158.         <SortOrder>int</SortOrder>
  159.         <SuggestedProducts>
  160.           <string>string</string>
  161.           <string>string</string>
  162.         </SuggestedProducts>
  163.       </getProductResult>
 

getWorkflowStageListByWorkflowName

Pressero supports the concept of “Workflows”, which is a list of stages (or statuses) that a job must go through to to be produced. Each product in Pressero is assigned a workflow, which means that each ordered item may potentially have a unique workflow to consider. The workflowName member returned in the OrderItemInfo from getOrderItemList is required to retrieve the list of workflow, using the getWorkflowStageListByWorkflowName method:


 

 
  1. <getWorkflowStageListByWorkflowName xmlns="http://w2p.aleyant.com/">
  2.       <creds>
  3.         <consumerid>guid</consumerid>
  4.         <userName>string</userName>
  5.         <password>base64Binary</password>
  6.         <adminDomain>string</adminDomain>
  7.         <SubscriberID>guid</SubscriberID>
  8.       </creds>
  9.       <workflowName>string</workflowName>
  10.     </getWorkflowStageListByWorkflowName>
 
This returns a list of the stages (statuses) in the particular workflow for the item:
 

 
  1. <getWorkflowStageListByWorkflowNameResult>
  2.         <workflowStageData>
  3.           <WorkflowStageID>guid</WorkflowStageID>
  4.           <WorkflowID>guid</WorkflowID>
  5.           <CustomerStage>string</CustomerStage>
  6.           <Department>string</Department>
  7.           <Description>string</Description>
  8.           <PrinterStage>string</PrinterStage>
  9.           <Seq>int</Seq>
  10.           <Meaning>string</Meaning>
  11.           <remove>boolean</remove>
  12.         </workflowStageData>
  13.         <workflowStageData>
  14.           <WorkflowStageID>guid</WorkflowStageID>
  15.           <WorkflowID>guid</WorkflowID>
  16.           <CustomerStage>string</CustomerStage>
  17.           <Department>string</Department>
  18.           <Description>string</Description>
  19.           <PrinterStage>string</PrinterStage>
  20.           <Seq>int</Seq>
  21.           <Meaning>string</Meaning>
  22.           <remove>boolean</remove>
  23.         </workflowStageData>
  24.       </getWorkflowStageListByWorkflowNameResult>
 

As each stage is user configurable, the “meaning” member of the structure tells you what the stage actually refers to. The meaning may be left blank, but if set, will always be one of the following: EstimateRequest, EstimateClarification, Quote, QuoteAcceptance, OrderReceived, Prepress, OnProof, Approved, Press, Bindery, Special, Shipping, OrderCompleted, OrderCancelled.
 

changeWorkflowStatus

To change the status of an item, you will use changeWorkflowStatus:
 

 
  1. <changeWorkflowStatus xmlns="http://w2p.aleyant.com/">
  2.       <creds>
  3.         <consumerid>guid</consumerid>
  4.         <userName>string</userName>
  5.         <password>base64Binary</password>
  6.         <adminDomain>string</adminDomain>
  7.         <SubscriberID>guid</SubscriberID>
  8.       </creds>
  9.       <orderItemId>guid</orderItemId>
  10.       <newstatus>string</newstatus>
  11.       <note>string</note>
  12. </changeWorkflowStatus>
 
The newStatus is the appropriate PrinterStage retrieved from the getWorkflowStageListByWorkflowName method. You may also include notes that will be stored in Pressero in the items’ status change history.

changeWorkflowStatus returns a boolean indicating success.
 

setShipment

To record actual shipments made, use the setShipment method:
 

 
  1. <setShipments xmlns="http://w2p.aleyant.com/">
  2.       <creds>
  3.         <consumerid>guid</consumerid>
  4.         <userName>string</userName>
  5.         <password>base64Binary</password>
  6.         <adminDomain>string</adminDomain>
  7.         <SubscriberID>guid</SubscriberID>
  8.       </creds>
  9.       <orderid>guid</orderid>
  10.       <shipments>
  11.         <shipmentInfo>
  12.           <shipmentID>guid</shipmentID>
  13.           <shipDate>dateTime</shipDate>
  14.           <cost>decimal</cost>
  15.           <seq>int</seq>
  16.           <tracking>string</tracking>
  17.           <destination>
  18.             <AddressID>guid</AddressID>
  19.             <isPreferred>boolean</isPreferred>
  20.             <Business>string</Business>
  21.             <FirstName>string</FirstName>
  22.             <LastName>string</LastName>
  23.             <Title>string</Title>
  24.             <Address1>string</Address1>
  25.             <Address2>string</Address2>
  26.             <Address3>string</Address3>
  27.             <City>string</City>
  28.             <StateProvince>string</StateProvince>
  29.             <Postal>string</Postal>
  30.             <Country>string</Country>
  31.             <Phone>string</Phone>
  32.             <Fax>string</Fax>
  33.             <Email>string</Email>
  34.           </destination>
  35.           <method>string</method>
  36.           <method_carrier>string</method_carrier>
  37.           <method_code>string</method_code>
  38.           <orderItemIDs>
  39.             <guid>guid</guid>
  40.             <guid>guid</guid>
  41.           </orderItemIDs>
  42.           <remove>boolean</remove>
  43.         </shipmentInfo>
  44.         <shipmentInfo>
  45.           <shipmentID>guid</shipmentID>
  46.           <shipDate>dateTime</shipDate>
  47.           <cost>decimal</cost>
  48.           <seq>int</seq>
  49.           <tracking>string</tracking>
  50.           <destination>
  51.             <AddressID>guid</AddressID>
  52.             <isPreferred>boolean</isPreferred>
  53.             <Business>string</Business>
  54.             <FirstName>string</FirstName>
  55.             <LastName>string</LastName>
  56.             <Title>string</Title>
  57.             <Address1>string</Address1>
  58.             <Address2>string</Address2>
  59.             <Address3>string</Address3>
  60.             <City>string</City>
  61.             <StateProvince>string</StateProvince>
  62.             <Postal>string</Postal>
  63.             <Country>string</Country>
  64.             <Phone>string</Phone>
  65.             <Fax>string</Fax>
  66.             <Email>string</Email>
  67.           </destination>
  68.           <method>string</method>
  69.           <method_carrier>string</method_carrier>
  70.           <method_code>string</method_code>
  71.           <orderItemIDs>
  72.             <guid>guid</guid>
  73.             <guid>guid</guid>
  74.           </orderItemIDs>
  75.           <remove>boolean</remove>
  76.         </shipmentInfo>
  77.       </shipments>
  78.     </setShipments>
 
Note that a shipment is set for the entire order, but the items that are in the shipment are also specified.
 

setSiteUser

Creating and updating user information is another common API method used. To edit a user, you should first use getSiteUser to retrieve the siteUser data structure, make edits, and then use setSiteUser to update the user information.

When editing a user, you do not need to supply the password unless you want the password to change. In addition, you do not need to pass the AddressBook array unless you are making modifications to the users address book.

setSiteUser will return the updated siteUser structure if successful, or a message if an error has occurred.

 

 
  1. <setSiteUser xmlns="http://w2p.aleyant.com/">
  2.       <creds>
  3.         <consumerid>guid</consumerid>
  4.         <userName>string</userName>
  5.         <password>base64Binary</password>
  6.         <adminDomain>string</adminDomain>
  7.         <SubscriberID>guid</SubscriberID>
  8.       </creds>
  9.       <sitedomain>string</sitedomain>
  10.       <newUserData>
  11.         <UniqueUserName>string</UniqueUserName>
  12.         <SubscriberID>guid</SubscriberID>
  13.         <IsActive>boolean</IsActive>
  14.         <FullName>string</FullName>
  15.         <Login>string</Login>
  16.         <Email>string</Email>
  17.         <Password>base64Binary</Password>
  18.         <userID>guid</userID>
  19.         <userType>string</userType>
  20.         <siteDomain>string</siteDomain>
  21.         <FirstName>string</FirstName>
  22.         <LastName>string</LastName>
  23.         <Title>string</Title>
  24.         <MISID>string</MISID>
  25.         <Culture>string</Culture>
  26.         <TZ>string</TZ>
  27.         <Phone>string</Phone>
  28.         <Fax>string</Fax>
  29.         <Addressbook>
  30.           <uAddress>
  31.             <AddressID>guid</AddressID>
  32.             <isPreferred>boolean</isPreferred>
  33.             <Business>string</Business>
  34.             <FirstName>string</FirstName>
  35.             <LastName>string</LastName>
  36.             <Title>string</Title>
  37.             <Address1>string</Address1>
  38.             <Address2>string</Address2>
  39.             <Address3>string</Address3>
  40.             <City>string</City>
  41.             <StateProvince>string</StateProvince>
  42.             <Postal>string</Postal>
  43.             <Country>string</Country>
  44.             <Phone>string</Phone>
  45.             <Fax>string</Fax>
  46.             <Email>string</Email>
  47.           </uAddress>
  48.           <uAddress>
  49.             <AddressID>guid</AddressID>
  50.             <isPreferred>boolean</isPreferred>
  51.             <Business>string</Business>
  52.             <FirstName>string</FirstName>
  53.             <LastName>string</LastName>
  54.             <Title>string</Title>
  55.             <Address1>string</Address1>
  56.             <Address2>string</Address2>
  57.             <Address3>string</Address3>
  58.             <City>string</City>
  59.             <StateProvince>string</StateProvince>
  60.             <Postal>string</Postal>
  61.             <Country>string</Country>
  62.             <Phone>string</Phone>
  63.             <Fax>string</Fax>
  64.             <Email>string</Email>
  65.           </uAddress>
  66.         </Addressbook>
  67.         <canViewPricing>boolean</canViewPricing>
  68.         <isTaxExempt>boolean</isTaxExempt>
  69.         <IsApproved>boolean</IsApproved>
  70.         <IsShared>boolean</IsShared>
  71.         <ApprovedByGroupName>string</ApprovedByGroupName>
  72.         <DefaultPONumber>string</DefaultPONumber>
  73.         <ShouldPreFillCheckout>boolean</ShouldPreFillCheckout>
  74.         <ApprovalPlanID>guid</ApprovalPlanID>
  75.         <IsGuestUser>boolean</IsGuestUser>
  76.         <GroupNames>
  77.           <string>string</string>
  78.           <string>string</string>
  79.         </GroupNames>
  80.         <LocationCode>string</LocationCode>
  81.         <LocationID>guid</LocationID>
  82.         <BossID>guid</BossID>
  83.         <DepartmentName>string</DepartmentName>
  84.         <PhotoPath>string</PhotoPath>
  85.         <ReceiveNotifications>boolean</ReceiveNotifications>
  86.         <ReceiveAllNotifications>boolean</ReceiveAllNotifications>
  87.         <CreateDate>dateTime</CreateDate>
  88.         <LastLogin>dateTime</LastLogin>
  89.         <LastOrder>dateTime</LastOrder>
  90.         <TaxID>string</TaxID>
  91.         <CapturePurchaseOrder>int</CapturePurchaseOrder>
  92.       </newUserData>
  93.     </setSiteUser>