Salla icon

Salla

Interact with Salla.sa e-commerce platform API

Actions45

Shipment → Get All

AI-generated

Overview

This node operation retrieves multiple shipment records from the Salla.sa e-commerce platform. It supports fetching all shipments or a limited number based on user input, with optional filters such as order ID and shipment status. This is useful for scenarios where users need to monitor or analyze shipment data, track delivery statuses, or integrate shipment information into other workflows.

Use Case Examples

  1. Fetch all shipments related to a specific order ID to monitor delivery progress.
  2. Retrieve a limited number of shipments filtered by status to generate reports on pending or completed shipments.

Properties

Name Meaning
Return All Whether to return all shipment results or only up to a given limit.
Limit Maximum number of shipment results to return when not returning all.
Filters Filters to narrow down shipments by order ID or shipment status.

Output

JSON

  • id - Unique identifier of the shipment.
  • order_id - Identifier of the order associated with the shipment.
  • status - Current status of the shipment.
  • courier_id - Identifier of the courier handling the shipment.
  • shipment_type - Type of shipment (e.g., shipment or return).
  • payment_method - Payment method used for the shipment.
  • ship_to
    • name - Name of the shipment recipient.
    • email - Email address of the shipment recipient.
    • phone - Phone number of the shipment recipient.
    • country - Country of the shipment recipient.
    • city - City of the shipment recipient.
    • address_line - Street address of the shipment recipient.
    • postal_code - Postal code of the shipment recipient.
    • street_number - Street number of the shipment recipient.
    • block - Block or building identifier of the shipment recipient.
  • cash_on_delivery
    • amount - Cash on delivery amount if applicable.
    • currency - Currency code for cash on delivery amount.

Dependencies

  • Salla.sa API OAuth2 credentials

Troubleshooting

  • Ensure the OAuth2 credentials for Salla.sa API are correctly configured and valid.
  • Check that the shipment filters (order ID, status) are correctly formatted and valid.
  • If the node returns an error about unsupported operations, verify that the operation is set to 'Get All' for the Shipment resource.
  • Network issues or API rate limits may cause request failures; retry or check API usage limits.

Links

Discussion