Shipment API returns 400 error with valid payload structure (v2.4.7-p2)

[ramdpworld]

Preconditions and environment

Description :

When attempting to create a shipment using the REST API endpoint /V1/shipment, the request fails with a 400 error despite following the documented payload structure.

Environment :

• Magento Version: 2.4.7-p2
• Endpoint: /rest/default/V1/shipment
• Request Method: POST

Contact: ecomfulfilment@dpworld.com

Steps to reproduce

1. Authenticate with valid bearer token
2. Send POST request to /rest/default/V1/shipment with the following payload:

{
    "entity": {
        "order_id": 4,
        "items": [
            {
                "order_item_id": 4,
                "qty": 1
            }
        ],
        "tracks": [
            {
                "order_id": 4,
                "track_number": "NK62945729",
                "title": "dum",
                "carrier_code": "dum",
                "description": "tracking",
                "parent_id": 4,
                "qty": 1,
                "weight": 1
            }
        ],
        "comments": [
            {
                "comment": "ship",
                "is_customer_notified": 0,
                "is_visible_on_front": 0,
                "parent_id": 4
            }
        ]
    }
}

Expected result

The API should successfully create a shipment and return a 200 status code with the shipment details.

Actual result

Response Code: 400
Response Body: {"message": "The shipment couldn't be saved."}

Additional information

• The payload structure matches the official Magento REST API documentation
• All required fields are included in the request
• The bearer token authentication is valid
• The order ID and order item ID exist in the system

Release note

No response

Triage and priority

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @ramdpworld. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce.

• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant]

Hi @engcom-Bravo. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• 5. Add label Issue: Confirmed once verification is complete.
• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Delta]

Hi @ramdpworld ,

Thanks for your reporting and collaboration.
We have verified the issue in 2.4 develop instance, but we are unable to reproduce the issue. Kindly refer the screenshots.

Steps to reproduce

1. Place an order successfully.
2. Create invoice for respective order.
3. Run shipment API, Observe user is able to run api successfully.
   
   Response -
   {
   "created_at": "2025-01-13 12:56:03",
   "entity_id": 1,
   "increment_id": "000000001",
   "order_id": 4,
   "packages": [],
   "updated_at": "2025-01-13 12:56:03",
   "items": [
   {
   "entity_id": 1,
   "parent_id": 1,
   "order_item_id": 4,
   "qty": 1
   }
   ],
   "tracks": [
   {
   "order_id": 4,
   "created_at": "2025-01-13 12:56:03",
   "entity_id": 1,
   "parent_id": 1,
   "updated_at": "2025-01-13 12:56:03",
   "weight": 1,
   "qty": 1,
   "description": "tracking",
   "track_number": "NK62945729",
   "title": "dum",
   "carrier_code": "dum"
   }
   ],
   "comments": [
   {
   "is_customer_notified": 0,
   "parent_id": 1,
   "comment": "ship",
   "is_visible_on_front": 0,
   "entity_id": 1
   }
   ]
   }

Can you please verify and confirm.

Thanks.

[ramdpworld]

Hi @engcom-Delta ,

Have followed the same steps mentioned above but am still facing the same issue. I have attached a recording for reference: Magento Shipment Error Recording.

[m2-assistant]

Hi @engcom-Delta. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• 5. Add label Issue: Confirmed once verification is complete.
• 6. Make sure that automatic system confirms that report has been added to the backlog.

[ramdpworld]

@engcom-Delta Any update on the above?

[ramdpworld]

@engcom-Bravo , @engcom-Delta Any update on this?

[engcom-Delta]

Hi @ramdpworld ,

Thanks for your reporting and collaboration.
We have verified the issue in 2.4.7-p3 Instance and 2.4 develop instance, but we are unable to reproduce the issue. Kindly refer the screenshots.

Steps to reproduce

1. Place an order successfully.
2. Create invoice for respective order.
3. Run shipment API, Observe user is able to run api successfully.

Can you please provide more testing steps
Thanks.