Skip to content
English
Sign in
Take me to Swift 🡕
  • There are no suggestions because the search field is empty.

2025 December: Swift+ Application Programing Interface (API) Release

Description of API Features Now Available in the Swift+ APIs

Release Feature Highlights

  • Two (2) Bug Fixes
    • Loading: Resolved duplicated records within four endpoints
    • Billing: Resolved pagination behavior
  • Six (6) Enhancements
    • Billing (3)
      • New endpoint GetMiscellaneousInvoices (corresponds to ARB210R1 report)

      • New endpoint GetStorageInvoicePayments (corresponds to ARB100R4 report)

      • Enhanced GetTransportationInvoicePayments (corresponds to ARB101R1 & ARB100D1 Reports & NOI.dat FTP)

    • Shipping (1) 

      • Enhanced GetTruckOffLoadingTickets (corresponds to AOE110R6 report)

    • Loading (2)

      • New endpoint GetBillsofLadingBulk

      • Enhanced GetCarrierAuthorizations

BUG FIXES

  • Loading

    • GetBillsOfLading, GetBillOfLadingDetails, GetBillOfLadingLineItems, & GetBillOfLadingLineItemDetails (V1, V2, V3, V4) – Resolved issue where records were duplicated.

  • Billing

    • GetTransportationInvoicePayments (V4) – Resolved issue where V4 pagination was not working.  This endpoint provides corresponding data from the Refined Products' ARB100D1 Report & NOI.dat FTP Data.

ENHANCEMENTS

BILLING LIBRARY (Two Enhancements)
  • ONE: New endpoint GetMiscellaneousInvoices (V5)
    • This endpoint provides corresponding data from the Refined Products' ARB210R1 report data. 
      MAGELLAN Home APIs Profile Sign out MIDSTREAM PARTNERS, L. P. Swift Open Billing API - V5 Swift Open Billing API V5 O Search operati ... Group by tag API definition Changelog GetMiscellaneousInvoices 1 AdditiveInvoices Returns a list of data for Miscellaneous Invoices for a given customer. MiscellaneousInvoices MiscellaneousInvoices GET GetMiscellaneousInvoices SystemStorageServicesInvoices Request GET https://api-mock.magellanlp.com/open/billing/V5/miscellaneous-invoice/{magellanCompanyId}/{billToCustomerId}[?startDate][&endDate] GET GetStorageInvoicePayments [&invoiceId][&page][&results] TerminallingInvoices Request parameters Name In Required Type Description TransportationInvoices > magellanCompanyId template true string The Magellan company the reconsignment falls under. i.e. "1" or "MPL" billToCustomerId template true string The Affiliate id for the bill to customer associated with the invoice. startDate query false string The start date-time in ISO 8601 format. Forces API to return only invoice payments with an invoice date equal to or after than this date-time. endDate query false string The end date-time in ISO 8601 format. Forces API to return only invoice payments with an invoice date equal to or before than this date-time. invoiceId query false string The identifier for an individual invoice. page query false integer The page number of the result list, defaults to page 1 results query false integer The number of results to be returned, default and max is 1000 records.
  • TWO:  New endpoint GetStorageInvoicePayments (V5)
    • This endpoint provides corresponding data from the Refined Products' ARB100R4 report data.
      MAGELLAN® Home APIs Profile Sign out MIDSTREAM PARTNERS, L. P. Swift Open Billing API - V5 Swift Open Billing API V5 O Search operati ... Group by tag API definition Changelog GetStorageInvoicePayments 1 AdditiveInvoices Returns a list of data for Time Based Storage Invoice Payments for a given customer. MiscellaneousInvoices V SystemStorageServicesInvoices GET GetMiscellaneousInvoices Request SystemStorageServicesInvoices V GET https://api-mock.magellanlp.com/open/billing/V5/storage-invoice-payments/{magellanCompanyId}/{billToCustomerId} [?startDate][&endDate] GET GetStorageInvoicePayments [&invoiceId] [&page] [&results] TerminallingInvoices Request parameters Name In Required Type Description TransportationInvoices > magellanCompanyId template true string The magellan company the invoices fall under. billToCustomerId template true string The id for the customer billed for the invoices. startDate query false string The start date-time in ISO 8601 format. Forces API to return only invoice payments with an autocash date equal to or after than this date-time. endDate query false string The end date-time in ISO 8601 format. Forces API to return only invoice payments with an autocash date equal to or before than this date-time. invoiceId query false string The identifier for an individual invoice. page query false integer The page number of the result list, defaults to page 1 results query false integer The number of results to be returned, default and max is 1000 records.
  • THREE: Enhancement to GetTransportationInvoicePayments (V4 & V5)
    • Added PaymentType field 
    • Updated Request parameters StartDate & EndDate
    • This endpoint provides corresponding data from the Refined Products' ARB101R1 & ARB100D1 Reports & NOI.dat FTP data.
      "customerName": "Acme Logistics", "paymentId": 1001, "paymentType": "Type1", "dataCompanyId": 1, "reference": "SomeReference", "transactionType": "RCP", MAGELLAN Home API Profile Sign out MIDSTREAM PARTNERS, L.P. Swift Open Billing API - v4 Swift Open Billing API V 4 Search operati ... Group by tag API definition Changelog GetTransportationInvoicePayments 1 AdditiveInvoices Returns the inventory history summary for an inventory owner. Ordered by product grade and then by loading rack name. 1 TerminallingInvoices TransportationInvoices TransportationInvoices Request GET GetTransportationInvoiceDetails GET https://api-mock.magellanlp.com/open/billing/v4/invoices/transportation/{magellanCompanyId}/{billToCustomerId}/transportation-invoice- GET GetTransportationInvoicePayments payments?startDate={startDate}&endDate={endDate} [&invoiceId] [&autocashId] [&page][&results] GET GetTransportationInvoices Request parameters GET GetTransportationInvoiceTransactionDetails Name In Required Type Description GET GetTransportationInvoiceTransactions magellanCompanyId template true string The magellan company the inventory falls under. billToCustomerId template true string The id for the inventory owner. startDate template true string The start date-time in ISO 8601 format. Forces API to return only transportation invoices with an auto cash start date equal to or after the parameter date-time. endDate template true string The end date-time in ISO 8601 format. Forces API to return only transportation invoices with an auto cash end date equal to or before the parameter date-time. invoiceId query false string The identifier for an individual invoice. autocashId query false string The identifier for an individual autocash entry. page query false integer The page number of the result list. results query false integer The number of results to be returned.
SHIPPING LIBRARY (One Enhancement) 
  • ONE: GetTruckOffLoadingTickets (V4)
    • Added ShipmentRequestID, NetVolumeByGallons, & NetVolumeByBarrels fields. 
    • Added optional Request parameter ShipmentRequestID.
    • This endpoint provides correspond data from the Refined Products' AOE110R6 report data.
      "results": [{ "id": 123456, "physicalTicketId": "123abc", "cpl": 1, "meterFactor": 4, "ctl": 2, "averageTemp": 20, "averageGravity": 15, "averagePressure": 18, "grossVolume": 11, "netvolumeByBarrels": 13, "netvolumeByGallons": 546, "ticketDate": "2022-05-01T12:44:18Z", "closeDate": "2022-05-30T12:44:18Z", "originReleaseId": 456, "shipmentRequestId": 789, "businessBookedDate": "2023-05-01T12:44:18Z", "sulphurvolume": "0.5", "reference": "12345/ABC", "originOwner": { "id": "123", "magellanCompanyId": "mpl", "name": "MAGELLAN MIDSTREAM PARTNERS" MAGELLAN Home APIs Profile Sign out MIDSTREAM PARTNERS, L. P. Swift Open Shipping API - V4 Swift Open Shipping API V4 O Search operati ... Group by tag API definition Changelog GetTruckOffLoading Tickets Distributions > Returns a list of truckOffLoading Tickets for a given inventory owner. Nominations > TruckOffLoadingTicket PipelineMeterTickets > Request Reconsignments > GET https://api-mock.magellanlp.com/open/shipping/V4/truckOffloadingticket/{magellanCompanyId}/{inventoryOwnerId} [?openDate][&closeDate] [&physicalTicketId] [&shipmentRequestId] [&page] [&results] Releases > Request parameters ShipmentRequests > Name In Required Type Description magellanCompanyId template true string The magellan company the truckOffLoadingTickets fall under. TruckOffLoadingTicket inventoryOwnerId template true string The id for the inventory owner associated with the pipeline GET GetTruckOffLoadingTickets truckOffLoading ticket. openDate query false string The open date-time in ISO 8601 format. Forces API to return only truckOffLoadingTickets with a open date equal to or after than this date- time. closeDate quer false string The close date-time in ISO 8601 format. Forces API to return only truckOffLoadingTickets with a close date equal to or before than this date-time. physicalTicketId query false string The ticket number that filters the list of truckOffLoading Tickets to only those with a matching ticketNumber. shipmentRequestId query false integer The shipment request identifier that filters the list of truckOffLoadingTickets to only those with a matching shipmentRequestld. page quer false integer The page number of the result list. results query false integer The number of results to be returned.


    LOADING LIBRARY (Two Enhancements)
    • ONE: New endpoint GetBillsOfLadingBulk (V4)  
      • New endpoint for Bills of Lading to return BOL header & line items within one (1) API response by Shipper and/or Inventory Owner. 
      • When the Inventory Owner is not the Shipper then there will be Shipper data fields eliminated from the response. 
        MAGELLAN® Home APIs Profile Sign out MIDSTREAM PARTNERS, L. P. Swift Open Loading API - v4 Swift Open Loading API V4 O Search operati ... Group by tag API definition Changelog GetBillsOfLadingBulk Reporting Returns a list of bills of lading bluk for a given customer, ordered by bill of lading id. GET GetBillOfLadingDetails Reporting GET GetBillOfLadingLineItemDetails GET GetBillOfLadingLineltems Request GET GetBillsOfLading GET https://api-mock.magellanlp.com/open/loading/v4/reporting/bills-of-lading-bulk/{magellanCompanyId}/{customerId}[?startDate] [&endDate] GET GetBillsOfLadingBulk [&billofLadingNumber] [&destinationId] [&carrierFein] [&productGrade] [&billOfLadingTransactionId][&billOfLadingLineItemId] [&page] [&results] GET GetCarrierAuthorization Request parameters Name In Required Type Description magellanCompanyId template true string The Magellan company this bill of lading falls within. customerId template true string ONEOK Refined Fuels affiliate number. If unknown, contact your ONEOK Company Administrator. startDate query false string The start date-time in ISO 8601 format. Forces API to return only bills of lading with a load date equal to or after than this date-time. Default - Returns data for last 31 days if no parameter is submitted endDate query false string The end date-time in ISO 8601 format. Forces API to return results to Booking History records with a business booking date on or after this value. Format: YYYY-MM-DDTHH:MM:SS (local terminal time). Forces API to return only bills of lading with a load date equal to or before than this date-time. billOfLadingNumber query false string The identifier of the bill of lading that is on the paper BOL destinationId query false integer The identifier for the destination associated with the bill of lading. carrierFein query false string Carrier's FEIN (Federal Employer Identification Number) is a unique ID number issued by the IRS. Do Not enter the dash. productGrade query false string The product grade for the summary results. A list of all Product IDs can be obtained in the Products Library
    • TWO: GetCarrierAuthorizations (V4) 
      • Added optional Request parameters LoadingRackName & LoadingRackNumberMAGELLAN Home APIs Profile Sign out MIDSTREAM PARTNERS, L. P. Swift Open Loading API - v4 Swift Open Loading API V4 O Search operati ... API definition Changelog +8 Group by tag GetCarrierAuthorization > Reporting Returns a list of CarrierAuthorization for a given supplier.Carrier Authorization is when a Supplier has granted the ability for a Carrier to load their product at a specific ONEOK GET GetBillOfLadingDetails Refined Terminal GET GetBillOfLadingLineItemDetails Reporting GET GetBillOfLadingLineltems GET GetBillsOfLading Request GET GetBillsOfLadingBulk GET https://api-mock.magellanlp.com/open/loading/v4/reporting/Carrier-Authorization/{magellanCompanyId}/{supplierId}[?startDate][&endDate] GET GetCarrierAuthorization [&carrierFein] [&carrierScac] [&carrierState] [&carrierCity] [&loadingRackName] [&loadingRackNumber] [&isRestricted] [&insuranceExpirationDate] [&hazmatExpirationDate] [&page] [&results] Request parameters Name In Required Type Description magellanCompanyId template true string ONEOK company code used for the distribution. Expected values: 1 or MPL. If no results return, contact your internal ONEOK Refined Admin supplierId template true string The id for the supplier associated with the bill of lading. startDate query false string The start date-time in ISO 8601 format. Forces API to return only carrier authorizations on or after this value. Format: YYYY-MM-DDTHH:MM:SS (local terminal time). endDate query false string The end date-time in ISO 8601 format. Forces API to return only carrier authorizations with an end date equal to or before than this value. Format: YYYY-MM-DDTHH:MM:SS (local terminal time). carrierFein query false string Carrier's FEIN (Federal Employer Identification Number) is a unique ID number issued by the IRS carrierScac query false string SCAC codes are issued by the National Motor Freight Traffic Association (NMFTA) to uniquly identify a carrier carrierState query false string State of the Carrier's home office is registered with ONEOK carrierCity query false string City of the Carrier's home office is registered with ONEOK loadingRackName query false string Filters results to only show Carrier Authorizations for a specific ONEOK loading rack name. Suppliers may authorize carriers across multiple terminals. Loading rack name spellings are available in the GetLoadingRacks endpoint (Locations) in the name field. loadingRackNumber query false string Filters results to only show Carrier Authorizations for a specific ONEOK loading rack number. Suppliers may authorize carriers across multiple terminals. Loading rack numbers are available in the GetLoadingRacks endpoint (Locations) in the id field.