API (Application Program Interface)

Introduction

The Uniware SOAP API comprises API definitions for different business operations, which would involve many steps in the process of Order Fulfillment, Vendor Management and Sales & Purchases. The core structures <request> and <response> form the basis of the SOAP XML for each API.

Security

The SOAP API service is protected to allow only an authorized access to it. Thus, the APIs will require:

An API username and
API password
for authentication.

<wsse:Security soapenv:mustUnderstand=”1″ xmlns:wsse=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd” xmlns:wsu=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd”>

<wsse:UsernameToken wsu:Id=”UsernameToken-5″>

<wsse:Username>xyz@unicommerce.com</wsse:Username>

<wsse:Password Type=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText”>xyz@123</wsse:Password>

<wsse:Nonce EncodingType=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary”>nvPjKUgjKSIcKYcsJdiVSg==</wsse:Nonce>

<wsu:Created>2012-12-20T19:49:43.570Z</wsu:Created>

</wsse:UsernameToken>

</wsse:Security>

Authentication failure denies access to the API service.

SOAP Request Envelope

A SOAP envelope consists of the header and the body. While the header contains security parameters to authorize a user, the body contains elements specific to an API. The following diagram illustrates the contents of a SOAP envelope:

SOAP Request Envelope

Sandbox

Sandbox is typically known as a security mechanism, providing a confined environment, where you can do anything without propagating its effects on the outside. In general, it is an isolated computing environment used for testing.

We at Unicommerce use sandbox to execute the API requests against the production environment for development and testing purposes.

The Sandbox API must be accessed with the following credentials:

Username : Sandbox

Password : 91561781f43921dd2803fa63a7ee5519

Learn how to generate your own API key.

The API end points are discussed later in this article.

Request Structure

The following description of the SOAP request structure shows the elements required by the API, it contains the header and the body:

General structure of SOAP Request

<soapenv:Envelope xmlns:ser=”http://uniware.unicommerce.com/services/” xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”>

<soapenv:Header>

<wsse:UsernameToken wsu:Id=”UsernameToken-1″>

<wsse:Username>staging</wsse:Username>

<wsse:Password Type=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText”>staging</wsse:Password>

<wsse:Nonce EncodingType=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary”>kscIjg0DVsIcWj5JExeUfQ==</wsse:Nonce>

<wsu:Created>2014-01-24T06:29:58.415Z</wsu:Created>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

<soapenv:Body>

<ser:GetPurchaseOrderDetailRequest>

<ser:PurchaseOrderCode>UL-MUM/13-14/53</ser:PurchaseOrderCode>

</ser:GetPurchaseOrderDetailRequest>

</soapenv:Body>

</soapenv:Envelope>

Response Structure

The typical Response structure contains the header and the body. The body contains the response for the SOAP request made.

General structure of the SOAP response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/”>

<SOAP-ENV:Header/>

<SOAP-ENV:Body>

<FromParty>mumbai</FromParty>

<StatusCode>COMPLETE</StatusCode>

<VendorName>Essentials</VendorName>

<ItemTypeName>Lloyd Steel Standard Set 3-2-1</ItemTypeName>

</PurchaseOrderItem>

</PurchaseOrderItems>

<AddressType>SHIPPING</AddressType>

<AddressTypeName>Shipping Address</AddressTypeName>

<StateName>Maharashtra</StateName>

<AddressLine1>F-5, Nand dham Industrial Estate,</AddressLine1>

<AddressLine2>Near Marol Fire Brigade, Opp. Marol Gaon Bus stop</AddressLine2>

<City>Mumbai</City>

</PartyAddress>

</GetPurchaseOrderDetailResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Error Responses

If an API request contains some error, the SOAP response contains the Error element. An error must be corrected prior to complete execution of the request initiated.

The general structure of an error message is as follows:

<SOAP-ENV:Envelope xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/”>

<SOAP-ENV:Header/>

<SOAP-ENV:Body>

<Successful>false</Successful>

</Errors>

</GetPurchaseOrderDetailResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

It contains: The Error Code (Error Message)

Warning Responses

A “Warning” response alerts you to a potential trouble with your data which may require additional explanation.

It contains:

The Warning Code

Warning Message

Description (optional)

Filters

Much of the Web Service Enhancement functionality is enveloped in a set of filters contained in incoming and outgoing channels that connect the client and the servers hosting them. These filters are used in alliance with the base classes to pass information to and from the code. Filters are applied to a SOAP request in order to enable the feature of modifying a SOAP response.

For an API result, you might require a result set in between a date range or its current status. These APIs contain the filters (wherever applicable) and provide accurate results, as desired.

The general structure to illustrate a filter application in a request sent:

<soapenv:Envelope xmlns:ser=”http://uniware.unicommerce.com/services/” xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”>

<soapenv:Header>

<wsse:UsernameToken wsu:Id=”UsernameToken-3″>

<wsse:Username>staging</wsse:Username>

<wsse:Password Type=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText”>staging</wsse:Password>

<wsse:Nonce EncodingType=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary”>W+j2ESLu6risoqYDtILFmg==</wsse:Nonce>

<wsu:Created>2014-01-23T07:34:33.471Z</wsu:Created>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

<soapenv:Body>

<ser:GetPurchaseOrdersRequest>

</soapenv:Envelope>

<!–Optional:–>

<ser:ApprovedDateRange>

<ser:Start>?</ser:Start>

<ser:End>?</ser:End>

</ser:ApprovedDateRange>

<!–Optional:–>

<ser:CreatedDateRange>

<ser:Start>?</ser:Start>

<ser:End>?</ser:End>

</ser:CreatedDateRange>

</ser:GetPurchaseOrdersRequest>

</soapenv:Body>

WSDL Path:

The WSDL path to access our APIs:

https://staging.unicommerce.com/services/soap/uniware16.wsdl?facility=01

API End points

The table below includes the end points for the APIs. The first link is that for the sandbox while the second one can be used for each client (replacing the respective tenant name and the facility ID).

https://staging.unicommerce.com:443/services/soap/?version=1.6&facility=01

https://tenant_name.unicommerce.com:443/services/soap/?version=1.6&facility=01

Click on the name of each API to learn about them in detail:

Create or Edit Item Type:

Get Sale Order Details

Cancel Sale Order

Hold Sale Order

Unhold Sale Order

Create Or Edit Vendor

Inventory Adjustment

Get Item Details

Recommended for you: