Actions28
- Asset Actions
- Availability Exception Actions
- Event Actions
- Image Actions
- Listing Actions
- Marketplace Actions
- Stock Actions
- Transaction Actions
- User Actions
Transaction → Update
AI-generatedSummary
Update a transaction's metadata, optionally simplifying the response.
Inputs
- simplify — Whether to return a simplified version of the response.
- transactionId (required) — ID of the transaction to update metadata for.
- speculative — Whether to preview changes without actually updating the transaction.
- fieldsToReturn — Fields to include in the response; can be selected from a list or specified via expression.
- listingFields — Fields related to the listing to include in the response; can be selected from a list or specified via expression.
- userFields — User-related fields to include in the response; can be selected from a list or specified via expression.
- transactionFields — Fields to add or update on the transaction; supports metadata or protected data via a collection with manual or JSON modes.
- protectedData — Protected data fields to add or update on the transaction; similar to transactionFields but for protected data.
- fieldDeletions — Fields to delete from the transaction's extended data; can specify by type and path.
Output shape
a single updated transaction record (or a simplified subset if simplify=true)
When simplify is false the full transaction object with selected fields is returned; otherwise only a subset of fields is returned. Errors are reported in the response body if the transaction ID is invalid or missing.
Examples
Example 1: Update metadata without preview
Set simplify=false, provide transactionId, optionally specify fieldsToReturn.
Example 2: Preview the update
Set speculative=true, provide transactionId, optionally choose fieldsToReturn; response shows the prospective updated transaction.
Example 3: Delete an extended data field
Add fieldDeletions entry with dataType='metadata' and fieldPath='shipping.trackingNumber' to remove the field.