avanta icon

avanta

Consume avanta API

Actions57

Servicecenter - Reshipment → Create or Update

AI-generated

Overview

This node handles the creation or updating of reshipments in the Servicecenter - Reshipment resource. It is designed to facilitate the management of reshipment data, including customer and company IDs, reshipment positions, document files, and various additional fields. The node supports both single and bulk operations, allowing users to add reshipment positions either through structured fields or raw JSON. It also provides options for debugging, SSL handling, and request timeout settings.

Use Case Examples

  1. Creating a new reshipment with detailed item positions and associated document files for a customer.
  2. Updating an existing reshipment with additional custom fields and extension attributes.
  3. Using the bulk API to process multiple reshipment entries efficiently.

Properties

Name Meaning
Request Options Options to configure the API request such as debug mode, SSL certificate validation, and timeout duration.
Return to Webhook Whether to return the response to a webhook, requiring a subsequent 'Respond to Webhook' node.
Use Bulk API Whether to use the bulk API for processing multiple items.
Dataflow ID Optional override for the dataflow ID, automatically read from webhook input if not set.
Customer ID ID of the customer for the reshipment.
Company ID ID of the company associated with the reshipment.
Customer Reshipment ID Reshipment ID provided by the customer.
Reshipment Positions Type Method to add reshipment positions, either via structured fields or raw JSON.
Reshipment Positions Collection of item positions in the reshipment with detailed fields such as item position, name, price, quantity, SKU, subtotal, and additional optional fields like batch number, comments, custom dates, prices, quantities, text fields, discount, EAN, packaging unit, status, tax amount, tax percent, extension attributes, and item document files.
Reshipment Positions JSON Raw JSON input to add reshipment positions dynamically.
Document Files Collection or JSON array of document files associated with the reshipment, including document ID, type, file, and date.
Additional Fields Additional optional fields for the reshipment such as custom dates, prices, texts, customer order ID, extension attributes, reshipment date, status, grand total, tax amount, external ID, and billing information (city, company, country, email, name, street, telephone, zip).

Output

JSON

  • reshipmentId - The unique identifier of the created or updated reshipment.
  • status - The status of the reshipment after the operation.
  • message - Additional message or information returned from the API regarding the operation.

Dependencies

  • An API key credential for authenticating with the Avanta API.

Troubleshooting

  • Ensure all required fields such as Customer ID, Company ID, and Customer Reshipment ID are provided to avoid validation errors.
  • If using the bulk API, verify that the dataflow ID is correctly set or available in the webhook input to prevent processing errors.
  • Enable Debug Mode to get detailed API request information if the node fails to execute as expected.
  • If SSL certificate validation issues occur, consider enabling the option to ignore SSL issues, but be aware of the security implications.
  • Check the timeout setting if the API server is slow to respond, and increase it if necessary to avoid premature request abortion.

Discussion