Magento REST icon

Magento REST

Consume Magento REST API

Order → Create Shipment

AI-generated

Summary

Create a shipment for an order

Inputs

  • orderId (required) — Order ID
  • shipmentData — Shipment data in JSON format; if provided, sent as {shipment: } in the POST body
  • websiteCode — Store view code for multi-store Magento instances (used in API URL prefix /rest/{code}/V1/...)
  • simplifyOutput — When enabled, flattens the API response (converts custom_attributes array to object, flattens extension_attributes, simplifies nested structures)

Output shape

Magento API response confirming shipment creation; if simplifyOutput is true, the response is flattened via flattenResponse (custom_attributes becomes object, extension_attributes flattened, nested structures simplified)

Returns the processed JSON response; error data is also captured if continueOnFail is enabled

Links

Discussion