4imprint Link
Application Overview:
4imprint Link is an application that enables the automated retrieval of purchase orders and their associated artwork files from 4imprint as they become available. This is done through interaction with a Windows Communication Foundation (WCF) web service and the artwork downloads that are already part of the 4imprint Springboard website. Purchase orders are transferred as XML via WS over HTTPS with Mixed mode security, and artwork is transferred via HTTPS. In addition, the client can automatically update itself. Update downloads are via HTTP.
A broad overview of the service interaction follows:
- The client periodically polls the service to see if any purchase orders are available.
- When a purchase order is available, the client makes a request for the next PO. The PO is saved to disk and it is examined to see if any artwork is needed.
- A PO Success/Failure message is sent to the service as appropriate.
- If artwork is needed (ie the ArtworkUri element has data), the client attempts to download it and do an MD5 check. If the MD5 check is successful, the artwork is saved to disk.
- An Artwork Success/Failure message is sent to the service as appropriate.
- This continues while there are still POs to be downloaded, then the client returns to periodic polling.
How it works
Example 1
Example 2
Example 3
XML Tag Definitions:
<PURCHORDER>: this root element contains very broad information regarding the purchase order.
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<PODATE> |
datetime |
This is a timestamp on when the purchase order was downloaded via the Link application. |
2011-08-19T15:20:33.060 |
<SUPPNAME> |
string |
The name of the supplier the purchase order has been issued to. |
Test Supplier |
<SALES_PERSON> |
string |
The name of the 4imprint CSR that issued this order. |
Kyle Straveler |
<POTAG> |
string |
4imprint's purchase order number. |
13968481-1 |
<NEXTPOTAG> |
string |
If this order is being sent to another decorator instead of the customer, this tag contains the reference number for the decorator. |
NMPO No: 6127623L1/3235300 |
<ARTWORKURL> |
string |
A URL to the vector artwork for this purchase order. |
<ARTWORKMD5> |
string |
The MD5 value that was calculated on the artwork file downloaded via Link. The Link application uses this value to check the downloaded artwork to be sure there was no corruption in the download. |
<DIVADDR>: this root element contains address and contact information for 4imprint.
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<DIVNAME> |
string |
This will be the 4imprint Division that this order came from. Most common values will be either '4imprint' or 'Canada'. |
4IMPRINT |
<DIVISION_ADDRESS> |
string |
4imprint's address information. |
101 Commerce St Oshkosh, WI 54901 www.4imprint.com |
<DIVPHONE> |
string |
Phone number for 4imprint. |
Tel 920-236-7272 |
<DIVFAX> |
string |
Fax number for 4imprint. |
Fax 920-236-7282 |
<DIVEMAIL> |
string |
This will be the CSR's email address that issued the order. |
[email protected] |
<SUPPADDR>: this root element contains address and contact information for the supplier the purchase order has been issued to.
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<SUPPNAME> |
string |
The name of the supplier the purchase order was issued to. |
TEST SUPPLIER |
<SUPPADDR1> |
string |
The address of the supplier the purchase order was issued to. |
721 Washington Ave |
<SUPPADDR2> |
string |
Additional address information for the supplier. |
<SUPPADDR3> |
string |
Additional address information for the supplier. |
<SUPPADDRTOWN> |
string |
City of the supplier the purchase order was issued to. |
OSHKOSH |
<SUPPADDRCOUNTY> |
string |
State abbreviation of the supplier. |
WI |
<SUPPADDRPOSTCODE> |
string |
Zip code of the supplier. |
54901 |
<SUPPADDRCOUNTRY> |
string |
Country of the supplier. |
USA |
<SUPPPHONE> |
string |
Supplier phone number. |
800-282-3448 |
<SUPPFAX> |
string |
Supplier fax number. |
727-329-4355 |
<DELADDR>: this root element contains the shipping address information on the purchase order.
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<DELSUPPNAME> |
string |
If the order is shipping to another supplier for further decorating, this element will contain the name of the supplier being shipped to. |
4imprint- Embroidery |
<DELNAME> |
string |
Company name for the customer. |
Test Company |
<DELCONTACT> |
string |
Contact name for the customer. |
Test Customer |
<DELADDRJOBTITLE> |
string |
Job title of the customer. |
Owner |
<DELADDR1> |
string |
Address Line 1 for the shipment. |
1234 Test Street |
<DELADDR2> |
string |
Address Line 2 for the shipment. |
<DELADDRTOWN> |
string |
City for the shipment. |
Oshkosh |
<DELADDRCOUNTY> |
string |
State code for the shipment. |
WI |
<DELADDRPOST_CODE> |
string |
Post code for the shipment. |
54901 |
<DELADDRCOUNTRY> |
string |
Country for the shipment. |
USA |
<DELADDRPHONE> |
string |
Customer telephone number. |
920-236-1234 |
<DELADDRSHIPPINGACC> |
string |
Customer third party billing number if applicable. |
<ORDERLINE>: this root element contains the details on the product being ordered.
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<ORDERQTY> |
int |
Total quantity being ordered on this purchase order. |
150 |
<HasAttributes> |
string |
Indicates if the total quantity has a breakdown of colors or attributed items (if Y, see the OLPCA elements). |
N |
<ALIAS> |
string |
The supplier part number for this order. If the value is 'see below', refer to the OLPCA element for the breakdown of colors and aliases. |
7113 |
<PRODDESC> |
string |
Description of the product being ordered. |
Test Product |
<BASECAPTION> |
string |
Description of the 'base' of the item being ordered. |
Case |
<TRIMCAPTION> |
string |
Description of the 'trim' of the item being ordered. |
Brush |
<BASECOLDESC> |
string |
Description of the base color of the item being ordered. If the value is 'see below', refer to the OLPCA elements for the color breakdowns. |
Black |
<TRIMCOLDESC> |
string |
Description of the trim color of the item being ordered. If the value is 'see below', refer to the OLPCA elements for the color breakdowns. |
Black |
<UNITCOST> |
decimal |
Per piece cost of the item being ordered. |
0.5940 |
<COSTVALUE> |
decimal |
Total cost of the item being ordered. |
89.10 |
<POTOTAL> |
decimal |
Total value of this purchase order (including any applicable extras). |
114.10 |
<ARTINST> |
string |
Special instructions relating to the artwork on this order. |
(various) |
<SUPPINST> |
string |
Special instructions for the supplier on this order. |
(various) |
<CONTACTNAME> |
string |
If order has been secured at the supplier, the supplier contact name will show here. |
n/a |
<SHIPDATE> |
string |
4imprint's estimated ship by date to meet customer's in-hand date. |
8/25/2011 |
<AGREEDDATE> |
string |
Date agreed order must be received by in order to meet our shipment date. |
8/19/2011 |
<FREEISSUE> |
string |
<LASTSUPPLIER> |
string |
4imprint internal reference for orders with multiple vendors. |
<LASTSUPPSHIP> |
string |
4imprint internal reference for orders with multiple vendors. |
N/A |
<OLINSTRUCTIONS> |
string |
Additional instructions related to this order from 4imprint CSR's. |
<ARTWORKREQUIRED> |
string |
4imprint internal reference for orders with multiple vendors. |
Y |
<OLPCA>: this root element contains product information when the product ordered has additional elements (apparel size/color breakdowns, pen color/nib size breakdowns, etc.).
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<OLID> |
int |
4imprint internal reference number for the order line. |
11319987 |
<OLPCAQTY> |
int |
Quantity for this particular color combination or attribute. |
12 |
<OLPCAALIAS> |
string |
If the order contains multiple colors or attributed items, the supplier alias will be displayed in this section. |
TESTPRODUCT1234 |
<OLPCAProductAttributeId> |
int |
4imprint internal reference number for the attribute ordered. |
2 |
<OLPCADESC> |
string |
Description of the attribute. |
Medium, Black Ink, Extra Large |
<OLPCAATTRCODE> |
string |
4imprint internal code for the attribute ordered. |
M |
<OLPCABASECOL> |
string |
Base color of the item ordered. |
Green |
<OLPCATRIMCOL> |
string |
Trim color of the item ordered. |
Green |
<OLPCACOSTADJUSTMENT> |
decimal |
Additional charges for the attribute ordered (for example an upcharge for an extra-large size item) |
0.0000 |
<OLPCATOTALADJUSTMENT> |
decimal |
Total value of the adjustments. |
0.00 |
<OLPCASEQUENCE> |
int |
4imprint internal reference. |
4 |
<EXTRA>: this root element contains information on additional charges applicable to the purchase order (Setup charges, running charges, etc.).
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<EXTRACODE> |
string |
Description of the extra charge applicable to this order. |
Set-Up Charge |
<QTY> |
int |
Quantity of the extra ordered. |
2 |
<UNITCOST> |
decimal |
Individual cost of the extra. |
10.0000 |
<COSTVALUE> |
decimal |
Total value of the extra. |
20.00 |
<BASETRIM>: this root element contains the color information of the item ordered.
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<BASECOLOUR> |
string |
Description of the base color of the item ordered. |
Green |
<TRIMCOLOUR> |
string |
Description of the trim color of the item ordered. |
Green |
<OLIMPLOC>: this root element contains the imprint location details for the item ordered.
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<ImprintLocationId> |
int |
4imprint internal reference number for the imprint location. |
2 |
<LOCATION> |
string |
Description of the imprint location desired. |
Front |
<ARTINST> |
string |
Special instructions needed for the order (this should be rare). |
<OLIMPLOCCOL>: this root element contains the imprint color details for the item ordered.
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<PantoneColourId> |
int |
4imprint internal reference number for the imprint color needed. |
1746 |
<PANTONECOL> |
string |
Description of the imprint color needed. |
Red (Standard) |
<MULTIDELADDR>: this root element contains shipping information if the order is to be shipped to multiple locations.
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<MULTIDELCONTACT> |
string |
Name of the customer. |
Test Customer |
<MULTIDELADDRJOBTITLE> |
string |
Job title of the customer. |
Owner |
<MULTIDELNAME> |
string |
Company name for shipment. |
Test Company |
<MULTIDELADDR1> |
string |
Address Line 1 for the shipment. |
1234 Test Street |
<MULTIDELADDR2> |
string |
Address Line 2 for the shipment. |
<MULTIDELADDR3> |
string |
Address Line 3 for the shipment. |
<MULTIDELADDRTOWN> |
string |
City for the shipment. |
Oshkosh |
<MULTIDELADDRCOUNTY> |
string |
State code for the shipment. |
WI |
<MULTIDELADDRPOST_CODE> |
string |
Post code for the shipment. |
54901 |
<MULTIDELADDRCOUNTRY> |
string |
Country for the shipment. |
USA |
<MULTIDELADDRPHONE> |
string |
Phone number for the shipment. |
920-236-1234 |
<MULTIDELADDRFAX> |
string |
Fax number for the shipment. |
920-236-1235 |
<MULTIDELADDRDEST> |
string |
Indicates if the shipment is going to the customer or to another supplier for further decorating. |
Customer |
<CUSTOMER_PO_REF> |
string |
Customer's reference number for the order. |
12345678 |
<MULTIDELADDRSHIPPINGACC> |
string |
Customer third party billing number if applicable. |
<DELADDRLINE>: this root element contains additional shipping information for the purchase order.
TAG NAME |
DATA TYPE |
DESCRIPTION |
EXAMPLE VALUES |
<ORDER_QTY> |
int |
Total order quantity for shipment. |
36 |
<ITEM_DESC> |
string |
Description of the item being shipped. |
Test Product |
<SHIP_BY> |
datetime |
4imprint's estimated ship by date to meet customer's in-hand date. |
2011-08-25T00:00:00 |
<CARRIER_SERVICE> |
string |
Shipment method for this order. |
UPS Ground (Parcel) |
<DUE_DATE> |
datetime |
In-hand date for the customer to receive their order. |
2011-08-31T00:00:00 |
<FREIGHT> |
string |
Estimated freight charge for order based on delivery method and ship to address. |
7.01 |
Need more information?
To receive further information from 4imprint on the 4imprint Link application and to receive installation instructions/access to the application, please contact [email protected].