Scribd
Upload
135 views3 pages

Web Service Specifications

This document provides information about Fulfillment Web Services including three services: AddOrder to place orders, GetOrderInfo to check order status, and GetShippingActivity to retrieve shipped orders. It describes the XML request and response formats, supported shipping carriers and codes, field length limits, and error handling for the web services.

Uploaded by

Ku Prabhu
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
135 views3 pages

Web Service Specifications

This document provides information about Fulfillment Web Services including three services: AddOrder to place orders, GetOrderInfo to check order status, and GetShippingActivity to retrieve shipped orders. It describes the XML request and response formats, supported shipping carriers and codes, field length limits, and error handling for the web services.

Uploaded by

Ku Prabhu
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 3

Fulfillment Web Services

Overview
The purpose of this document is to provide customers with the information they will need to
place orders in our fulfillment system, inquire on the status of orders and retrieve shipping
information.

There are three services that will be needed:

AddOrder is used to place an order.


GetOrderInfo is used to inquire on the status of an individual order.
GetShippingActivity will generate a list of orders that have shipped in a given time period.

XML files are provided along with this document. You can open them in the editor of your
choice. I recommend turning line numbers on in your editor as I will be referring to line
numbers within this document. Credentials in the sample XML files are not valid credentials.

General Information
Web Service URLs:
Endpoint: https://rhu027.veracore.com/pmomsws/order.asmx?wsdl
Web Service Documentation: https://rhu027.veracore.com/pmomsws/order.asmx
Web services test utility: https://rhu027.veracore.com/pmomsdev/wstest.aspx

AddOrder Web Service


Files: AddOrder Request.xml, AddOrder Response.xml
Head: Content-Type: text/xml; charset=utf-8
SOAPAction: http://sma-promail/AddOrder

The AddOrder Request.xml file contains the headers and body necessary for the AddOrders
request. I will go through the highlights, as most of the XML should be self-explanatory.

Line 17 is your order number. It must be unique. If you send a request with a duplicate order
number, it will be rejected. There is no provision for you to update an order through web
services.

Line 24 and 25: Please see the chart on the next page for freight codes and descriptions.

Lines 27 through 45 are the ordered by address, and lines 46 through 66 are the shipping
address. Note the Key value on line 48 of the shipping address. We’ll be using that later.
Lines 68 through 79 is one item in the order. Line 71 contains the SKU of the item, line 74
contains the quantity and line 78 contains the price for your customers of the item. Line 76
contains the key value for the ShipTo address, which was mentioned in the paragraph above.
You can use the combination of OrderShipTo addresses and keys to ship items to multiple
addresses within the same order. You can repeat this section as many times as you need to in
order to add items to the order.

Following is a table of the VeraCore shipping codes that we support:

VeraCore Carrier Description Carrier Service Type


Carrier
Code
U01 Next Day Air UPS Domestic
U43 Next Day Air Saver UPS Domestic
U07 2nd Day Air UPS Domestic
U21 3 Day Select UPS Domestic
U11 Ground UPS Domestic
U63 Worldwide Express Plus UPS International
U49 Worldwide Express UPS International
U98 Worldwide Saver UPS International
U54 Worldwide Expedited UPS International

Please use ISO 3166-1 Alpha-2 country codes (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-


2) for country abbreviations when shipping to international addresses.

Field Length Limitations for the AddOrder Web Service


 Order ID (order number) – 50 Characters
 Product ID (SKU) – 50 Characters
 Phone Numbers – 20 Characters (we often have issues with this one – people try to
append extensions with “x1234” and whatnot)
 Company Name – 50 Characters
 Address Lines 1 through 3 – 255 Characters each
 City – 50 Characters
 State or Province Code – 20 Characters
 Postal Code – 15 Characters
 E-Mail Address – 255 Characters

GetOrderInfo Web Service


Endpoint: https://rhu027.veracore.com/pmomsws/oms.asmx
Files: GetOrderInfo Request.xml, GetOrderInfo Response.xml
Head: Content-Type: text/xml; charset=utf-8
This web service will allow you to query the status of an order, one order at a time. The target
order number is on line 14.

The response XML should be self-explanatory. I think what you will probably be interested in
the most are lines 28 (backordered flag), 29 (shipped flag), 113 (date shipped) and 120 (tracking
number). Please look through the response file and let us know if you have any questions.

GetShippingActivity Web Service


Endpoint: https://rhu027.veracore.com/pmomsws/oms.asmx
Files: GetShippingActivity Request.xml, GetShippingActivity Response.xml
Head: Content-Type: text/xml; charset=utf-8

GetShippingActivity takes a StartDate and EndDate (lines 14 & 15) and returns information
about any shipments that occurred between those datetimes. Unfortunately, the data
returned by GetShippingActivity does not include a tracking number.

To get tracking numbers for all orders that shipped today, you’ll need to use
GetShippingActivity to get a list of all shipments for today, then iterate through each Order ID in
the response and use GetOrderInfo to retrieve the tracking number for that order ID.

Posting Shipping Activity to Veracore


Order and shipping status is not updated in Veracore until we post our shipping activity back to
the fulfillment system. Currently we normally post our activity twice a day, at 6PM and 11PM.
Querying the current day’s shipping activity prior to 6PM will normally yield no results, although
shipping activity is taking place throughout the day.

Return Codes from Web Service (Error Handling)


If you send an invalid request to ProMail, you will get a 500 response along with some XML
telling you what went wrong. For examples, please see the following files:

Failed Logon Response.xml


Invalid Offer Response.xml (if you send a SKU that we don’t have on file)

UPS API for Rating


To pull in the UPS published shipping rates for your shopping cart, please refer to the UPS
website instructions on how to use their Rating API.

Link:
https://www.ups.com/us/en/services/technology-integration/online-tools-rates-svc.page

You might also like