Welcome to Item Public API

Welcome to Item Public API document site, where you can find multiple resources for API integration. This article introduces the basic information of Item Public API.

Introduction

ITEM APIs are designed for all stages of your warehouse's order life-cycle: Inbound, Inventory Management and Commitment, and Outbound. There are plenty of Query APIs which are often used to build accurate, real-time reports about your orders and tasks.

This section introduces the basic information of Item Public API.

Product Overview

Field/Parameter	Value
Domain	Production Domain: http://wms.item.com/api/bam/v1/public (opens in a new tab)
Product/Application/System	WISE/WMS
Feature/Function/Sub-system	Level 3 API
Product	UNIS - CS API Integration
Version	1.4.2
Last Update	1/31/2023
Project Information	Project ID# : 100002; Title : UNIS Public API - CS API Integration

Rate Limiting

Open API institutes per-user, per-IP, per minute rate limits for the API methods.

100 calls per minute/user
1000 calls per minute/IP

Response

The API responds with the requested payload of data if http status is 200 success. When an error occurs, it responds with http exception status and error message. Take the example as below:

// Success
Http status: 200
Body: {payload data}

// Bad request
Http status: 400
Body: {
	errorCode: 4000001,
	errorMessage: "xxxxx"
}

Http Status

HTTP Code	Meaning	Description
200	Success	The request was successful.
400	Bad Request	The server cannot or will not process the request because of a possible client error.
401	Authentication Required	The client request is not completed as it lacks valid authentication for the requested resource.
500	Internal Server Error	The server has encountered an unexpected condition that prevents it from fulfilling the request.

Feature

The Item Public API is designed to be developer-friendly, offering both experienced developers and newcomers at UNIS an easy and intuitive integration experience. Here are some features of Item Public API below:

Item Public API follows the OpenAPI (formerly Swagger) specifications. If you are familiar with OpenAPI, you should be also familiar with our API.
Item Public API is REST (Representational State Transfer) APIs. Therefore, each API is accessed via HTTP Protocol at a predefined set of URLs. When returned, each resource is returned a JSON encoded responses.
ITEM simplifies authentication by providing a user name and password instead of requiring you to generate an API key. These credentials act as tokens for access. Please refer to Authentication section for more details.

Note: please contact us at info@opera8.com if you don’t have the user account and password.

Making First API Call

Please make sure that you have the following information before begin to make your first API call:

UNIS User Account and Password
Facility ID
Customer ID
API Testing Tool (It’s optional, for the tool, it could be Postman API Client.)

To make your first API call, use a curl command in this command line client. Item APIs use POST methods to call the resource. Please specify which domain (staging or production) firstly. Then append the API URL. (For example, /edi/item-master/import).

Example:

curl --location --request POST "https://wms.item.com/api/bam/v1/public/edi/outbound/order" \ 
--header 'Authorization: {your authorization key}' \
--header 'Content-Type: application/json' \
--data-raw '{
      "CompanyID": "LT",
      "CustomerID": "{your customer ID}",
      "FacilityID": "{your facility ID}",
      "POContent": {
          "PONo": "895751541-1",
          "ReferenceNo": "Roy022501-1",
          .
          .
          .
          .
      }
  }'

Terminology