Import Order Request : DocketManager

This document provides instructions and example code for DocketManager’s ImportOrderRequest (IOR)API. DocketManager’s IOR allows external systems to send orders to a DocketManager site. Using a post request DocketManager will parse the required XML and convert the provided information into the DocketManager MIS system.

PostURL

IOR post requests need to be sent to the following url:

Url: [DocketManagerSiteURL]/api/importorderrequest

SampleUrl: https://dmxml.docketmanager.net/api/importorderrequest

Note

Unique order ID will be amended to "Imported Order" for Order Name

i.e. Imported Order - 123456790

XML Elements & Attributes

Element	Description	Required
ImportOrderRequest	Root element Attribute:Version=”1.0” (required)	*
ServiceInformation	Parent element Information about the service sending the post request	*
ServiceName	Service Name,Version Number etc.	*
ServiceUrl	URL the request was sent from	*
ServiceTransactionId	Unique Identifier for the order/request (for auditing purposes)	*
Customer	Parent element Information about the Customer	*
CustomerId	Unique Identifier for the Customer NOTE: If this identifier matches an External Identifier on a customer on the DocketManager site, the order will be created for that customer. If there is no match, a new customer will be created.	*
Name	Customer name	*
Phone	Customer phone number
Email	Customer email address
ContactName	Contact name NOTE: Will try to find a contact belonging to the customer based on a name, phone number and email match, and will create a new one if no full match is found.	*
ContactPhone	Contact phone number
ContactEmail	Contact email address	*
ShippingLocation	Parent element Shipping Location information Note: If no shipping location is provided, the system will use the default shipping location on the contact. If the contact does not have a default shipping location, it will use the customer's default shipping location. If the customer does not have a default shipping location, the order shipping location will be left blank. If the customer is new, any values provided will be set as the customer's default shipping location.
AddressName	Shipping address name Note: This is a "name" that describes the address. i.e the customer name, default shipping address, location 1, etc.
Address	Shipping address
City	Shipping city
PostalZipCode	Shipping postal / zip code
ProvinceState	Shipping province/state
Country	Shipping country
ShippingMethod	ShippingType Note: Will try to find a shipping type based on a name match. This value will also be imported in a shipping note on the order
BillingLocation	Parent Element Billing Location information Note: If no billing location is provided, the system will use the default billing location on the contact. If the contact does not have a default billing location, it will use the customer's default billiing location. If the customer does not have a default billing location, the order billing location will be left blank. If the customer is new, any values provided will be set as the customer's default billing location.
AddressName	Billing address name Note: This is a "name" that describes the address. i.e the customer name, default billing address, head office, etc.
Address	Billing address
City	Billing city
PostalZipCode	Billing postal / zip code
ProvinceState	Billing province/state
Country	Billing country
Order	Parent element Information pertaining to the Order	*
OrderId	Unique Identifier for the Order	*
OrderDate	Date the order was placed (M/d/yyyy h:mm:sstt)	*
Name	Order name
GenericNote	Order generic note
PurchaseOrderNumber	PO number
ShippingTotal	Shipping total for the order	*
SubTotal	Sub total for the order Should equal the sum of the Item (ItemTotal+ ShippingTotal)	*
TaxTotal	Tax total for the order	*
TaxPercentage	Tax percentage used to calculate the Tax Total	*
GrandTotal	Grand Total for the Order Should equal Sub Total+Tax Total	*
PaymentMethod	Method used to pay for the order e.g.CreditCard,PayPaletc.
Paid	Mark the Order as fully paid: Boolean (True/False) – defaults to True	*
Posted	Mark the Order as posted: Boolean (True/False) – defaults to True	*
Items	Parent element List of Items	*
ItemTotal	Item’s total price This will be the overridden price of the item	*
Quantity	Item quantity This will be the selected quantity on the item.	*
Item Name	Item name This will amend to the end of the current name of the product.
Item Code	Item product code (Unique Identifier from the requesting service) *Note:* A Product with an external identifier (on the Online Tab of the Product) matching this item product code must be present in the DocketManager site receiving the post request.	*
Description	Item description This will amend to the end of the current description of the product.
StockName	Paper stock name and description e.g. Bond blue 24lb offset This will be included in the press note.
FinishSize	Item finish size e.g. 8.5 X 11 This will be included in the press note.
ColorProcess	Print color process e.g. 4/4 This will be included in the press note.
ColorName	Ink color names e.g. Reflex Blue, Pantone Metallic 8783C This will be included in the press note.
ColorCode	Ink color code PMS Reflex Blue, 8783 This will be included in the press note.
PressNote	General print/press notes & printing instructions
ArtworkNote	General graphic/artwork notes & instructions
DownloadUrl	URL to art work file (will be downloaded)

* Note the required elements and attributes

Response

Once a post request is sent a simple string response is returned depending on the outcome of the request.

The Response message is sent in the following format.

Success=[True/False]|Message=[ReturnedMessage]

Example Responses:

Succeeded

Success =True|Message=This Order has been successfully imported as Order# 1279

Failed

Success = False|Message = ImportOrderRequest - Failed: Could no timport this order because Order# 1279 already exists with the external Order ID '115067326'. It appears that it has already been imported (ValidationException)
Success = False|Message = Import Order Request - Failed : Failed to deserialize input, this is the error occurred: YAXLib. YAX Attribute Missing Exception:Noattributeswiththisnamefound:'./Version'.

Example XML:

The following is an example of the xml structure which includes all required and optional elements:

<?xml version="1.0" encoding="UTF-8"?>

<ServiceName>ExternalService</ServiceName>

<ServiceUrl>http://google.com</ServiceUrl>

</ServiceInformation>

<Name>Test Customer 1</Name>

<Email>democompany@democompany.com</Email>

<ContactName>DemoContact</ContactName>

<ContactEmail>democontact@democompany.com</ContactEmail>

</Customer>

<AddressName>Shipping Address</AddressName>

<Address>123FakeSt.</Address>

<City>SanFrancisco</City>

<ProvinceState>California</ProvinceState>

<ShippingMethod>Fedex</ShippingMethod>

</ShippingLocation>

<AddressName>Billing Address</AddressName>

<Address>123FakeSt.</Address>

<City>SanFrancisco</City>

<ProvinceState>California</ProvinceState>

</BillingLocation>

<Order>

<OrderName> Order #1234 - Cards</OrderName>

<GenericNote>Order to completed</GenericNote>

<PaymentMethod>CreditCard</PaymentMethod>

<Items>

<Item>

<ItemName>BizCards</ItemName>

<Description>Fullcolorbusinesscards</Description>

<StockName>BondThick</StockName>

<PressNote>Runthis12up</PressNote>

<ArtworkNote>Noedits required,thanks.</ArtworkNote>

<DownloadUrl>https://dmxml.docketmanager.net/Crm/Customers/CustomerView.aspx?Id=0939f8bb-bb4b-4038-933f-9ce258a48bf3</DownloadUrl>

</Item>

<Item>

<ItemName>PostCardSmall</ItemName>

<Description>Simplesmallpostcards</Description>

<StockName>PostCardStock</StockName>

<ArtworkNote>Pleaseupdatethesaledateinformation</ArtworkNote>

<DownloadUrl>https://dmxml.docketmanager.net/Crm/Customers/CustomerView.aspx?Id=0939f8bb-bb4b-4038-933f-9ce258a48bf3</DownloadUrl>

</Item>

</Items>

</Order>

</ImportOrderRequest>

Import Order Request Print

Related Articles