Using REST APIs with Smart Inventory Tracker

Smart Inventory Tracker for Event Reporting leverages REST APIs to communicate with the company's serialization system of record (SOR) if the company does not use Serialized Operations Manager as their SOR.

Authentication

The Smart Inventory Tracker REST APIs support user-based authentication using HTTP Basic Authentication.

Smart Inventory Tracker sends a PUT request to the endpoint URL specified in Management.

  • Content-Type – The media type for the message. Valid value is "application/json".
  • Authorization – The Administrator's username and password, encoded using Base64.

    If the message is sent through Postman, select Basic Auth on the Authorization tab to enter the Administrator's username and password. These credentials are encrypted and added to the header.

Prerequisites

A Manager must:

  1. Enable SSCC each-level retrieval in Management.
  2. Enter an endpoint URL and authentication credentials for the external SOR in Management.

See the Management Online Help for more information.

HTTP response status codes

200 OK. The request was successful. For GET, this means that the resource has been fetched.
307 Temporary Redirect. The client must get the requested resource at another URI with the same HTTP method that was used in the prior request.
400 Bad Request. The server could not understand the request due to invalid syntax.
401 Unauthorized. The client is unauthenticated, not allowed access, and should re-request credentials.
403 Forbidden. The request is valid and the client is authenticated, but the client is not allowed access rights to the content for any reason.
404 Not Found. The server cannot find the requested item. This can also mean that the endpoint is valid but the resource does not exist.
500 Internal Server Error. The server has encountered an unknown error.
502 Bad Gateway. The server is working as a gateway to handle the request and received an invalid response.
503 Service Unavailable. The server is not ready to handle the request.
504 Gateway Timeout. The server is acting as a gateway and cannot get a response in time.

How to read the guidelines table

  • Element – The field name designated by the request or response guidelines.
  • Type – The type of data format required for the value.
  • Description – A description of the value, including its format and acceptable values, if needed.

External SOR Get Serial Numbers API

Smart Inventory Tracker Owners who do not use TraceLink as their system of record (SOR) and enable SSCC each-level retrieval within Smart Inventory Tracker (Event Reporting) use this REST message when a warehouse operator ships an SSCC or undoes a Ship event with an SSCC.

TraceLink sends the External SOR Get Serial Numbers Request to the Owner's external SOR, and the external SOR must send the Response containing all lowest-saleable units within that SSCC and their associated information (e.g. packaging code, lot number).

Download the PDF guide