Salla icon

Salla

Interact with Salla.sa e-commerce platform API

Actions45

Shipment → Update

AI-generated

Overview

This node operation updates an existing shipment in the Salla.sa e-commerce platform. It allows users to modify shipment details such as recipient information, cash on delivery amount, and other shipment-specific fields. This operation is useful for managing and correcting shipment data after creation, ensuring accurate delivery information and payment details.

Use Case Examples

  1. Updating the recipient's address or contact details for a shipment.
  2. Changing the cash on delivery amount or currency for a shipment.
  3. Adding remarks or external shipping company identifiers to an existing shipment.

Properties

Name Meaning
ID The unique identifier of the shipment to update.
Additional Fields Optional fields to update shipment details, including order ID, description, recipient information, cash on delivery details, and external shipping company data.

Output

JSON

  • id - The unique identifier of the updated shipment.
  • courier_id - Identifier of the courier handling the shipment.
  • shipment_type - Type of shipment (e.g., shipment or return).
  • payment_method - Payment method for the shipment (e.g., pre-paid or cash on delivery).
  • ship_to
    • name - Recipient's name.
    • email - Recipient's email address.
    • phone - Recipient's phone number.
    • country - Recipient's country code or ID.
    • city - Recipient's city name or ID.
    • address_line - Recipient's street address.
    • postal_code - Recipient's postal code.
    • street_number - Recipient's street number.
    • block - Recipient's block or building identifier.
  • cash_on_delivery
    • amount - Cash on delivery amount if applicable.
    • currency - Currency code for cash on delivery.
  • description - Brief summary of shipment contents.
  • remarks - Additional notes or delivery instructions.
  • external_id - External shipping company identifier.
  • external_company_name - External shipping company name.

Dependencies

  • Salla.sa API
  • An API key credential for authentication

Troubleshooting

  • Ensure the shipment ID provided is valid and exists in the system to avoid 'resource not found' errors.
  • Verify that the cash on delivery amount and currency are correctly set if the payment method is COD.
  • Check that all required fields are provided and correctly formatted to prevent validation errors from the API.

Links

Discussion