Web Services Integration

stalksurveyorΑσφάλεια

3 Νοε 2013 (πριν από 4 χρόνια και 9 μέρες)

126 εμφανίσεις

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

1

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald





Web Services Integration

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

2

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Table of Contents

Preface

................................
................................
................................
................................
...........................
4

Audience and Prerequisites

................................
................................
................................
.......................
4

Overview

................................
................................
................................
................................
....................
4

Integration Overview

................................
................................
................................
................................
.....
5

SOAP Integration

................................
................................
................................
................................
.......
5

Examples

................................
................................
................................
................................
....................
5

Simple Order Tracking Integration

................................
................................
................................
........
5

Cart Based Order Entry Integration

................................
................................
................................
.......
6

Express Order Entry Integration

................................
................................
................................
............
7

REST / Simple XML Integration

................................
................................
................................
..............
7

Exception Handling

................................
................................
................................
................................
....
8

UserManager (V1)

................................
................................
................................
................................
.........
9

Description

................................
................................
................................
................................
................
9

WSDL

................................
................................
................................
................................
.........................
9

Login a User

................................
................................
................................
................................
...............
9

Description

................................
................................
................................
................................
............
9

Notes

................................
................................
................................
................................
.....................
9

Services

................................
................................
................................
................................
..................
9

Validate a Users Session Id

................................
................................
................................
.....................

11

Description

................................
................................
................................
................................
.........

11

Notes

................................
................................
................................
................................
..................

11

Services

................................
................................
................................
................................
...............

11

INFOplus (V3M3)

................................
................................
................................
................................
........

12

Description

................................
................................
................................
................................
.............

12

WSDL

................................
................................
................................
................................
......................

12

Application Entity Descr
iptions

................................
................................
................................
..............

12

Customer Entity Details

................................
................................
................................
......................

12

Item Entity Details

................................
................................
................................
..............................

13

Item Inventory Entity Detail

................................
................................
................................
...............

13

Vendor Entity Details

................................
................................
................................
..........................

13

Cart L
ine Item Entity Details

................................
................................
................................
...............

13

Cart Extra Info Entity Details

................................
................................
................................
..............

14

Cart Entity Details

................................
................................
................................
...............................

14

Order Entity Details

................................
................................
................................
............................

15

Order Line Item Entity Details

................................
................................
................................
............

16

Order Payment Entity Details

................................
................................
................................
.............

16

Web Service Application Versioning

................................
................................
................................
..........

17

API Console

................................
................................
................................
................................
.............

17

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

3

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Access

................................
................................
................................
................................
.................

21

Code Definitions

................................
................................
................................
................................
.........

22

Service Type
s

................................
................................
................................
................................
..........

22

Carrier

................................
................................
................................
................................
.....................

23

Order Type

................................
................................
................................
................................
..............

24

Transaction Type

................................
................................
................................
................................
....

24

Product Types

................................
................................
................................
................................
.........

24

Requisition Types

................................
................................
................................
................................
....

24

Reorder Codes

................................
................................
................................
................................
........

24

Countries

................................
................................
................................
................................
................

24

Credit Card Type

................................
................................
................................
................................
.....

24

Exceptions

................................
................................
................................
................................
...............

25




INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

4

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Preface

This document gives a technical ove
rview of the Web

Service integration capabilities for
INFOplus.

It covers
the
basic application concept and versioning overviews, security and
fulfillment services APIs.

Audience and Prerequisites

The intent of this document is to provide a technical aud
ience interested in implementing

a
SOAP 1.1, SOAP 1.2 or REST style integration with
INFOplus with a basic understanding
of
fulfillment concepts

and

general web services concepts, SOAP or REST service offerings and Web
Service Description Language (WSDL) f
iles.

Overview

This document provides conceptual and technical information for application integration
between
INFOplus

and outside party ordering and order management systems
, providing
basic
concepts in simple use
-
cases along with pseudo
-
code examples
.
The API console and the
individual application WSDL
URLs

are available

for in
-
depth service descriptions
.

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

5

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Integration Overview

Integrations between
INFOplus

and outside parties can range
from

simple single service calls,
like order tracking, to complex f
ull integrations including everything for real
-
time inventory
levels, order placement, order tracking, vendor, SKU, restriction, and PO management.

All API
s

provide both SOAP and REST integration options and can be mixed and matched as
needed by a client.

SOAP Integration

A SOAP integration path is available for systems that support SOAP 1.1 or SOAP 1.2
.

The SOAP protocol is high
ly verbose and provides for a machine
-
to
-
machine

communication,
where the client has the ability to generate class stubs from WS
DL files and then interact directly
with the generated code, leaving the protocol and its transport to the supplied framework.

Example
s

Simple Order Tracking Integration

Client
UserManagerLogin
loginUser
sessionId
InfoPlus
getOrderDetails
Order
logoutUser

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

6

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Cart Based Order Entry Integration

Client
UserManagerLogin
loginUser
sessionId
InfoPlus
getItemDetails
Item
verify items availability
createCustomer
Customer
createRecipient
Recipient
createCart
Cart
updateCartDetails
addItemToCart
placeOrder
Order
logoutUser


INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

7

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Express Order Entry Integration

Client
UserManagerLogin
loginUser
sessionId
logoutUser
create customer
create recipient
create cart
create array of cart items
placeOrder
orderId
InfoPlus


REST / Simple XML Integration

A REST or Simple XML integration path is available for systems that support REST clients, lack a
SOAP client framework, or customers
wanting to create a custom client based on HTTP
GET/POSTs with XML return messages.

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

8

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Exception Handling

When an error occurs making a request to a web service, information about the error is
returned in the server response.

SOAP requests return errors in a

SOAP fault element inside the body of the returned SOAP
envelope. The fault string element inside the SOAP fault element contains a human readable
error message of what problem occurred. Inside the detail element, there is an error element
containing the
exception name and the
aforementioned

error message.

XML request return only the error element.

SOAP Exception Example


<?xml version="1.0"?>

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">


<soapenv:Body>


<soapenv:Fault>



<faultcode>soapenv:Client</faultcode>


<faultstring>Could not find customer with id [xxx].</faultstring>


<detail>


<error>


<exception>CustomerNotFoundException</exception>


<message>Could not find customer with id [xxx].</message>


</e
rror>


</detail>


</soapenv:Fault>


</soapenv:Body>

</soapenv:Envelope>


REST / XML Exception
Example


<error>


<exception>CustomerNotFoundException</exception>


<message>Could not find customer with id [xxx].</message>

</error>



INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

9

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


UserManager

(V1)

Description

The UserManager

applicatio
n
allow
s

a client to create an active session for a known user
account and to test to
verify
if that session is still valid

on an as
needed

basis
.

A valid session is
necessary
to access all other application services.

WSDL

http://www.materialogic.com/~soapdev/sas.axis2/services/UserManagerV1?wsdl

(development server)

Available Protocols



SOAP 1.1



SOAP 1.2



REST

Login a User

Description

A valid username, password and inventory number is required to create a working session for a
user. All other services require a working session for access
.

A failed login attempt result
s

in an exception bei
ng thrown with the appropriate error message.

T
he
loginUser

method within the UserManager API

ties all
calls from this session
to the

user

s
inventory.

Notes



Fo
r security reasons,
the application returns
only a general error message
for
a bad
username and password combination.



Depending on the account configuration, an account may
lock

after consecutive failed
login attempts
.



Contact the inventory
Account Servi
ce Rep (ASR) for account configuration details.



A session become
s

invalid after a
period of non
-
use. The default
-
session timeout value
is
four

hours.



Contact the inventory ASR
for

account configuration details.

Services

UserManager
V1.loginUser
()

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

10

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Throws



RequiredParameterMissingException



AccessDeniedException



InvalidSessionException



SessionException



SOAP
Example


UserManagerV1 uml = new UserManager
V1();


Try

{


String sessionId = uml.loginUser(“johndoe”, “abcd
-
1234”, 8001);

}

Catch(Error e)

{


// Could not log in user


look at error message

}


REST / XML
Example

Request


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

<loginUser xmlns="http://v1.usermgr.external.content.materialogic.com">

<username>demo</username>

<password>abcd
-
1234</password>

<
inventoryNo>9999</inventoryNo>

</loginUser>



REST / XML
Example

Response


<ns:loginUserResponse
xmlns:ns="http://v1.usermgr.external.content.materialogic.com">

<return>be8cc5e2
-
1e03
-
4c22
-
90f7
-
7b321a33f392</return>

</ns:loginUserResponse>



INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

1
1

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Validate a U
sers Session Id

Description

A client can
verify
if a given sessionId, returned from a login user request, is still valid via the
validateSession service. The service will return a Boolean result indicating if the sessionId is valid
or not.

Notes

Each successful call to validateSession will also update the last used timestamp for that session
.

For security reasons, consecutive calls to validateSession
may by throttled by delaying the
response times of the service
.

Services

UserManager
V1.validateS
ession
()

Throws



RequiredParameterMissingException



AccessDeniedException



InvalidSessionException



SessionException


SOAP
Example


UserManagerV1 uml = new UserManager
V1();


String sessionId = ”f81d4fae
-
7dec
-
11d0
-
a765
-
00a0c91e6bf6”;

Boolean isSessionValid = u
ml.validateSession(sessionId);


REST / XML
Example

Request


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

<validateSession
xmlns="http://v1.usermgr.external.content.materialogic.com">


<sessionId>780d96a5
-
59ca
-
4820
-
8110
-
4b4e52b62a8e</sessionId>

</validateSession
>



REST / XML
Example

Response


<ns:validateSessionResponse
xmlns:ns="http://v1.usermgr.external.content.materialogic.com">


<return>true</return>

</ns:validateSessionResponse>


INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

12

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


INFOplus

(
V3M3
)

Description

INFOplus p
rovide
s

order entry, order tracking, inventory management,
and
customer
management integration with third party applications
.
It serves as the external API for
the
INFOplus application.

WSDL

http://www.materialogic.com/~soapdev/sas.axis2/services/InfoPlus
V3M3
?wsdl

(development server)

Available Protocols



SOAP 1.1



SOAP 1.2



REST

Application Entity Descriptions

Below is an

listing of several common entities that will be used in a typical web service
integration.

Customer Entity Details


Entity


Description

Type

Length

Required

city

City of the customer

Text

35

Yes

company

Company name of the customer

Text

35

No

country

Country of the customer

Text

35

Yes

email

Email address of the customer

Text

50

No

externalCustomerId

External Id of the customer

Text

20

No

fax

Fax No of the customer

Text

20

No

id

Unique identifier for a customer,
which is generated by the system
when the createCustomer operation
is used

Text

10

-

miscNumericValue1

Miscellaneous place to store an
arbitrary numeric value

Integer

-

No

miscNumericValue2

Miscellaneous place to store an
arbitrary numeric value

Integer

-

No

name

Name of the customer

Text

35

Yes

phone

Phone No of the customer

Text

20

No

state

State of the customer

Text

2

Yes

street 1

Street 1 of the customer

Text

35

Yes

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

13

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


street 2

Street 2 of the customer

Text

35

No

street 3

Street 3 of the customer

Text

35

No

zip

Zip of the customer

Text

15

Yes

Item Entity Details

Entity


Description

Type

Length

Required

id

Unique identifier (SKU) for this cart item.

Text

20

Yes

description

Description for the item

Text

250

No

name

Name of the item

Text

40

Yes

productTypeId

Id of the product type for this item

Integer

-

Yes

outsideVendorId

Id of the vendor for this item

Integer

-

No

reorderCode

Reorder code for this item



see
Reorder
Codes

Text

1

No

Item Inventory Entity Detail

Entity


Description

Type

Length

Required

description

Description for the item

T
ext

250

No

itemId

Id of
the item being ordered

Text

36

Yes

quantityAvailable

Amount of item available for shipping

Integer

10

No

quantityOnHand

Total amount of item in warehouse

Integer

10

No

quantityOnOrder

Quantity not yet received into the
warehouse

Integer

10

No

reserved

Total unfilled demand

Integer

10

No

totalOnBackOrder

Unfilled demand due to unavailable
stock

Integer

10

No

Vendor

Entity Details

Entity


Description

Type

Length

Required

city

C
ity of vendor

Text

16

No

contact

C
ontact info for vendor

Text

30

No

country

C
ountry of vendor

Text

12

No

fax

F
ax number of vendor

Text

20

No

id

I
d of vendor

Integer

-

Yes

name

V
endor name

Text

36

Yes

phone

P
hone number of vendor

Text

20

No

state

S
tate of vendor

Text

2

No

street1

S
treet 1 value of vendor


Text

30

No

street2

S
treet 2 value of vendor


Text

30

No

z
ip

Z
ip code of vendor

Text

15

No

Cart
Line
Item Entity Details


Entity


Description

Type

Length

Required

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

14

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Id

Unique identifier for this cart item
which is generated when the
createCartItem operation is called

UUID

36

-

itemId

Id of the item being ordered

Item Id

36

Yes

quantity

Quantity of the item being ordered

Integer

-

Yes

unitPrice

Price of the item being ordered

Money

36

No

cartItemExtraInfoIdList

List of extra info records for this
cart item

List

-

No

Cart Extra Info Entity Details

Entity


Description

Type

Length

Required

Id

Unique identifier for this cart extra info which is
generated when the createCartExtraInfo operation
is called

UUID

36

-

Name

Name of the cart extra info

String

20

Yes

Value

Value for the cart extra info

Text

250

Yes

Cart Entity Details

Entity


Description

Type

Length

Required

allowSplitOrder

Flag to indicate if this order is
allowed to split

Boolean

1

No

batchNumber

The branch or group number of
the order

Text

10

No

carrierId

Id of the carrier assigned to the
cart (see Carrier code table)

Integer

-

Yes

cartItemIdList

List of cart items in this cart

List

-

No

creditCardExp
iration

Expiration date of card (MM/YYYY)

String

7

No

creditCardNumber

Credit card number

String

16

No

creditCardType

Id of card type


see
Credit Card
Types

Integer

-

No

customerId

Id of the customer assigned to the
cart

Text

10

Yes

divisionId

division for the order

Integer

-

No

externalOrderId

Field
to store external user's order
id value

Text

20

No

giftMessage

Gift message to be printed if a gift
order

Text

250

No

i
d

Unique identifier for this cart
which is generated when the
createCart operation is called

UUID

36

Yes

isGiftOrder

Flag to indicate
if this is a gift
order or not

Boolean

1

No

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

15

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


orderTypeId

Id of the order type assigned to
the cart



獥攠
佲O敲⁔yp敳

䥮瑥g敲

-

奥Y

orderDate

The date that the order was
placed (MM/DD/YYYY)

Text

10

Yes

recipientId

Id
of the recipient assigned to the
cart

Text

10

Yes

serviceTypeId

Id of the service type assigned to
the cart



獥攠
卥Sv楣i⁔yp敳


呥硴

1

奥Y

shippingAndHanlding

Total shipping and handling of the
order

Money

7,2

No

specialInstructions

Any warehouse special directions

Text

100

No

Tax

Total tax of the order

Money

7,2

No

totalPrice

Total price of the order

Money

7,2

No

warehouseId

warehouse for the order

Integer

-

No

Order

Entity Details

Entity


Description

Type

Length

Required

allowSplitOrder

Flag to indicate if this order is
allowed to split

Boolean

1

No

batchNumber

The branch or group number of
the order

Text

10

No

carrierId

Id of the carrier assigned to the
cart (see
Carrier code



table)

Integer

-

Yes

customerId

Id of the customer assigned to
the cart

Text

10

Yes

divisionId

division for order

Integer

-


No

entryDate

timestamp of order

Datetime

-

Yes

extraInfoList

extra info records for this order

List

-

No

externalOrderId

This field can be used to store the
order id from an external user’s
system

Text

20

No

giftMessage

Gift message to be printed if a
gift order

Text

250

No

isGiftOrder

Flag to indicate if this is a gift
order or not

Boolean

1

No

itemId

Control number of the item being
ordered

Text

36

Yes

inventoryNo

Account to which the session is
tied

Integer



lineItemList

list of line items on the order

List

-

Yes

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

16

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


orderDate

The date
for the order

(MM/DD/YYYY)

Text

10

Yes

orderId

Unique identifier for this cart
which is generated

Text

20

Yes

orderPaymentList

list of order payment records

List

-

No

orderSource

indicates where order originated
from

Text

80

No

orderTypeId

Id of the order type assigned to
the cart (see
Order Type

code
table)

Integer

-

Yes

quantity

Amount of item requested on
order

Integer

10

Yes

recipientId

Id of the recipient assigned to the
cart

Text

10

Yes

relatedOrderIdList

Listing orders with specific
commonalities


景r⁩湴敲 慬⁵獥

L楳i

-



serviceType

Service level, see
Service Types

table.

Text

1

Yes

shipBy

Date when order needs to ship by

Date

-


No

shipDate

Date shipped from warehouse

Text

10

No

shippingAndHan
d
l
ing

Total shipping and handling of
the order

Money

7,2

No

specialInstructions

Any warehouse special directions

Text

100

No

status

Progress of the order

Text

-

No

tax

Total tax of the order

Money

7,2

No

totalPrice

Total price of the order

Money

7,2

No

trackingNumberList

Lists package tracking number for
shipped orders

List

-

No

warehouseId

warehouse for order

Integer

-

No

Order

Line Item
Entity Details

Entity


Description

Type

Length

Required

itemId

Id for the line item

String

36

Yes

quantityOrdered

Quantity originally ordered

Integer

-

Yes

unitPrice

Price of each unit

Money

-

Yes

quantityShipped

Quantity of this line item shipped

Integer

-

Yes

isResultOfSubstitution

denotes whether this line item is
a result of a substitution of
another line item

Boolean

-


Yes

Order

Payment
Entity Details

Entity


Description

Type

Length

Required

amount

Amount of the payment

Money

-

Yes

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

17

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


paymentType

Type of payment used

String

1

Yes

accountNumber

Account number for the payment

String

20

Yes

Web

Service Application Versioning

Services are bundled into applications and released into production under a static version
.


Once an application is released into production, that version is considered frozen and its
“signature” will not change. All
URL
s, class and method names, parameters and return types will
remain the same until that version is decommissioned. The status and build of any application is
available via

its aboutService() API method.

An application’s version is noted by the postfix of it
s published name
.
(
e.g.,

ApplicationNameV1,
ApplicationNameV1M4)

Bug Fixes

Bug fixes
are

applied as
necessary

to published API
s

provided

the fix does not change the
URL
,
name, and parameters or return type of any service, class
,

or method
.


Minor Update
s

Minor version updates are published to the API via an application

minor vers
ion release,
designated by the
M# postfix.

Major Updates

M
ajor application updates, rewrites and
application

features

are released via full version
release, designated by a
new primary version postfix number.

API Console

API Test Console

A testing console is available for all applications
.
It serves as the hosting point for an
application’s WSDL information as well as a simple testing and debugging UI.

Console URL

http://www.materialogic.com/~soapdev/sas.engine?template=applications.soapadmin.SOAPAd
minConsole

The INFOplus Web Service Application is a prospect/train
ing tool. Therefore, some of the more
complex script examples in this document are not available through the web services site.

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

18

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald



Figure
1
: INFOplus Application Web Service Method Listing


INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

19

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald



Figure
2
:
INFOplus Create Customer Interactive UI / Debugger

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

20

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald



Figure
3
: User Manager Validate Session Results Example


Figure
4
: UserManager WSDL Example


INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

21

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Access

Please contact your ASR for a username and password
to access the API Test Console or any of
the application API’s.

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

22

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald



Code Definitions

Service Types

Code

Description

Meaning (This is inventory specific)

1

STANDARD SVC

Standard Service is customized by contractual requirements

2

NEXT DAY SVC

Option offered

to companies with multiple day Standard
Service, requiring that orders received during today’s
business will be shipped by close
-
of
-
business on the
following business day

3

SAME DAY AM SVC

Orders received in today’s AM will be shipped by close

of
-
busine
ss today

4

SAME DAY PM SVC

Orders received in today’s PM will be shipped by close
-
of
-
business today

5

MASS DISTRIBUTION

Production distribution (push) not based on customer order

6

NEXT DAY AM SVC

Order received in today’s AM will be shipped by
close
-
of
-
business today

7

NEXT DAY PM SVC

Orders received in today’s PM will be shipped by close of
next day business day

B

BACK ORDER

Items on back order

D

DESTRUCTION

Requisition for destruction of items

F

FREIGHT ONLY

Requisitions with nothing shipped from inventory, no
requisition and lines (distribution) charges

J

NO CHARGE RUSH

Shipments Materialogic chooses to rush without requisition
and line (distribution) charges

K

ASSEMBLED KIT

Order was to relieve inventory of components for kit
assembly



For Materialogic use only



P

POD ORDER

Print
-
on
-
demand order

R

RETURN

Returned requisition

T

TRANSFER

Transfer within or across inventory

V

OUTSIDE VENDOR

Order sent to outside vendor
for fulfillment and shipping


INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

23

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Carrier

Carrier

Company

0

UPS ** GROUNDSAVER **

1

UPS
-
1 DAY

2

UPS
-
2ND DAY

3

UPS
-
3 DAY

4

UPS

5

UPS 1ST DAY
-
SSAT.DELY

10

UPS CWT GROUND

11

UPS CWT


1 DAY

12

UPS CWT


2 DAY

13

UPS CWT


3 DAY

15

UPS 1ST DAY EARLY AM DEL

18

UPS CWT
-
2ND DAY AM

20

UPS GROUD RESIDENTIAL

21

UPS 1 DAY
-
RESIDENTIAL

22

UPS 2 DAY
-
RESIDENTIAL

23

UPS 3 DAY
-
RESIDENTIAL

24

UPS 1 DAY SAVER

25

UPS CWT


1 DAY SAVER

26

UPS 1 DAY SAVER
-
RESIENTI

27

UPS 1ST DAY EARLY AM

28

UPS 2ND DAY AM

30

UPS
CWT
-
GROUND RESIDENTIA

31

UPS CWT
-
1 DAY
-
RESIDENTIAL

32

UPS CWT
-
2 DAY
-
RESIDENTIAL

33

UPS CWT
-
3 DAY
-
RESIDENTIAL

35

UPS CWT
-
1 DAY SAVER
-
RESID

36

UPS CWT
-
2DAY AM
-
RESIDENT

37

UPS 1ST DAY
-
EARLY AM
-
RES

38

UPS 2ND DAY AIR
-
AM
-
RES

100

TRUCK

111

WILL CALL

165

COURIER

172

CLASSIC CARGO

7000

FEDEX GROUND

7001

FEDEX
-
1 DAY

7002

FEDEX
-
2ND DAY

7003

FEDEX
-
3 DAY

7005

FEDEX 1ST DAY
-
SAT DELY

7010

FEDEX CWT GROUND

7011

FEDEX CWT


1 DAY

7012

FEDEX CWT


2 DAY

7013

FEDEX CWT


3 DAY

7020

FEDEX
GROUND
-
RESIDENTIAL

7021

FEDEX 1 DAY
-
RESIDENTIAL

7022

FEDEX 3 DAY
-
RESIDENTIAL

7023

FEDEX 3 DAY
-
RESIDENTIAL

7024

FEDEX 1 DAY SAVER

7025

FEDEX CWT


DAY SAVER

7026

FEDEX 1 DAY SAVER
-
RESIDEN

7027

FEDEX 1ST DAY EARLY AM

7030

FEDEX CWT
-
GROUND RESIDENT

7031

FEDEX CWT
-
1 DAY
-
RESIDENT

7032

FEDEX CWT
-
2 DAY
-
RESIDENTI

7033

FEDEX CWT
-
3 DAY
-
RESIDENTI

7035

FEDEX CWT
-
1DAY SAVER
-
RES

7037

FEDEX 1ST DAY
-
EARLY AM
-
RE


INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

24

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Order Type

Code

Description

(blank) or
0

Regular order

5

KIT
-
ON
-
DEMAND

Transaction Type

Code

Description

0

Initial advise

1

Update to previous advise

Product Types

Code

Description

1

Not specified. If blank,
defaults to 1 unless order
is from CopperLink.

Requisition Types

Code

Description

1

Interim
Order

2

Cycle Order

3

Home Office Approved
-

ITEM

4

Home Office Approved


ALL

5

Kit
-
on
-
demand

Reorder Codes

Code

Description

1

Print on Demand

5

Lowstock
(Default Value)

6

Obsolete (Continue Filling)

7

Obsolete (Stop Filling)

8

Master Lite

V

Outside Vendor


Note the reorder code is immutable. That
is, once the reorder code is assigned (upon
the creation of an item), it cannot be
changed. If omitted, the value of 5 is used
by default.


Countries

Code

Description

1570

UNITED STATES

260

ANDORRA

261

ANGOLA

262

ANGUILLA

Query Web Service for all country
values

Credit Card Type

Code

Description

A

AMERICAN EXPRESS

D

DISCOVER

M

MASTERCARD

V

VISA

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

25

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Exceptions

Exception Name

Description

AccessDeniedException

Attempted to
use a service operation that the user does
not have access to

AlcoholTypeNotFoundException

Alcohol Type for the specified id could not be found in the
system

CarrierNotFoundException

Carrier for the specified id could not be found in the
system

CartData
Exception

There was a problem with the cart data provided, see
exception message for details

CartItemAlreadyInCartException

Attempted to add a cart item with an item id that already
exists in the specified cart

CartItemDataException

There was a problem
with the order data provided, see
exception message for details

CartItemItemIdModificationException

Attempted to updated the item id of an existing cart item

CartItemNotFoundException

Cart Item for the specified id could not be found in the
system

Cart
ItemNotInCartException

Attempted to access a cart item that does not exist in the
specified cart

CartNotFoundException

Cart for the specified id could not be found in the system

ContainerNotFoundException

Container for the specified id could not be
found in the
system

CountryNotFoundException

Country for the specified id could not be found in the
system

CreditCardTypeNotFoundException

Credit Card Type for the specified id could not be found in
the system

CustomerDataException

There was a problem w
ith the customer data provided,
see exception message for details

CustomerNotFoundException

Customer for the specified id could not be found in the
system

EmptyCartException

An order was attempted to be placed using a cart with no
cart items

InvalidDateFormatException

An invalid date format was passed as a parameter, all
should be in format MM/DD/YYYY

InvalidSessionException

Attempted to use an invalid or expired session

ItemDataException

There was a problem with the item data provided, see

exception message for details

ItemInventoryDataException

There was a problem with the inventory data provided,
see exception message for details

ItemInventoryNotFoundException

Item Inventory for the specified id could not be found in
the system

ItemNotFoundException

Item for the specified id could not be found in the system

INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

26

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


OrderDataException

There was a problem with the order data provided, see
exception message for details

OrderNotFoundException

Order for the specified id could not be found i
n the system

OrderProcessedException

Attempted to cancel an order that has already been
processed

OrderTypeNotFoundException

Order Type for the specified id could not be found in the
system

OrderValidationException

An error occurred validating an order,

see exception
message for details

PlaceOrderException

An error occurred when placing an order, see exception
message for details

ProductTypeNotFoundException

Product Type for the specified id could not be found in the
system

PurchaseOrderDataException

There was a problem with the purchase order data
provided, see exception message for details

PurchaseOrderNotFoundException

Purchase Order for the specified id could not be found in
the system

RequiredParameterMissingException

A parameter required for a
particular web service
operation was not provided

ServiceTypeNotFoundException

Service Type for the specified id could not be found in the
system

SessionException

There was an error trying to access the users current
session, see message for details

Sta
teConfigurationNotFoundException

State Configuration for the specified id could not be found
in the system

StoreCustomerException

An error occurred storing a customer, see exception
message for details.

StoreItemException

An error occurred storing an
item, see exception message
for details

StorePurchaseOrderException

An error occurred storing a purchase order see exception
message for details

StoreVendorException

An error occurred storing a vendor, see exception message
for details

UnknownException

An unexpected error occurred, see exception message for
details

VendorDataException

There was a problem with the vendor data provided, see
exception message for details

VendorNotFoundException

Vendor for the specified id could not be found in the
system




INFOplus

Web Services Integration




Version:

2.
1

Confidential

Last Changed:

11/27/2012

Page:

27

of
27

Do not copy or distribute without Materialogic’s written permission

Prepared By:

Dylan McDonald


Change Log

Version

Date

Change / Comment

0.01

04/01/2008

Document created

0.02

04/15/2008

Various updates

0.03

04/24/2008

Corrected page numbering, pagination, and definition of
externalOrderId

in Cart Entity Details table. Placed references to
tables in Appendix B throughout document and linked to appropriate
appendix heading., Updated WSDL link. Added Order and Inventory
Entity Details tables. Added descriptions and types to Entity table
data.

Fixed table spacing. Added API to Carrier headings. Removed
unused Service Type codes from appendix. Added Get List of
Available Order Types section and Order Types codes in appendix

0.04

4/29/2008

Added exceptions and exception handling, added express
order
description. Added vendor information

0.05

6/11/2008

Reorganized INFOplus section, updated REST samples to match Web
Services site. Removed Cancel an Order and Modify an Order
sections. Added note about availability of example in website of
getPurch
aseOrderId and getPurchaseOrderIdList scripts. Added note
about creating a cart required in order to view or cancel a shopping
cart. Added Get List of Available Product Types section info per Ben.

2.01

4/20/2012

Imported old document into new style, updat
ed urls to latest version
of API

2.1

11/27/2012

Documented the modifications in InfoPlusV3M3. Spefically, the Item
object was modified to contain the reorder and outside vendor codes.