You are on page 1of 8

Oracle® Fusion Cloud Warehouse Management

Deprecation of Legacy APIs


April 2022
Copyright Notice
Oracle® Fusion Cloud Warehouse Management Deprecation of Legacy APIs
Copyright © 2022, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any
programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are
"commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific
supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs,
including any operating system, integrated software, any programs installed on the hardware, and/or
documentation, shall be subject to license terms and license restrictions applicable to the programs. No other
rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron,
the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices.
UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise
set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be
responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,
products, or services, except as set forth in an applicable agreement between you and Oracle.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

ii

Copyright © 2022, Oracle and/or its affiliates. All rights reserved.


Send Us Your Comments
Oracle® Fusion Cloud Warehouse Management Deprecation of Legacy APIs

Oracle welcomes your comments and suggestions on the quality and usefulness of this publication. Your input
is an important part of the information used for revision.

• Did you find any errors?


• Is the information clearly presented?
• Do you need more information? If so, where?
• Are the examples correct? Do you need more examples?
• What features did you like most about this manual?
If you find any errors or have any other suggestions for improvement, please indicate the title and part
number of the documentation and the chapter, section, and page number (if available). You can send
comments to us in the following ways:

• Electronic mail: owms-cloud-comms_us@oracle.com


If you would like a reply, please give your name, address, telephone number, and electronic mail address
(optional).

iii

Copyright © 2022, Oracle and/or its affiliates. All rights reserved.


Preface
This document provides details for Setting up a Scheduled Job with Job Type Extract for Oracle Warehouse
Management Cloud.

Change History
Date Document Revision Summary of Changes

9/3/2021 0.1 Original

iv

Copyright © 2022, Oracle and/or its affiliates. All rights reserved.


Table of Contents
COPYRIGHT NOTICE ........................................................................................... II

SEND US YOUR COMMENTS ................................................................................ III

PREFACE ............................................................................................................. IV

CHANGE HISTORY .............................................................................................................. IV


TABLE OF CONTENTS ........................................................................................... V

UPCOMING CHANGES TO LEGACY APIS ................................................................ 1

API VERSIONING ............................................................................................................... 1


DEPRECATION OF LEGACY APIS ............................................................................................. 1
TABLE 1 - APIS TO BE DEPRECATED WITH THEIR FUNCTIONAL EQUIVALENT ............................................................... 2

Copyright © 2022, Oracle and/or its affiliates. All rights reserved.


Upcoming Changes to Legacy APIs
Please review this announcement for an important update for Oracle Fusion Cloud Warehouse
Management (LogFire). We are making the following changes to our legacy APIs.

API Versioning
The current "lgfapi" REST APIs (documented in the Oracle Warehouse Management Cloud REST API
Guide) support the concept of API versioning (see "Versioning" sub-section in the first few pages of
this document). API versioning is a common practice used in many enterprise grade APIs. Versioning
is supported in order to provide backward compatibility across multiple WMS releases while new
features are introduced in new versions of the API. As the WMS codebase progresses across quarterly
releases, it is not possible to keep supporting older versions of the API for an unlimited period of time.

The current version of the lgfapi is v10. lgfapi v9 is several years old now - we will not support v9 in
22B. In order to convert to the new versioning criteria please follow the instructions below:

• The version number forms part of the URL. For example:


https://xxxxx.wms.ocs.oraclecloud.com/myenv/wms/lgfapi/v10/entity
• Existing APIs must be update to v10 in the URL
• To migrate to the new version, you will have to change the v9 to v10 in the URL
o OLD https://xxxxx.wms.ocs.oraclecloud.com/myenv/wms/lgfapi/v9/entity
o NEW https://xxxxx.wms.ocs.oraclecloud.com/myenv/wms/lgfapi/v10/entity
o All features/functions that are supported in V9 are also supported in v10

NOTE: With lgfapi's always try to use the current version which at this time is V10. Over time,
older version will continue to be desupported. With update 22B, the v9 URLs will stop working.

Deprecation of Legacy APIs


The legacy APIs to be deprecated are listed in the following (Table 1.) along with the equivalent lgfapi
that you should migrate to. Only these legacy API’s are being retired. Those not on the list will
continue to be available for now, though they will eventually be retired as well, with sufficient notice.

Copyright © 2022, Oracle and/or its affiliates. All rights reserved.


Table 1 - APIs to be deprecated with their functional equivalent

API Name Old API (to be deprecated) New API (lgfapi equivalents) Notes

Create LPN POST wms/api/create_lpn/ POST wms/lgfapi/v10/entity/iblpn/composite_create

Get Entity GET wms/api/entity/<entity name>/ GET wms/lgfapi/v10/entity/<entity name>

Get Entity Status POST wms/api/get_status/<entity name>/ GET wms/lgfapi/v10/entity/<entity name>

See lgfapi documentation for


Get Extended Property GET wms/api/extended_property/<entity name>/ GET wms/lgfapi/v10/entity/<entity name>
additional functionality

POST
Get Seq Number POST wms/api/get_next_numbers/
wms/lgfapi/v10/entity/seq_counter/get_next_number

POST wms/lgfapi/v10/entity/container/lock Also supported via "iblpn"


Lock/Unlock LPN POST wms/api/lock_unlock_lpn/
POST wms/lgfapi/v10/entity/container/unlock and "oblpn" entities

Pick Confirm POST wms/api/pick_confirm/ POST wms/lgfapi/v10/pick_pack/pick_confirm

Receive LPN POST wms/api/receive_lpn/ POST wms/lgfapi/v10/entity/iblpn/receive

Ship OBLPN POST wms/api/ship_oblpn/ POST wms/lgfapi/v10/entity/oblpn/ship

POST
Update Active Inventory PATCH wms/api/entity/active_inventory/<key>/
wms/lgfapi/v10/entity/location/update_active_inventory

Update OBLPN
POST wms/api/update_oblpn_dims/ PATCH wms/lgfapi/v10/entity/oblpn
Dimensions

Copyright © 2022, Oracle and/or its affiliates. All rights reserved.


In addition, as indicated in the overview section of the REST API Guide mentioned in the above API
Versioning section, we are also deprecating several legacy APIs that no longer comply with our overall
strategy to develop REST APIs. The remaining legacy API’s are documented in the Oracle Warehouse
Management Cloud Integration API Guide. The newer APIs (“lgfapi”) provide improved functionality,
structuring, stability, and scalability, and all customers must migrate to the newer, equivalent APIs.
The time frame for deprecation is 22B, at which point the URLs that specify these APIs will no longer
be accessible.

Copyright © 2022, Oracle and/or its affiliates. All rights reserved.

You might also like