Optional Features
Each release may contain one or more, administrator controlled, Optional Feature where each feature may affect the content or function for each resource. Reference the OTM and GTM What's New content for the release to see the current list and status of each feature.
Append Refobject for Ref Attr Not Ending with GID
When enabled, this will append RefObject to the JSON property name in the following scenario:
- It has a property type of object.
- It is an attribute of a resource that references another root resource.
- Its name does not end with "Gid".
This enhancement makes REST API documentation more complete and easier to understand by clearly showing when related objects can be expanded versus when only their IDs are returned. It reduces confusion and rework for integrators, helping teams build and troubleshoot integrations faster. This would clearly show reference resources (objects linked via foreign keys) alongside their ID fields. For example, instead of only showing an ID field like orderBaseGid, the documentation will also show the related object (for example, orderBases ) and explain when each one appears based on the expandRefs setting.
Tips and Considerations:
- Use expandRefs to control what you see:
- When expandRefs=false, you will see the ID-style field (for example, orderBaseGid).
- When expandRefs=true, you will see the expanded reference object (for example,orderBases) with descriptive text explaining it’s a referenced resource.
- Watch for “RefObject” naming on certain fields: Some reference attributes don’t end with Gid (for example, equipmentDestination on shipments). In the documentation, these may appear with RefObject appended (for example, equipmentDestinationRefObject) to make it clear they are reference objects.
- The documentation describes the RefObject naming
behavior, but the actual JSON generation behavior for
these non-Gid reference attributes only applies when this Optional Feature is
enabled.
- As the behavior for the non-Gid reference attributes is changed when enabled, this is controlled with the Optional Feature.
The complete list of reference resource attributes which do not end with "Gid" and will have "RefObject" appended are:
Table - Reference Resource Attributes which do not End with "Gid"
| Resource | Property | Reference Resource |
|---|---|---|
| sellShipments | equipmentDestination | locations |
| sellShipments | prevEquipmentDestination | locations |
| shipments | equipmentDestination | locations |
| shipments | prevEquipmentDestination | locations |
| shipments | originLocation | locations |
| shipments | destinationLocation | locations |
| shipmentNoSSUs | equipmentDestination | locations |
| shipmentNoSSUs | prevEquipmentDestination | locations |
| shipmentNoSSUs | originLocation | locations |
| shipmentNoSSUs | destinationLocation | locations |
| vouchers | equipmentDestination | locations |
| vouchers | prevEquipmentDestination | locations |
| customerServices | orderReleaseTemplate | orderReleases |
| locationCompatibilities | locationGid1 | locations |
| locationCompatibilities | locationGid2 | locations |
| customsDeclarations | prodDocValidationLoc | locations |
| customsDeclarationsNoTradeLicenses | prodDocValidationLoc | locations |
| tenders | originLocation | locations |
| tenders | destinationLocation | locations |
Disable XID Update in JSON Patch Replace OP
When enabled, prevents updating the XID attribute of a resource when using JSON patch replace operation. The XID attribute of a resource will not get updated by the JSON patch replace operation.
This feature helps maintain the integrity and consistency of your XIDs by preventing unintended or unauthorized modifications during JSON patch operations. This reduces the risk of data inconsistency, enhances security, and ensures reliable system integration by protecting unique keys essential for referencing and managing resources.
Note:
This feature also enforces the create only attributes are not updated.
Enable Retrieval of Updated Children Page Details
When enabled, ensures that the correct values are provided for the pagination and result metadata hasMore, limit, and totalResults in REST child resource data.
This feature ensures the accuracy of pagination and result metadata (hasMore, limit, count, offset and totalResults) in REST child resource data. This improves data integrity and allows you to reliably navigate and process datasets, leading to a better user experience, and efficient integration development.