Description of API Enhancements Now Available in Swift+ APIs
The descriptions below are now available as of December 20, 2024.
This release introduces API Version 2 (V2) to the Billing, Inventory, Loading & Shipping APIs.
FOUR ENHANCEMENTS
ONE
Configuration required? Yes.
Metadata is available at the end of the response payload following a successful API call:
- TotalRecords
- CurrentPage
- PageSize
- TotalPages
- NextPage
- PreviousPage
Notes
- Endpoints providing more than one record will have Metadata returned.
TWO
Configuration Required: No
The response parameter BOL_Number is renamed as BillofLadingNumber to the 2 libraries and 6 endpoints listed:
Loading Library
-
- GetBillsOfLading - V2
- GetBillOfLadingDetails - V2
-
- GetBillOfLadingLineItems - V2
- GetBillOfLadingLineItemDetails - V2
Billing Library
-
- GetAdditiveInvoiceTransactionDetails - V2
- GetAdditiveInvoiceTransactions - V2
THREE
New Optional Request Parameters Now Available!
Configuration Required: No
- Inventory API > GetCurrentInventorySummary - V2 >
- Product Grade
- Loading Rack ID
- Loading Rack Name
Notes
- Product Grade and Loading Rack Name are case sensitive and must match values from Swift/ATLAS
FOUR
New Response Parameters Now Available!
Configuration Required: No
- Loading API > GetBillofLadingLineItems - V2 and GetBillofLadingLineItemDetails - V2 > ValveGravitySpecification
- Billing API > GetBookingHistory - V2 and GetBookingHistoryUpdates - V2 > ParentID & ParentType
- Adding ParentID allows users to map booking history where volumes are stored in bbls (barrels) back to the BOL BillOfLadingTransactionID data where volumes are stored in GALs (gallons).
- Loading API V2 > unique transaction identifier BillOfLadingTransactionID
- Adding BillOfLadingTransactionID allows for users to map BOL data to GetBookingHistory - V2 and GetBookingHistoryUpdates - V2 ParentID when viewing BOL transactions.
- Adding BillOfLadingTransactionID allows for unique data to be returned.