Shopware

Read, update, write and delete data from Shopware

Actions20

Product Actions
Customer Actions
Order Actions
Category Actions

Order → Get

AI-generated

Summary

Retrieve details of a specific order from Shopware by its unique Order ID, with an optional filter to specify which fields to return.

Inputs

Order ID (required) — The unique identifier of the order to retrieve. This ID can be found in the URL when viewing the order in Shopware Admin (e.g., https://your-domain.com/admin#/sw/order/detail/).
Filters — Optional collection to filter the response fields returned for the order. You may specify a comma-separated string of field names to limit the returned data to those fields only. By default, all fields are returned.

Output shape

a single record representing the order matching the specified Order ID, including requested fields if specified, otherwise all fields.

The output contains detailed information about the order fetched from Shopware. If the specified ID does not exist, an error is typically raised or no data is returned. The 'fields' filter controls which properties of the order are included in the result.

Discussion