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
Servicecenter - Shipment → Create or Update
AI-generatedOverview
This node handles the creation or updating of shipments within the Servicecenter - Shipment resource. It is designed to facilitate shipment management by allowing users to specify detailed shipment information, including customer and company IDs, shipment positions, document files, and various additional fields. The node supports both single and bulk operations, with options to provide shipment positions either through structured fields or raw JSON. It also offers debugging and SSL options for API requests. This node is beneficial in scenarios where automated shipment processing and integration with the Avanta API are required, such as in logistics, order fulfillment, and supply chain workflows.
Use Case Examples
- Creating a new shipment with multiple shipment positions and associated document files for a specific customer and company.
- Updating an existing shipment with additional custom fields and extension attributes.
- Using the bulk API to process multiple shipment creation requests efficiently.
Properties
| Name | Meaning |
|---|---|
| Request Options | Options to configure API request behavior such as debug mode, SSL certificate validation, and request timeout. |
| Return to Webhook | Whether to return the response directly to a webhook (only for create operation). |
| Use Bulk API | Whether to use the bulk API for processing multiple items (applicable to create operation). |
| Dataflow ID | Optional override for the dataflow ID, automatically read from webhook input if not set (applicable when using bulk API). |
| Customer ID | ID of the customer for the shipment. |
| Company ID | ID of the company associated with the shipment. |
| Customer Shipment ID | Shipment ID provided by the customer. |
| Shipment Positions Type | Method to add shipment positions, either using structured fields or raw JSON. |
| Shipment Positions | Detailed shipment position entries including item details, quantities, prices, and additional custom fields (shown when using fields below option). |
| Shipment Positions JSON | Raw JSON input for shipment positions (shown when using JSON option). |
| Document Files | Shipment document files, which can be added manually or provided as a JSON array. |
| Additional Fields | Additional optional fields for the shipment such as custom dates, prices, texts, order IDs, shipment date, status, shipping details, and extension attributes. |
Output
JSON
shipmentId- The unique identifier of the created or updated shipment.status- The status of the shipment after the operation.message- Additional message or information returned from the API regarding the shipment operation.
Dependencies
- An API key credential for authenticating with the Avanta API.
Troubleshooting
- Ensure required fields such as Customer ID, Company ID, and Customer Shipment 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 data.
- Enable Debug Mode to get detailed API request information for troubleshooting connection or data issues.
- If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.
- Check the timeout setting if the API server is slow to respond, and increase it if necessary.