Salla icon

Salla

Interact with Salla.sa e-commerce platform API

Actions38

Overview

The node integrates with the Salla.sa e-commerce platform API to retrieve shipment data. Specifically, the "Shipment" resource with the "Get All" operation allows users to fetch multiple shipment records from their Salla store.

This operation is useful for scenarios such as:

  • Synchronizing shipment data into other systems or databases.
  • Generating reports on shipments filtered by status or date.
  • Monitoring shipment statuses in bulk for logistics or customer service purposes.

For example, a user could retrieve all shipments created within a specific date range that are currently "Pending" or "Completed," enabling targeted follow-up actions.

Properties

Name Meaning
Return All Whether to return all shipment results or limit the number of returned items.
Limit Maximum number of shipment results to return (applicable only if "Return All" is false). Range: 1-100.
Filters Collection of filters to narrow down the shipments retrieved:
- Status Filter shipments by one or more statuses: Active, Inactive, Draft, Pending, Completed, Cancelled.
- Date From Filter shipments created on or after this date/time.
- Date To Filter shipments created on or before this date/time.
- Search Text search term to filter shipments by matching relevant fields.

Output

The output is a JSON array where each item represents a shipment object retrieved from the Salla API. Each shipment object contains details such as shipment ID, status, dates, and other shipment-specific information as provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials for the Salla platform.
  • The node uses internal helper functions to make authenticated HTTP requests to the Salla API endpoints.
  • No additional external dependencies beyond the configured API credential are needed.

Troubleshooting

  • Common Issues:

    • Incorrect or expired API credentials will cause authentication failures.
    • Using invalid filter values (e.g., unsupported status) may result in empty responses or errors.
    • Requesting too many records without setting "Return All" properly may lead to truncated results.
  • Error Messages:

    • "The operation "getAll" is not supported for shipments!" — This indicates a misconfiguration or unsupported operation; ensure the operation is set correctly.
    • Network or API errors will typically propagate messages from the Salla API; verify network connectivity and API status.
  • Resolutions:

    • Verify and refresh API credentials if authentication errors occur.
    • Double-check filter values against allowed options.
    • Use "Return All" cautiously to avoid performance issues with very large datasets.

Links and References

Discussion