Orders API: order details

16/04/2009

This interface gives direct access to all web-to-print order details by OrderID.

Order details

Example: http://posters.example.com/api.aspx?page=api-order;ApiKey=532525b4-10fe-4424-bf8f-890cb8bd57a1;OrderID=DDAA54F2-CD80-4DCB-8148-8B875135B17F

Domain name: custom only.

Page: api.aspx

Required parameters:

  • page=api-order
  • ApiKey={your api key}
  • OrderID={take the value from OrderID attribute in order list}

Response:

  • order details on success
  • 404 or application error message on error

Remarks

The response contains most of order details stored in our web-to-print database, including user input and images. Some internal technical parameters of the files are omitted. Once all the order details are known to your client application it should make decisions on which resources to download.

Order details do not change, except for payment, status and comments. Saved orders have no output files generated. If the user completes a saved order it is likely to be deleted and replaced with a new order with a different ID.

All resources referenced from order details are static and should be cached forever.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<OrderDetails OrderID="DED1395F-FE39-48B0-BE2C-0CFEC3BA1B83" CreatedBy="realestate@zetaprints.com" Created="2009-04-16T01:26:08.800" Status="test" BilledByZP="2000-01-01T00:00:00" StatusHistory="" ProductPrice="" ProductName="A5 marketing card" PDF="pdf/2994701c-3d2f-479f-8c59-ba20254f044b.pdf" CDR="pdf/b2fd362f-d5e8-4a49-939c-54ee5cf2981a.cdr" ApprovalEmail="" Note="I have no comments at the moment." CostCentre="" DeliveryAddress="No delivery necessary for this is a test order." QuantityPriceChoice="500 cards, delivered $1.00" OptionalChoice="" UserReference="" PaidDateTime="" Currency="" DeliveryStreet1="" DeliveryStreet2="" DeliveryTown="" DeliveryState="" DeliveryZip="" DeliveryCountry="">

<UserDetails Name="Real estate signs demo" Address="PO Box 32012

Wellington" Contact="This is a demo site. Please, contact support@zetaprints.com with all your questions." Phone="04-569-22-15" Fax="n/a" Business=""/>


<Pages>

<Page PreviewImage="preview/db6c6548-bf65-4bec-936b-52f3d2be32b1-0.jpg" PageWidthCm="21.2" PageHeightCm="15"/>

<Page PreviewImage="preview/2736378c-6d94-4f04-b529-792262484bfb-1.jpg" PageWidthCm="15" PageHeightCm="21.2"/>

</Pages>

<Images>

<Image OriginalName="200534972-001.jpg" Name="Insert Photo 1" FileID="D9E63E8A-73F7-48A8-B562-33A3ACD79A01"/>

<Image OriginalName="200534965-001.jpg" Name="Insert Photo 2" FileID="B7521880-9A4E-4A0A-9DC1-6D941280115B"/>

<Image OriginalName="image1.jpg" Name="Insert Photo 3" FileID="88CCD054-1C07-419F-9D71-19EC2327051C"/>

<Image OriginalName="stockxpertcom_id437740_size2.jpg" Name="Main Image" FileID="96FF5A5B-8B3B-446D-A51C-49DBAF9B9F68"/>

</Images>

<Fields>

<Field FieldName="Main heading" FieldValue="Not for sale" Comment=""/>

<Field FieldName="Property Address" FieldValue="73 Nowhere Rd" Comment=""/>

<Field FieldName="Price Details" FieldValue="$1.99" Comment=""/>

<Field FieldName="Description" FieldValue="Mister Twister Acapulc wants to sell his house.

Low price, lots of mice." Comment=""/>


<Field FieldName="Property Details" FieldValue="No cats allowed" Comment=""/>

<Field FieldName="Contact Details" FieldValue="Do not call

Do not visit

Online only" Comment=""/>


<Field FieldName="Email Address Agent 1" FieldValue="agent@example.com" Comment=""/>

<Field FieldName="Bedrooms" FieldValue="1" Comment=""/>

<Field FieldName="Living" FieldValue="1" Comment=""/>

<Field FieldName="Bathrooms" FieldValue="2" Comment=""/>

<Field FieldName="Garages" FieldValue="4" Comment=""/>

<Field FieldName="Study" FieldValue="5" Comment=""/>

<Field FieldName="Title" FieldValue="Das us a great property" Comment=""/>

<Field FieldName="Property description" FieldValue="Concrete CMS today announced the general availability of its easy-to-use open source CMS product, Concrete5. The new release builds on Concrete's foundation offering of a CMS that is as easy to configure as a blog, with the flexibility of a full web development platform. Improvements in Concrete5 include an updated file manager, embedded Picnik image editor, new help system and more. Concrete's main competitors in the CMS space are Drupal and Joomla, but Silicon Florist says Concrete5 crushes them in terms of ease-of-use." Comment=""/>

</Fields>

<Fonts/>

<Comments/>

</OrderDetails>]
See also: