Actions57
- Company Actions
- Company - Address Actions
- Company - User Actions
- Company - Contact Actions
- Company - Group Actions
- Company - Role Actions
- Company - Rule Actions
- Company - Sku Actions
- Company - Restrict Actions
- Sales Organization Actions
- Product Actions
- Category Actions
- Servicecenter - Order Actions
- Servicecenter - Invoice Actions
- Servicecenter - Credit Memo Actions
- Servicecenter - Shipment Actions
- Servicecenter - Tracking Actions
- Servicecenter - Reshipment Actions
- Servicecenter - Backorder Actions
- Requests - Inquiry Actions
- Requests - Ticket Actions
- Requests - Return Registration Actions
- Download Actions
- Bill of Material Actions
Requests - Return Registration → Create or Update
AI-generatedOverview
This node handles the creation or updating of return registrations (returns) in a system, typically used in e-commerce or logistics workflows. It allows users to specify detailed return information such as customer and company IDs, shipping methods, return positions (items being returned), and additional metadata. The node supports both single and bulk processing modes and can return the API response directly to a webhook for real-time integration.
Use Case Examples
- Creating a return registration for a customer who wants to return multiple items with specific reasons and shipping methods.
- Updating an existing return registration with additional documents or comments.
- Using bulk API mode to process multiple return registrations in one request for efficiency.
Properties
| Name | Meaning |
|---|---|
| Request Options | Options to control API request behavior such as debug mode, SSL certificate validation, and request timeout. |
| Return to Webhook | Whether to return the API response to a webhook (requires a Respond to Webhook node). |
| Use Bulk API | Whether to use the bulk API for processing multiple items efficiently. |
| Dataflow ID | Optional override for the dataflow ID, automatically read from webhook input if not set. |
| Company Customer ID | Customer ID of the company for which the return is registered. |
| Company ID | Internal ID of the company associated with the return. |
| Return Shipping Method | Shipping method used for the return, e.g., return shipment or pickup. |
| Return Positions Type | Method to specify return positions, either by mapping fields or raw JSON. |
| Return Positions | Details of each return position including SKU, quantity, return reason, and optional additional fields like document files and comments. |
| Return Positions JSON | Raw JSON input for return positions when using JSON mode. |
| Document Files | Return document files associated with the return, provided either as UI collection or raw JSON. |
| Additional Fields | Additional optional fields for the return such as extension attributes, store ID, status, comments, address details, contact info, user ID, dimensions, customer info, and crypt key. |
Output
JSON
response- The API response data from creating or updating the return registration.requestDetails- Optional debug information about the API request (method, URL, body) if debug mode is enabled.
Dependencies
- An API key credential for authenticating with the Avanta API
Troubleshooting
- Ensure required fields like Company Customer ID, Return Shipping Method, and Return Positions are provided to avoid validation errors.
- If using JSON mode for return positions, ensure the JSON is correctly formatted to prevent parsing errors.
- Enable debug mode to get detailed request information for troubleshooting API call issues.
- If SSL certificate validation fails, consider enabling 'Ignore SSL Issues' option, but be aware of security risks.