Version Date Author Comment 1.0 06/26/07 KS Initial draft 1.1 10/29/07 KS Added additional ship codes 2.0.0 05/19/08 CH Document converted to TSSG DigitalPCS PrintTalk Specifications 2.0.1 10/17/08 CH Added Element Details and additional Reponses 2.0.2 11/07/08 CH Added XML details for each XML 2.0.3 11/11/08 CH Doc converted to Phase One Purchase Order details only 2.0.4 11/14/08 CH Updated XML samples, XML Tag/Element Data, Document Versioning 2.0.5 1/30/09 CH Updated Page 5 - Assumptions and Requirements 2.0.6 3/04/09 CH Added ShipNotice Responses: Success and Error 2.0.7 8/20/09 CH Updated: Notes for the following tags- - Purchase Order | Credentials Handshake | Identity - Purchase Order | Message Type Header | Type - Purchase Order | Message Type Header | BusinessID - Purchase Order | JDF Component 1-Jacket | JDF DescriptiveName - Purchase Order | JDF Component 2-Text | JDF DescriptiveName - Purchase Order | JDF Component 3-Book | JDF DescriptiveName
Updated: Purchase Order XML sample | JDF Component 3 | ID to match the Delivery Line Item | ComponentRef rRef value
Updated: ShipNotice XML sample to include </ContactRef> in the Tracking Info | Drop Items section
Added: Cancel Order Request | Business Request | BusinessRefID
Added: Division tag to the Purchase Order | Message Type Header section. Also added tag and sample value to Purchase Order XML sample.
Added: POType tag to the Purchase Order | Message Type Header section. Also added tag and sample value to Purchase Order XML sample.
Added: GetOrderStatus XML samples for Multiple and Single order requests
Page 3 of 67 2.14 4/14 BB Changed out CGX verbage to TSSG where possible
Table of Contents
Intended Audience.. 4 Document Summary 4 Assumptions and Requirements. 5 Supported Transactions and Workflow. 6 XML Format Structure Overview .. 9 Purchase Order Request 10 Response: Success .. 23 Response: Failure.. 25 Get Order Status Request 27 Response: Success .. 31 Response: Failure.. 33 Cancel Order Request 35 Response: Success .. 37 Response: Failure.. 39 Update Shipping Option Request 41 Response: Success .. 50 Response: Failure.. 52 Shipment Notification Asynchronous Post .. 54 Response: Success .. 60 Response: Failure.. 61
Page 4 of 67 Intended Audience This document is intended for technical staff at TSSG Customer sites and TSSG to facilitate software engineering activities surrounding the implementation of the PrintTalk API integration into DigitalPCS.
Any questions pertaining to this document or the integration to DigitalPCS should be directed to you Customer Administrator or your assigned contact within TSSG.
Document Summary
This document outlines a system-to-system integration between Customers and TSSG for the transmission of digital data for printing and managing the surrounding workflow.
TSSG uses a partial implementation of the PrintTalk standard which is an open XML standard to communicate order submissions and other business information used in the Graphic Arts industry. The integration is into our in-house developed DigitalPCS application, which functions as a print management tool for our high volume repetitive Digital Printing type work.
We state we use a partial implementation because we only use a subset of the PrintTalk specification that pertains to submitting orders and misc. order level transactions, such as a providing an order status, or a shipment notification.
The PrintTalk specification itself allows for the complete definition of all the components of a print production job; from placing the order, including paper, ink, binding info, etc. For our purposes, many of the PrintTalk API flags are not used and may be omitted. Please refer to samples below for required and or optional fields.
An overview of PrintTalk:
PrintTalk was a community formed by print management systems and e-commerce companies to define a "best practice" common and open communications interface between companies who buy printed products, and those who manufacture them. The PrintTalk implementation supports and extends use of the broadly published, Job Definition Format (JDF) standard and Commercial eXtensible Markup Language (cXML). This PrintTalk specification is recognized as integral to the JDF standard.
The PrintTalk interface specification is distributed free of any license fees or royalties, in order to address the need for end-to-end connectivity in the printing industry. In 2004, an agreement was reached between CIP4, PrintTalk and NPES for CIP4 to both host the PrintTalk specification and to assume its continued development, insuring seamless integration with current and evolving versions of JDF. This is an evolution of the close working relationship that has existed between CIP4 and PrintTalk since its inception.
For more information on PrintTalk and complete Specification and Schemas, please visit the CIP4 Organizations website: http://www.cip4.org/documents/printtalk/intro.php.
Page 5 of 67
Assumptions and Requirements 1) Communication will occur between hosts via HTTP. 2) Interactions will be primarily synchronous. The requesting process will be blocked from further processing until a response is received or a timeout occurs. 3) Each interaction will consist of a request and response. Both the request and response will contain plain XML in http body, UTF-8 encoded. 4) Request will consist of HTTP POST, with the valid XML in the HTTP Body, to the TSSG specified published URL - HTTP Method: POST HTTP Content Type: text/xml HTTP Body: Valid XML Encoding.UTF8: UTF-8 5) Duplicate requests will be handled gracefully. The first request will be treated as authoritative and any data modifications on subsequent requests will be ignored. 6) Unicode characters will be supported in both requests and responses. 7) Assets for printing will be formatted in PDF. Any other formats must be discussed and pre- approved. 8) Assets will be passed by reference, and the references will be URLs linking back to customer file locations. 9) This version of the integration is designed to be very flexible and support orders with multiple line items that can be shipped to multiple destinations. 10) When placing an order a checksum can be provided for each asset. The checksum will be utilized to confirm successful download. Downloads will be re-attempted periodically until successful. Note that this is a Customer specific attribute and is optional. 11) Failed transmissions should be periodically re-attempted until a predetermined number or hours and attempts has elapsed. 12) Transaction numbers will be generated by the party initiating the transaction and should not change between attempts should a transmission failure occur. Systems should be designed to provide reliable message delivery.
Page 6 of 67 Supported Transactions & Workflow
Supported XML Transactions
The TSSG DigitalPCS PrintTalk API supports the transaction set noted below. A Customer integration may use all or a chosen set of these transactions.
1) Purchase Order a) Request b) Response Success c) Response Failure
2) Get Order Status a) Request b) Response Success c) Response Failure
3) Cancel Order a) Request b) Response Success c) Response Failure
4) Update Shipping Option a) Request b) Response Success c) Response Failure
5) Shipment Notification a) Asynchronous Post
Transaction Workflow
1. Purchase Order
Note: The Purchase Order and supporting XML transactions are required transactions.
The customer will notify TSSG about any new order using an HTTP POST method. The customer will submit a Purchase Order Request formatted like the Purchase Order Request XML sample below.
Page 7 of 67 The Purchase Order can be for a single Line Item or Multiple Line Items. Each Line Item will be made up of components.
A standard Line Item will consist of 2 components:
Text this component will contain the PDF for printing of the item Product this component will contain the Line Item level detail, such as the SKU ID.
A line item may contain more components than listed above. If Die Cutting, foil stamping or Distribution lists are being used, then those components will be necessary. We will speak to these options further down in the document.
If your product does not fit into this standard component structure that does not mean it is not an acceptable product. Please contact your Customer Administrator for guidance.
Once the Purchase Order is received the customer will receive a Purchase Order Response. This response will be either a Purchase Order Success response or a Purchase Order Failure response. Failures may be due to a variety of reasons, with the most comment being an invalid SKU or Ship Method.
2. Get Order Status
Note: The Get Order Status Request and supporting XML response transactions are optional transactions.
The GetOrderStatus request will be used to request the status on all open orders in the TSSG DigitalPCS system. The specific statuses returned can be formatted to your terminology but the most common are:
- Order Received - Content Downloaded - Press XML Generated - Submitted to Press - Printed - Packaged - Shipped - QA Hold - QA Reprint - Canceled - Ship Notified - Cancel Notified - Cancel Pending
Page 8 of 67 - Rejected - Shipment Staged - Shipment Picked Up - Submitted to Press Workflow
Like the Purchase Order, a GetOrderStatus response will be returned. This response will be either a GetOrderStatus - Success response which will contain all open orders with a Status for each line item, or a GetOrderStatus - Failure response, which may be due to a variety of reasons.
3. Cancel Order
Note: The Cancel Order Request and supporting XML response transactions are optional transactions.
Orders can be cancelled via one of two methods, by submitting a Cancel Order Request (which will initiate an automatic cancellation of the order) or by manually notifying the production facility. Obviously submitting a Cancel Order Request will be the most efficient and accurate.
Once the Cancel Order Request has been received a Cancel Order Response will be returned. Based on the state of the order either a Cancel Order Success or Cancel Order Failure will be returned. As part of the implementation process it will be determined which Order Statuses will allow for an order to be Cancelled.
4. Update Shipping Options
Note: The Update Shipping Option and supporting XML response transactions are optional transactions.
Prior to a shipment being made against an order, the Ship Method and/or Ship-To address may be changed via the Update Shipping Options transaction.
Once the Shipping Options have been updated, and they must be in a state prior to a Shipment for the Update to occur, an Update Shipping Option Success or an Update Shipping Options Failure will be returned.
5. Shipment Notification
Note: The Shipment Notification XML transaction is an optional transaction.
Once the entire order has been shipped (either directly into DigitalPCS or via our shipping system integration) a Shipment Notification will be sent to our customer (not the end user).
Page 9 of 67 Please note that we do not send Shipment Notification for partial shipments, only one comprehensive Shipment Notification is sent when the final shipment has been made. This notification will include, among other details, the shipment method, tracking number, weight, and a charge.
The Shipment Notification is the only transaction that is not initiated by the customer.
Page 10 of 67 XML Format Structure Overview
The format of most of the PrintTalk implementation can simply be described as JDF with a cXML wrapper around it (and a little PrintTalk in between).
Just like cXML, the top two nodes are Header and Request. The Header concept is taken directly from cXML. The Header identifies the parties involved in this correspondence. The Request node contains one (and only one) Business object. This is a high level view of the PrintTalk structure:
This document will focus only on the transactions and Tags/Elements required for the integration to DigitalPCS. For more details on the overall PrintTalk XML structure please visit: http://www.cip4.org/documents/printtalk/specification.html
Page 11 of 67 Note: This section provides XML examples that outline the structure of the XML transactions listed in the Supported Transaction section above. The primary requests and possible responses are included.
Also note that All PrintTalk Element/Tag noted below are required unless otherwise noted in the Optionality column for each transaction. Within the Notes column it will state if the data is required or not, and if it is a fixed data value it will be noted as Always and then the data value. Credentials/Handshake data is common across all XML transactions. Purchase Order Request
Purchase Order Request Elements and Tags
Purchase Order Request
XML Section PrintTalk Element/Tag Optionality Notes Header ?xml version="1.0" encoding="UTF-8" ? Required PrintTalk xmlns="http://www.printtalk.org/schema" Required xmlns:jdf="http://www.CIP4.org/JDFSchema_1_1" Required xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance" Required payloadID="2008-02-21T11:08:25-08:00.ACME- STANDARD-P-150047@Acme.com" Required timeStamp="2008-02-21T11:08:25-08:00" Required version="1.1" Required xsi:schemaLocation="http://www.printtalk.org/schema http://www.printtalk.org/schema/printTalk_1_1.xsd" Required Required Credentials/ HandShake Header Required From Required Credential domain Required Partner (customer) domain name, typically it ends with '.com'. Example: acmeprinting.com Identity Required Partner Name (customer name) Credential Required From Required To Required Credential domain Required Always 'cgx.com'
Page 12 of 67 Identity Required This value is normally 'orders@cgx.com'. Credential Required To Required Sender Required Credential domain Required Partner (customer) domain name, typically it ends with '.com'. Example: acmeprinting.com Identity Required Partner Name (customer name) SharedSecret Required An agreed upon Value/Password Credential Required UserAgent Required Your Product generating the Purchase Order XML Sender Required Header Required Message Type/ Header Request Required PurchaseOrder Required Signifies the type or Request AgentDisplayName Required Typically this is the Partner Computer System Name which does XML posting to us TSSG. e.g PartnerOrderSystemServer 1.0 or Customer Order Computer System Server 1.0 AgentID Required Typically this is the Partner computer System identity and version name e.g Partner Order system 1.0 WebOrderNumber Optional Web Order Number is an optional field that stores an alternate number that may be used to appear on a Packing Slip. This value is optional OrderedBy Optional This value will indicate the order by person on the order. This data is stored in the DPCS database to be used on production reports
Page 13 of 67 POType Optional This value will be used to signify a reset of the Order Content Download process. Use of this field must be reviewed with TSSG prior to implementation of use. Division Optional The value will be used to identify a specific 'Division' that the order is assigned to. This value will be from a list of agreed upon 'Divisions' with TSSG. BusinessID Required This value is the Customer Order Number.
If Alpha characters are to be used for this value they must be Uppercase. Lowercase letter will cause an issue with some of the barcodes functions in the production process. Currency Required Always 'USD' Expires Required RequestDate Required Should be the timestamp the Purchase Order XML was sent to TSSG jdf:JDF ID Required Always 'JDF-Root' JobID Required This value is the Customers Job Reference Number. Status Required Always 'Waiting' Type Required This value will represent the Order Type.
The list of valid Order Types will be defined between the Customer and TSSG.
The Order Type is used within DPCS to sort/filter order, and can also be used to define a specific SLA for the Order Type as well ad drive Packing Slip differences. Customer/ Contact Info CustomerInfo Required CustomerID Required Always 'Customer1' ContactRef rRef Required Always 'Contact1' CustomerInfo Required ResourceLinkPool Required
Page 14 of 67 DeliveryIntentLink Usage Required Always 'Input' rRef Required Always 'Delivery1' ResourceLinkPool Required Billing Address ResourcePool Required Contact Class Required Always 'Parameter' ContactTypes Required Always 'Billing' ID Required Always 'Contact1', links the Billing Address to the Contact above. Status Required Always 'Available' Address City Required Data Optional CountryCode Required Data Optional ExtendedAddress Required Data Optional PostalCode Required Data Optional Region Required Data Optional Street Required Data Optional Person FamilyName Required Data Optional FirstName Required Data Optional ComChannel ChannelType Required Always 'Phone' Locator Required Data Optional ComChannel ChannelType Required Always 'Email' Locator Required Data Optional Person Required Contact Required Shipping Address Contact Class Required Always 'Parameter' ContactTypes Required Always 'Shipping' ID Required The ID for this ShipTo address, 'Contact2' recommended Status Required Always 'Available' Address City Required ShipTo City CountryCode Required ShipTo Country - must match the agreed upon list of values. ExtendedAddress Required Shipto Address Line 2 PostalCode Required ShipTo ZipCode Region Required ShipTo State Street Required Shipto Address Line 1 Person FamilyName Required ShipTo person's Last name FirstName Required ShipTo person's First name ComChannel ChannelType Required Always' Phone'
Page 15 of 67 Locator Required Data Optional, ShipTo person'sPhone Number ComChannel ChannelType Required Always 'Email' Locator Required Data Optional, ShipTo Person's Email Address Person Required Contact Required Delivery Line Item DeliveryIntent Class Required Always 'Intent' ID Required The ID for this Delivery Line, 'Delivery1' recommended Status Required Always 'Available' Method DataType Required Always 'NameSpan' Preferred Required This value is the Ship Method. It must match the agreed upon list of values. DropIntent Required ContactRef rRef Required This value matches the Line Item to eb delivered to a ShipTo address above. DropItemIntent Required Amount Required This is the Quantity of the Line Item to Ship To addresses Unit Required Always 'Ea" ComponentRef rRef Required The Line Item for this Delivery. This will correspond to the final Component (Product) ResourcePool/ID DropItemIntent Required DropIntent Required DeliveryIntent Required ResourcePool Required JDF Component 1 - Text JDF DescriptiveName Required A descriptive name for the specific JDF Component node. Example: Jacket, Card, Text, Book. ID Required The JDF DescriptiveName with a 'jdf-' prefix. Example: jdf-jacket JobPartID Required The JDF DescriptiveName with a 'job-' prefix. Example: job- jacket. Status Required Always 'Waiting' Type Required Always 'Product' ResourceLinkPool Required
Page 16 of 67 ComponentLink rRef Required Same as the JDF DecsriptiveName noted above for this component ArtDeliveryIntentLink rRef Required The JDF DescriptiveName with a 'art-' prefix. Example: art-jacket. ResourceLinkPool Required One link for each attribute such as color, mediaIntent, DieCut, FoilIntent. ResourcePool Required Component Amount Required This Value is the Qty of the Component, usually '1'. This is not the Line Item Order Quantity. Class Required Always 'Quantity' DescriptiveName Required This is a truncated line item description , deliminated by "-". It must be a valid component name (i.e. Jacket), then a hyphen (-), the whatever descriptive name is desired. Example: jacket-T-2 ID Required Same as DescriptiveName noted above for this component ProductType Required The component identifier (from the agreed upon list of components, usually jacket, text or book. Status Required Always 'Available' MediaIntent Optional Class Optional Always 'Intent' ID Optional Should match the MediaIntentLink rRef item noted above for this component. Status Optional Always 'Available' FrontCoatings Optional DataType Optional Always EnumerationSpan Preferred Optional Consult TSSG for Values BackCoatings Optional DataType Optional Always EnumerationSpan Preferred Optional Consult TSSG for Values StrockType Optional DataType Optional Always EnumerationSpan Preferred Optional Consult TSSG for Values
Page 17 of 67 MediaColor Optional DataType Optional Always EnumerationSpan Preferred Optional Consult TSSG for Values USWeight Optional DataType Optional NumberSpan Preferred Optional Consult TSSG for Values Grade Optional DataType Optional IntegerSpan Preferred Optional Consult TSSG for Values ArtDeliveryIntent Required Class Required Always 'Intent' ID Required Should match the ArtDeliveryIntentLink rRef item noted above for this component. ArtDelivery ArtDeliveryType Required Always 'DigitalNetwork' RunList Required LayoutElement Required FileSpec Required CheckSum Required Checksum value is based on MD5 checksum FileSize Required This value is the CheckSum value. If you required a Checksum to validate the file you must conform to the MD5 checksum value ie the number of bytes in the file (e.g. - 3563101699). FileVersion Required Always '1' URL Required This is the URL for the component PDF Asset LayoutElement Required RunList Required ArtDeliveryIntent Required ResourcePool Required JDF Required JDF Component 2 -Product JDF DescriptiveName Required A descriptive name for the specific JDF Component node. Example: Jacket, Text, Book.
The 'non-Print' component is usually described as a 'Product'.
Page 18 of 67 ID Required The JDF DescriptiveName with a 'jdf-' prefix. Example: jdf-book JobPartID Required The JDF DescriptiveName with a 'job-' prefix. Example: job-book Status Required Always' Waiting' Type Required Always 'Product' ResourceLinkPool Required ComponentLink Usage Required Always 'Output' rRef Required Same as the JDF DecsriptiveName noted above for this component ComponentLink Usage Required Always 'Input' rRef Required Same as the JDF DecsriptiveName noted above for Component1 BindingIntentLink rRef Required Always 'Bind' SizeIntentLink rRef Required No data required ResourceLinkPool Required ResourcePool Required Component Amount Required This value is the Line Item Order Quantity Class Required Always 'Quantity' DescriptiveName Required This value is used for a End User Description. It can be used as the Line Item Desription on the Packing Slip. ID Required This value is used as the Line Item Identifier. It is used throughout the Order to link the Line Item to specific ShipTo/Delivery elements. Status Required Always 'Available' BindingIntent Required BindingOrder Required No data required Class Required Always 'Intent' ID Required Same as BindingIntentLink rRef noted above for this component Status Required No data required BindingType Required DataType Required Always 'EnumerationSpan' Preferred Required This value is used as the SKU ID for the Line Item. This value must match the agreed upon list of SKU's for this customer.
Page 19 of 67 HardCoverBinding Required Jacket DataType Required No data required Preferred Required No data required HardCoverBinding Required SpineWidth Required BindingIntent Required SizeIntent Class Required No data required ID Required No data required Status Required Dimensions DataType Required No data required Preferred Required No data required Range Required No data required Pages DataType Required No data required Preferred Required This value is the Page Count for the Line Item SizeIntent Required ResourcePool Required JDF Required Footer jdf:JDF Required PurchaseOrder Required Request Required PrintTalk Required
Sample XML: Purchase Order Request
Following is a sample of a Purchase Order XML for a Single Line Item order. Note that the XML sample shows separations by section for example purposes. All other XML samples in this document are presented as straight XML.
Page 23 of 67 Once a Purchase Order Request has been processed, a Response XML message will be generated and returned to the Sender. The Purchase Order Response will be either a Success or Failure response. Purchase Order Response: Success Note: All response XML adheres to a standard format, with the Business Request section varying by response type. All tags for each response type are noted as required and will always be present.
Purchase Order Response: Success Elements and Tags
Page 26 of 67 RequestDate Required BusinessID Required BusinessRefID Required Request Required DescriptiveName Required This Value will be a Code ID for the Comment Value below. jdf:Comment Required This value will note the reason(s) why the order has failed to be received. Refusal Required Request Required Footer PrintTalk Required
Page 27 of 67 - <!-- <jdf:Comment>Error Retrieving Info from Database"</jdf:Comment> --> </Refusal> </Request> </PrintTalk>
Optional Purchase Order JDF nodes The following code blocks are for the optional Diecut, Foil, and DistList JDF nodes. Please inquire with TSSG prior to implementation of these sections.
The GetOrderRequest will result in a response that lists each Order/Line Item, and the status of each Line Item, for Orders that have not yet been Shipped, Cancelled or voided. The GetOrderStatus Request can be run as often as the customer requires.
Page 29 of 67 xmlns:jdf="http://www.CIP4.org/JDFSchema_1_1" Required xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance" Required payloadID="2007-04-16T16:32:02-07:00.ABC-STANDARD- P-35893@ABC.com" Required timeStamp="2007-04-16T16:32:02-07:00" Required version="1.1" Required xsi:schemaLocation="http://www.printtalk.org/schema http://www.printtalk.org/schema/printTalk_1_1.xsd"> Required Credentials/ Handshake Header Required From Required Credential domain Required Identity Required Credential Required From Required To Required Credential domain Required Identity Required Credential Required To Required Sender Required Credential domain Required Identity Required SharedSecret Required Credential Required UserAgent Required Sender Required Header Required Business Request Request Required OrderStatusRequest Required Signifies the Request type AgentDisplayName Required AgentID Required BusinessID Required Value can be 'ALL', 'Multiple' or 'Single' RequestDate Required StatusRequest JobIDRef Optional If the Business ID is 'Multiple' or 'Single' this value will be the order number(s) for which the status is requested.
Page 30 of 67 Request Required Footer PrintTalk Required
Page 32 of 67 </Credential> </From> - <To> - <Credential domain="printer.com"> <Identity>orders@printer.com</Identity> </Credential> </To> - <Sender> - <Credential domain="ABC.com"> <Identity>ABC</Identity> <SharedSecret>XXXXXXXX</SharedSecret> </Credential> <UserAgent>ABC BookServe 1.3</UserAgent> </Sender> </Header> - <Request> - <!-- NOTICE THE BUSINESSID IS SET TO "SINGLE" --> - <OrderStatusRequest AgentDisplayName="ABC BookServe 1.3" AgentID="ABC1.0" BusinessID="SINGLE" RequestDate="2007-04-16T16:32:02-07:00"> - <!-- THE JOBID WOULD BE THE ID THAT WAS BEING SENT AS THE BUSINESSID PREVIOUSLY --> <StatusRequest JobIDRef="ABC-STANDARD-P-#######" /> </OrderStatusRequest> </Request> </PrintTalk>
Page 33 of 67 Get Order Status Response: Success Get Order Status Response: Success Elements and Tags XML Section PrintTalk Element/Tag Optionality Notes Header ?xml version="1.0" ? Required PrintTalk xmlns="http://www.printtalk.org/schema" Required xmlns:jdf="http://www.CIP4.org/JDFSchema_1_1" Required xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance" Required payloadID="2007-04-16T16:32:02-07:00.ACME- STANDARD-P-35893@ACME.com" Required timeStamp="2007-04-16T16:32:02-07:00" Required version="1.1" Required xsi:schemaLocation="http://www.printtalk.org/schema http://www.printtalk.org/schema/printTalk_1_1.xsd"> Required Credentials/ Handshake Header Required From Required Credential domain Required Identity Required Credential Required From Required To Required Credential domain Required Identity Required Credential Required To Required Sender Required Credential domain Required Identity Required SharedSecret Required Credential Required UserAgent Required Sender Required Header Required Business Request Request Required OrderStatusResponse Required Signifies a GetOrderResponse trx type AgentID Required AgentDisplayName Required
Page 34 of 67 RequestDate Required BusinessID Required Status JobIDRef Required This value will be listed for each Order/Line Item, noting a Status for Each Line. OrderStatusResponse Required Request Required Footer PrintTalk Required
Sample XML: GetOrderStatus Response: Success <?xml version="1.0" encoding="UTF-8" ?> <PrintTalk xmlns="http://www.printtalk.org/schema" xmlns:jdf="http://www.CIP4.org/JDFSchema_1_1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" payloadID="2007-05-10T15:10:32-07:00.ACME- STANDARD-P-42906@Acme.com" timeStamp="2007-05-10T15:10:32-07:00" version="1.1" xsi:schemaLocation="http://www.printtalk.org/schema http://www.printtalk.org/schema/printTalk_1_1.xsd"> <Header> <From> <Credential domain="printer.com"> <Identity>orders@printer.com</Identity> </Credential> </From> <To> <Credential domain="Acme.com"> <Identity>Acme</Identity> </Credential> </To> <Sender> <Credential domain="xxxx.com"> <Identity>orders@printer.com</Identity> <SharedSecret>XXXXXXXX</SharedSecret> </Credential> <UserAgent>xxx-B2B 1.0</UserAgent> </Sender> </Header> <Request> <!-- Once again, BusinessID = "ALL" --> <OrderStatusResponse AgentID="xxx-B2B1.0" AgentDisplayName="printer B2B Handler 1.0" RequestDate="2007-04- 17T01:30:25-04:00" BusinessID="ALL"> <!-- The status of all live, unshipped jobs, excluding any cancelled or voided orders --> <!-- Single Line Item Order --> <Status JobIDRef="ACME-STANDARD-P-12345:job-P-37633">Downloaded</Status> <Status JobIDRef="ACME-STANDARD-P-12346:job-P-37634">Imported</Status> <Status JobIDRef="ACME-STANDARD-P-12347:job-P-37635">Lotted</Status> <Status JobIDRef="ACME-STANDARD-P-12347:job-P-37635">Downloaded</Status> <Status JobIDRef="ACME-STANDARD-P-12347:job-P-37635">Hold</Status> <!-- Multiple Line Item in one Order --> <Status JobIDRef="ACME-STANDARD-P-12348:job-P-37637">Printed</Status>
Page 35 of 67 <Status JobIDRef="ACME-STANDARD-P-12348:job-P-37638">Packaged</Status> <!-- And all other Active Orders will follow --> </OrderStatusResponse> </Request> </PrintTalk Get Order Status Response: Failure
Get Order Status Response: Failure Elements and Tags XML Section PrintTalk Element/Tag Optionality Notes Header ?xml version="1.0" encoding="UTF-8" ? Required PrintTalk xmlns="http://www.printtalk.org/schema" Required xmlns:jdf="http://www.CIP4.org/JDFSchema_1_1" Required xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance" Required payloadID="2007-04-16T16:32:02-07:00.ACME- STANDARD-P-35893@ACME.com" Required timeStamp="2007-04-16T16:32:02-07:00" Required version="1.1" Required xsi:schemaLocation="http://www.printtalk.org/schema http://www.printtalk.org/schema/printTalk_1_1.xsd"> Required Credentials/ Handshake Header Required From Required Credential domain Required Identity Required Credential Required From Required To Required Credential domain Required Identity Required Credential Required To Required Sender Required Credential domain Required Identity Required SharedSecret Required Credential Required UserAgent Required Sender Required Header Required
Page 36 of 67 Business Request Request Required Refusal Required Signifies a Failure to the GetOrderStatus RequestGetOrderResponse trx type AgentID Required AgentDisplayName Required RequestDate Required BusinessID Required DescriptiveName Required jdf:Comment Required This value will be list the error noted. Refusal Required Request Required Footer PrintTalk Required
Page 37 of 67 <!-- Any Error specific to an order (e.g. missing data) will go in normal OrderStatusResponse node.: --> <jdf:Comment>Error retrieving info from database</jdf:Comment> </Refusal> </Request> </PrintTalk>
Page 39 of 67 AgentID Required BusinessID Required The Customer Order Number to be Cancelled BusinessRefID Required This will be the TSSG assigned order number. RequestDate Required Request Required Footer PrintTalk Required
XML Section PrintTalk Element/Tag Optionality Notes Header ?xml version="1.0" ? Required PrintTalk xmlns="http://www.printtalk.org/schema" Required xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance" Required xsi:schemaLocation="http://www.printtalk.org/schema http://www.printtalk.org/schema/PrintTalk_1_1.xsd" Required xmlns:jdf="http://www.CIP4.org/JDFSchema_1_1" Required version="1.1" Required payloadID="2007-03-02T11:16:01- 05:00.3952.15@cgx.com" Required Credentials/ Handshake Header Required From Required Credential domain Required Identity Required Credential Required From Required To Required Credential domain Required Identity Required Credential Required To Required Sender Required Credential domain Required Identity Required SharedSecret Required Credential Required UserAgent Required Sender Required Header Required Business Request Request Required Confirmation Required Signifies that the Order was successfully Cancelled AgentID Required AgentDisplayName Required
Page 41 of 67 RequestDate Required BusinessID Required BusinessRefID Required Order Number that was cancelled DescriptiveName Required jdf:Comment Required Order Cancelled Confirmation Required Request Required Footer PrintTalk Required
The Update Shipping Options Request is EXACLTY the same as the Purchase Order Request with the exception of the fields highlighted in the Tags and Attributes grid below. These fields all pertain to the Shipment Header.
All other fields are required to contain the exact same data that was submitted in the initial Purchase Order Request.
Credential Required From Required To Required Credential domain Required
Identity Required
Credential Required
Page 45 of 67 To Required Sender Required Credential domain Required Identity Required SharedSecret Required Credential Required UserAgent Required Sender Required Header Required Message Type/ Header Request Required PurchaseOrder Required AgentDisplayName Required AgentID Required BusinessID Required ReplaceID Required This value will be the TSSG Order Number (IntOrderNumber) Currency Required Expires Required RequestDate Required jdf:JDF ID Required JobID Required Status Required Type Required Customer/ Contact Info CustomerInfo Required CustomerID Required ContactRef rRef Required CustomerInfo Required ResourceLinkPool Required DeliveryIntentLink Usage Required rRef Required ResourceLinkPool Required Billing Address ResourcePool Required Contact Class Required ContactTypes Required
Page 46 of 67 ID Required Status Required Address City Required CountryCode Required ExtendedAddress Required PostalCode Required Region Required Street Required Person FamilyName Required FirstName Required ComChannel ChannelType Required Locator Required ComChannel ChannelType Required Locator Required Person Required Contact Required Shipping Address Contact Class Required ContactTypes Required ID Required Status Required Address City Required This value can be updated CountryCode Required This value can be updated ExtendedAddress Required This value can be updated PostalCode Required This value can be updated Region Required This value can be updated Street Required This value can be updated Person FamilyName Required This value can be updated FirstName Required This value can be updated ComChannel ChannelType Required Locator Required This value can be updated ComChannel ChannelType Required Locator Required This value can be updated Person Required Contact Required Delivery Line Item DeliveryIntent Class Required ID Required Status Required Method DataType Required
Page 47 of 67 Preferred Required This value can be updated DropIntent Required ContactRef rRef Required DropItemIntent Required Amount Required Unit Required ComponentRef rRef Required DropItemIntent Required DropIntent Required DeliveryIntent Required ResourcePool Required JDF Component 1 - Jacket JDF DescriptiveName Required ID Required JobPartID Required Status Required Type Required ResourceLinkPool Required ComponentLink rRef Required ArtDeliveryIntentLink rRef Required ResourceLinkPool Required ResourcePool Required Component Amount Required Class Required DescriptiveName Required ID Required ProductType Required Status Required ArtDeliveryIntent Required Class Required ID Required Status Required ArtDelivery ArtDeliveryType Required RunList Required LayoutElement Required FileSpec Required FileSize Required FileVersion Required URL Required
Page 48 of 67 LayoutElement Required RunList Required ArtDeliveryIntent Required ResourcePool Required JDF Required JDF Component 2 - Text JDF DescriptiveName Required ID Required JobPartID Required Status Required Type Required ResourceLinkPool Required ComponentLink rRef Required ArtDeliveryIntentLink rRef Required ResourceLinkPool Required ResourcePool Required Component Amount Required Class Required DescriptiveName Required ID Required ProductType Required Status Required ArtDeliveryIntent Required Class Required ID Required Status Required ArtDelivery ArtDeliveryType Required RunList Required LayoutElement Required FileSpec Required FileSize Required FileVersion Required URL Required LayoutElement Required RunList Required ArtDeliveryIntent Required ResourcePool Required JDF Required
Page 49 of 67 JDF Component 3 - Book JDF DescriptiveName Required ID Required JobPartID Required Status Required Type Required ResourceLinkPool Required ComponentLink Usage Required rRef Required ComponentLink Usage Required rRef Required ComponentLink Usage Required rRef Required BindingIntentLink rRef Required SizeIntentLink rRef Required ResourceLinkPool Required ResourcePool Required Component Amount Required Class Required DescriptiveName Required ID Required Status Required BindingIntent Required BindingOrder Required Class Required ID Required Status Required BindingType Required DataType Required Preferred Required HardCoverBinding Required Jacket DataType Required Preferred Required HardCoverBinding Required SpineWidth Required BindingIntent Required SizeIntent Class Required ID Required Status Required
Page 54 of 67 RequestDate Required BusinessID Required Number of Order successfully updated BusinessRefID Required Request Required Footer PrintTalk Required
Page 56 of 67 RequestDate Required BusinessID Required Order Number DescriptiveName Required jdf:Comment Required Notes why the Shipping Options cannot be updated for the Orders Refusal Required Request Required Footer PrintTalk Required
Shipping can be complex. A single, conceptual shipment may consist of multiple packages. Separate tracking numbers may be provided for each package. Additionally, each package could consist of different products. A single shipment might not constitute the entire order (a partial shipment). And a single order may consist of multiple Line Items that are to be sent to multiple Ship-To destinations.
The Shipment Notification should be thought of as a simple mechanism to highlight the shipment of the entire order. Only when the entire order is shipped (which could be a single or multiple shipments) will a Shipped Notification be sent.
Page 59 of 67 Credential Required UserAgent Required Sender Required Header Required Ship To Details Request Required OrderStatusResponse Required AgentId Required AgentDisplayName Required RequestDate Required BusinessID Required BusinessRefID Required Order Number that was Shipped Status JobIDRef Required Notes that the Order has 'Shipped'. JDF ID Required Always 'JDF-Root' JobID Required Type Required Always 'Product' Status Required Signifies a 'Completed' Shipment. There are no partial shipment notifications, the shipment notification is only sent upon final shipment of entire order. Version Required ResourceLinkPool Required DeliveryParamsLink Required rRef Required Notes the Delivery #. If there are multiple shipments for the order there will be a Delivery Pool for each shipment. Usage Required ResourceLinkPool Required ResourcePool Required Contact ID Required The Ship-To location ID for the Shipment. Class Required Always 'Parameter' Status Required Always 'Available' ContactTypes Required Always 'Shipping' Address Street Required Address Line 1 ExtendedAddress Required Address Line 2 City Required City Region Required State
Page 60 of 67 PostalCode Required Zip Code Person FirstName Required First Name FamilyName Required Company Class Required Always 'Parameter' Status Required Always 'Available' OrganizationName Required Contact Required Box Level Details Component ID Required Each Box in the Shipment will be noted by PackedBox#, where '#' is the box number of the box. Amount Required Always 'Parameter' Unit Required Always 'Each' Class Required Always 'Quantity' Status Required Always 'Complete' ComponentType Required Always 'Bundle' ProductID Required The End User Description for the Line Item. ProductType Required Always 'Bundle' xmlns Required Bundle BundleType Required Always 'Box' TotalAmount Required The # of Unique Line Items in the Box BundleItem Amount Required Always '1'. ComponentRef rRef Required JobID from 'Book' component for 1st Line Item in Box BundleItem Required Repeated for each unique Line Item in Box BundleItem Amount Required Repeated for each unique Line Item in Box ComponentRef rRef Required Repeated for each unique Line Item in Box BundleItem Required Bundle Required Component Required Line Item Details Component ID Required JobID from 'Book' component for 1st Line Item in Box Amount Required Always 'Parameter' Unit Required Always 'Each'
Page 61 of 67 Class Required Always 'Quantity' Status Required Always 'Complete' ComponentType Required Always 'Book' ProductID Required End User Description of the Line Item ProductType Required Always 'Book' Price Required A calculated Unit Price of the Line Item. This value will only be calculated if Pricing data has been defined in DigitalPCS. Pricing is optional. DeliveryParams ID Required Notes the Delivery ID. Class Required Always 'Params' rRefs Required Signifies the Ship-To ID for the Box Shipped Status Required Always 'Complete' Method Required The Shipment Method for the Shipment Tracking Info Drop Required ContactRef rRef Required The Contact ID for the Shipment DropItem Amount Required The Qty of Boxes on the Shipment Unit Required Always 'Each' TrackingID Required The Shipment Tracking number. TotalWeight Required The Total Weight of the Shipment Pricing Item Required Always 'Shipping' Price Required The Total Shipment Price ComponentRef rRef Required Always 'PackedBox1' DropItem Required
Page 62 of 67 EndStatus Required Signifies a 'Completed' Shipment. There are no partial shipment notifications, the shipment notification is only sent upon final shipment of entire order. TimeStamp Required The time the Shipment Notification was created. AuditPool Required JDF Required OrderStatusResponse Required Request Required Footer PrintTalk Required