Salla icon

Salla

Interact with Salla.sa e-commerce platform API

Actions38

Overview

This node integrates with the Salla.sa e-commerce platform API to manage shipments. Specifically, the Update Shipment operation allows users to modify details of an existing shipment by providing its ID and the fields to update. This is useful in scenarios where shipment information such as name, description, or status needs to be changed after creation.

Practical examples include:

  • Updating the status of a shipment from "draft" to "active" once it is ready for dispatch.
  • Changing the description or name of a shipment to reflect updated delivery instructions or packaging details.

Properties

Name Meaning
ID The unique identifier of the shipment resource to update.
Additional Fields Optional fields to update on the shipment:
- Name New name for the shipment.
- Description New description for the shipment.
- Status Status of the shipment; possible values are: Active, Inactive, Draft.

Output

The output is a JSON object representing the updated shipment resource as returned by the Salla API. It contains all relevant shipment details including any changes made during the update operation.

No binary data output is produced by this operation.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials to access the Salla API.
  • The node depends on the sallaApiRequest helper function to make HTTP requests to the Salla API endpoints.
  • Proper network connectivity to the Salla.sa platform is necessary.

Troubleshooting

  • Error: "The operation 'update' is not supported for shipments!"
    This error indicates that the operation parameter was set incorrectly or the code path does not support the requested operation. Ensure the operation is exactly "update" and the resource is "shipment".

  • API Request Failures (e.g., 401 Unauthorized, 404 Not Found)
    These errors typically occur due to invalid or missing API credentials, or if the shipment ID provided does not exist. Verify the API key/token and confirm the shipment ID is correct.

  • Empty or Missing Required Fields
    The "ID" field is mandatory. Omitting it will cause the request to fail. Make sure to provide a valid shipment ID.

Links and References

Discussion