Extended Property
URL: "xxx.wms.ocs.oraclecloud.com/env_name/wms/api/extended_property/entity_name/key/extended_property"
Method:GET
Initial WMS Version: 8.0.1
Overview
API is used to fetch an extended property for the requested entity. Sometimes customers would like to get more information like fetching the number of LPN's for an order. The following are additional details about extended property:
- Entity and extended property for the entity are provided in the requesting URL. URL should also contain the entity key against which the extended property is asked for.
- Response provided will be a value of the extended property being inquired.
- From 8.0.1, support is provided for order entity and a couple of extended properties provided below. Same API will be expanded for additional entities and other extended properties for future releases.
Argument Name | Function | Required | Default Value | Data Type |
---|---|---|---|---|
company_code | WMS Company Code | string | ||
facility_code | WMS Facility Code | string |
Entity | Extended property | Initial Supported Version | Usage |
---|---|---|---|
order | number_of_oblpns | 8.0.1 | Fetches the total count of outbound LPN's for the order number passed in the API, which are from outbound created status till cancelled status (cancelled status outbound LPN's are excluded). |
order | number_of_packaged_oblpns | 8.0.1 | Fetches the total count of outbound LPN's for the order number passed in the API, which are in Packed, Loaded, Shipped and Delivered status. |