Open APIs

 View Only
  • 1.  Shipment Management API (TMF711) / Shipping Order Management API (TMF700)

    Posted Mar 31, 2022 12:44
    Hello,

    I have a question regarding which Open API should be used to track the status of a delivery order associated with a product order and return fields such as the status and planned delivery date of that delivery order. The context is the delivery of a mobile phone to a customer's home. I have found 2 Open APIs but they both have main entity fields in common:

    Shipment Management API (TMF711): The Shipment entity has fields that include placeFrom, placeTo, and shippingInstruction. This entity does not have a status field.
    Shipping Order Management API (TMF700): The ShippingOrder entity has fields including placeFrom, placeTo, and shippingInstruction. This entity has a status field and is associated with a productOrder.

    Which of these Open APIs would fit in the explained context?

    Thanks for your answers.

    ------------------------------
    Marisol Claudia Nuñez Wagner
    TELEFONICA
    ------------------------------


  • 2.  RE: Shipment Management API (TMF711) / Shipping Order Management API (TMF700)

    TM Forum Member
    Posted Apr 01, 2022 03:19
    Hello Marisol,

    It will not simplify but I will add the TMF684 in the loop. TMF684 has not been updated for a long time but this API cover shipping tracking. You have there the status but also all checkpoint. This is, for  me, the api providing the king of information we can have on transport supplier.
    From the ProductOrder, a shippingOrder is send to to the logistic/transport. Shipment are defined depending on rule and then from this shipment you can use TMF684. Note that TMF684 allow to reference order so you can have here a link with your PO.
    For ref: TMF684: tmforum-apis/TMF684_ShipmentTracking: TM Forum Open APIs (Apache 2.0) Shipment Tracking API (github.com)

    Hope it helps,
    Ludovic

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 3.  RE: Shipment Management API (TMF711) / Shipping Order Management API (TMF700)

    Posted Apr 01, 2022 13:27
    Hello Ludovic,

    I looked for the Open API you mentioned on the TM Forum page and didn't find it in the tables:
    • Open API Table (TM Forum Open APIs Production Versions)
    • Open API Table - Early Adoption (Beta) (TM Forum Open APIs Early Adoption (Beta) Versions)

    But if I found it in the table:
    • Open API Table - Historic (TM Forum Open APIs Historic Versions)

    Do you know if the Open API Shipment Tracking API (TMF684) is deprecated?

    Thanks for your answers.

    ------------------------------
    Marisol Claudia Nuñez Wagner
    TELEFONICA
    ------------------------------



  • 4.  RE: Shipment Management API (TMF711) / Shipping Order Management API (TMF700)

    TM Forum Member
    Posted Apr 04, 2022 03:28
    Hello Marisol
    I do not think the API is deprecated. As far as I know the GIT is the source of truth and nothing mention 684 has deprecated.
    The API feature are not covered or replaced by another API.

    Probably it is more a 'resource' problem and we're lacking member contribution to complete the API work. Adding @Florin Tene in the loop as Florin is our latest member to have worked on this API.

    Thanks,
    Ludovic​

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 5.  RE: Shipment Management API (TMF711) / Shipping Order Management API (TMF700)

    TM Forum Member
    Posted Apr 04, 2022 05:39
    One correction: My previous statement about GIT as source of truth is wrong. The Open API Table page (Open API Table - TM Forum Ecosystem API Portal - TM Forum Confluence) is automatically updated where it is not the case for the GIT.
    Thanks @Jonathan Goldberg & @Henrique Rodrigues for your awareness.​​​

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 6.  RE: Shipment Management API (TMF711) / Shipping Order Management API (TMF700)

    TM Forum Member
    Posted Apr 04, 2022 06:05
    Hi Marisol,

    Shipping Order Management API (TMF700) is the API for managing the shipment order. One shipment order can be decomposed into multiple shipments (as per business logic or customer preference) - handled by Shipment Management (TMF711).

    The ShippingOrder does include the relationship with the ShipmentRefOrValue, where it contains the overall "state" of the shipment and all the relevant dates (e.g., collectionDate, completionDate, deliveryDate, expectedDeliveryDate, etc.).

    ShippingOrder - ShippingOrderItem - ShipmentRefOrValue


    If you want to use just the Ref, the above-listed attributes are available. Otherwise, you can always expand the ShipmentRefOrValue into the Shipment value where the Shipment entity does include the "ShipmentTrackingRef" which points to the ShipmentTracking API (TMF684).
    Shipment - ShipmentTrackingRef



    The ShipmentTracking(TMF684) is not deprecated at all and is currently under work along side the ShipmentManagement (TMF711).

    I hope this helps but happy to follow up if there are any other questions.

    Thank you,
    Florin

    ------------------------------
    Florin Tene
    CityFibre
    ------------------------------



  • 7.  RE: Shipment Management API (TMF711) / Shipping Order Management API (TMF700)

    Posted Apr 04, 2022 11:08
    Hi Ludovic, Florin,

    Thanks, your answers helped me a lot.

    ------------------------------
    Marisol Claudia Nuñez Wagner
    TELEFONICA
    ------------------------------



  • 8.  RE: Shipment Management API (TMF711) / Shipping Order Management API (TMF700)

    Posted 21 days ago
    Hi Florin,

    I was looking for the REST Specification of the Open APIs:

    Shipping Order Management API
    Shipment Management API
    Shipment Tracking API

    To see the detail of the Resource model of each one.

    But I only found the following files:

    TMF700_Shipping_Order_Management_API_REST_Specification_v4-0-0_manual.pdf (In the Community)
    TMF684_Shipment_Tracking_API_user_guides_18.0.1.pdf (In the Open API Table - Historic)

    I don't know if they are the latest versions. Could you confirm if they are the latest versions and send me the REST Specification of the Shipment Management API please?

    Thank you,






    ------------------------------
    Marisol Claudia Nuñez Wagner
    TELEFONICA
    ------------------------------