TM Forum Community

Hi Team,

Good day.

I am working on a usecase where a hardware delivery order with multiple shipments needs to be handled. Currently, TMF700 Shipping Order API is exposed through which logistics is receiving shipmentItem SKU and quantity within the shippingOrderItems. When the shipping order is progressed to supply chain provider or courier, delivery is splitted into multiple shipments or consignments. Assume a case where quantity is 100. Courier partner is returning multiple shipment tracking details associated with the shipment item as all 100 items are not going in single shipment. Current model for shipment tracking within the shipment is an object and cannot hold multiple tracking details. Could you please suggest?

Hi Tony

I think that the shipment is intended to be per parcel/package, so if the quantity (100) exceeded a single parcel, then multiple shipments would be required from the same delivery/courirer partner and hence one tracking number per shipment.  The shipping order would then associate the multiple shipments within the single shipping order.  Clearly multiple items may be packaged in a single shipment (parcel) as necessary.

Hi Team,

Good day.

I am working on a usecase where a hardware delivery order with multiple shipments needs to be handled. Currently, TMF700 Shipping Order API is exposed through which logistics is receiving shipmentItem SKU and quantity within the shippingOrderItems. When the shipping order is progressed to supply chain provider or courier, delivery is splitted into multiple shipments or consignments. Assume a case where quantity is 100. Courier partner is returning multiple shipment tracking details associated with the shipment item as all 100 items are not going in single shipment. Current model for shipment tracking within the shipment is an object and cannot hold multiple tracking details. Could you please suggest?

Hi Dan,

Thanks for the response. Adding more details on the query:

1. A shipping order can have 0..* shippingOrderItem. So in a case where one product/SKU is being sent, assuming it is one shippingOrderItem.
2. shippingOrderItem can have 0..1 shipment object in it.
3. shipment object can have 0..* shipmentItem. In the usecase with one product or sku, it is again 1 element.

A sample payload below:
"shippingOrderItem": [
    {
      "id": "4aafacbd-11ff-4dc8-b445-305f2215715f",
      "action": "add",
      "shipment": {
        "shipmentItem": [
          {
            "id": "1213-4aafacbd-11ff-4dc8-b445-305f2215715f ",
            "quantity": "100",
            "sku": "SKU123"
          }
        ],
        "shipmentTrackingRef": {
          // To be received from courier, but this is an object not array
        }
      }
    }
  ]

Is above the right way to capture the shippingOrderItem for a shipping order?

Is yes, then assume shipmentItem with quantity 100 is split into multiple shipments at the courier side. When there are multiple tracking information, could you please suggest how to capture multiple shipmentTracking details in the shippingOrderItem?

Hi Tony

I think that the shipment is intended to be per parcel/package, so if the quantity (100) exceeded a single parcel, then multiple shipments would be required from the same delivery/courirer partner and hence one tracking number per shipment.  The shipping order would then associate the multiple shipments within the single shipping order.  Clearly multiple items may be packaged in a single shipment (parcel) as necessary.

Hi Team,

Good day.

I am working on a usecase where a hardware delivery order with multiple shipments needs to be handled. Currently, TMF700 Shipping Order API is exposed through which logistics is receiving shipmentItem SKU and quantity within the shippingOrderItems. When the shipping order is progressed to supply chain provider or courier, delivery is splitted into multiple shipments or consignments. Assume a case where quantity is 100. Courier partner is returning multiple shipment tracking details associated with the shipment item as all 100 items are not going in single shipment. Current model for shipment tracking within the shipment is an object and cannot hold multiple tracking details. Could you please suggest?

Hi Tony

Thanks for the additional details.

The shipping order API and stock management API are currently being transformed to align with the ODA production functional block, which means that both APIs will refer to stockItem rather than product.

In any case, the shipping order API should support multiple shipments per shippingOrderItem (where large quantities of the item result in multiple packages/parcels/boxes) and also the API should support multiple tracking numbers per single shipment (for multiple parcels).  This depends on the transport/delivery partner.

Will raise this issue in JIRA.

Hi Dan,

Thanks for the response. Adding more details on the query:

1. A shipping order can have 0..* shippingOrderItem. So in a case where one product/SKU is being sent, assuming it is one shippingOrderItem.
2. shippingOrderItem can have 0..1 shipment object in it.
3. shipment object can have 0..* shipmentItem. In the usecase with one product or sku, it is again 1 element.

A sample payload below:
"shippingOrderItem": [
    {
      "id": "4aafacbd-11ff-4dc8-b445-305f2215715f",
      "action": "add",
      "shipment": {
        "shipmentItem": [
          {
            "id": "1213-4aafacbd-11ff-4dc8-b445-305f2215715f ",
            "quantity": "100",
            "sku": "SKU123"
          }
        ],
        "shipmentTrackingRef": {
          // To be received from courier, but this is an object not array
        }
      }
    }
  ]

Is above the right way to capture the shippingOrderItem for a shipping order?

Is yes, then assume shipmentItem with quantity 100 is split into multiple shipments at the courier side. When there are multiple tracking information, could you please suggest how to capture multiple shipmentTracking details in the shippingOrderItem?

Hi Tony

I think that the shipment is intended to be per parcel/package, so if the quantity (100) exceeded a single parcel, then multiple shipments would be required from the same delivery/courirer partner and hence one tracking number per shipment.  The shipping order would then associate the multiple shipments within the single shipping order.  Clearly multiple items may be packaged in a single shipment (parcel) as necessary.

Hi Team,

Good day.

I am working on a usecase where a hardware delivery order with multiple shipments needs to be handled. Currently, TMF700 Shipping Order API is exposed through which logistics is receiving shipmentItem SKU and quantity within the shippingOrderItems. When the shipping order is progressed to supply chain provider or courier, delivery is splitted into multiple shipments or consignments. Assume a case where quantity is 100. Courier partner is returning multiple shipment tracking details associated with the shipment item as all 100 items are not going in single shipment. Current model for shipment tracking within the shipment is an object and cannot hold multiple tracking details. Could you please suggest?

Hi Dan,

Thanks for your response, appreciate it. Could you please share me the JIRA# for our reference, once raised?

Hi Tony

Thanks for the additional details.

The shipping order API and stock management API are currently being transformed to align with the ODA production functional block, which means that both APIs will refer to stockItem rather than product.

In any case, the shipping order API should support multiple shipments per shippingOrderItem (where large quantities of the item result in multiple packages/parcels/boxes) and also the API should support multiple tracking numbers per single shipment (for multiple parcels).  This depends on the transport/delivery partner.

Will raise this issue in JIRA.

Hi Dan,

Thanks for the response. Adding more details on the query:

1. A shipping order can have 0..* shippingOrderItem. So in a case where one product/SKU is being sent, assuming it is one shippingOrderItem.
2. shippingOrderItem can have 0..1 shipment object in it.
3. shipment object can have 0..* shipmentItem. In the usecase with one product or sku, it is again 1 element.

A sample payload below:
"shippingOrderItem": [
    {
      "id": "4aafacbd-11ff-4dc8-b445-305f2215715f",
      "action": "add",
      "shipment": {
        "shipmentItem": [
          {
            "id": "1213-4aafacbd-11ff-4dc8-b445-305f2215715f ",
            "quantity": "100",
            "sku": "SKU123"
          }
        ],
        "shipmentTrackingRef": {
          // To be received from courier, but this is an object not array
        }
      }
    }
  ]

Is above the right way to capture the shippingOrderItem for a shipping order?

Is yes, then assume shipmentItem with quantity 100 is split into multiple shipments at the courier side. When there are multiple tracking information, could you please suggest how to capture multiple shipmentTracking details in the shippingOrderItem?

Hi Tony

I think that the shipment is intended to be per parcel/package, so if the quantity (100) exceeded a single parcel, then multiple shipments would be required from the same delivery/courirer partner and hence one tracking number per shipment.  The shipping order would then associate the multiple shipments within the single shipping order.  Clearly multiple items may be packaged in a single shipment (parcel) as necessary.

Hi Team,

Good day.

I am working on a usecase where a hardware delivery order with multiple shipments needs to be handled. Currently, TMF700 Shipping Order API is exposed through which logistics is receiving shipmentItem SKU and quantity within the shippingOrderItems. When the shipping order is progressed to supply chain provider or courier, delivery is splitted into multiple shipments or consignments. Assume a case where quantity is 100. Courier partner is returning multiple shipment tracking details associated with the shipment item as all 100 items are not going in single shipment. Current model for shipment tracking within the shipment is an object and cannot hold multiple tracking details. Could you please suggest?