Salla icon

Salla

Interact with Salla.sa e-commerce platform API

Actions45

Shipment → Create

AI-generated

Overview

This node operation creates a new shipment in the Salla e-commerce platform. It is useful for automating the process of generating shipment records for orders, specifying courier details, shipment type, payment method, and recipient information. For example, it can be used to create shipments for customer orders with specific courier assignments and delivery instructions.

Use Case Examples

  1. Creating a shipment with courier ID, shipment type as 'shipment', and payment method as 'pre_paid'.
  2. Creating a return shipment with courier ID, shipment type as 'return', and payment method as 'cod' (Cash on Delivery), including recipient details and COD amount.

Properties

Name Meaning
Courier ID Shipment courier identification number, used to specify which courier service will handle the shipment.
Shipment Type Type of shipment, either a regular shipment or a return shipment.
Payment Method Payment method for the shipment, either pre-paid or cash on delivery.
Additional Fields Optional additional shipment details such as order ID, description, remarks, external IDs, COD amount and currency, and recipient contact and address information.

Output

JSON

  • courier_id - ID of the courier handling the shipment
  • shipment_type - Type of shipment (shipment or return)
  • payment_method - Payment method for the shipment
  • order_id - Order ID associated with the shipment (if provided)
  • description - Brief summary of shipment contents (if provided)
  • remarks - Additional notes or delivery instructions (if provided)
  • external_id - External shipping company identifier (if provided)
  • external_company_name - External shipping company name (if provided)
  • cash_on_delivery
    • amount - Cash on delivery amount (if payment method is COD)
    • currency - Currency code for cash on delivery amount
  • ship_to
    • name - Recipient name
    • email - Recipient email address
    • phone - Recipient phone number
    • country - Recipient country code or ID
    • city - Recipient city name or ID
    • address_line - Recipient street address
    • postal_code - Recipient ZIP/postal code
    • street_number - Recipient street number
    • block - Recipient block/building identifier

Dependencies

  • Salla API with OAuth2 authentication

Troubleshooting

  • Ensure that the courier ID provided is valid and exists in the Salla system.
  • If using Cash on Delivery payment method, the COD amount must be provided and greater than zero.
  • Check that all required fields (courier ID, shipment type, payment method) are filled before execution.
  • API errors may occur if the shipment data is incomplete or invalid; verify the data format and required fields.
  • Network or authentication issues with the Salla API can cause failures; ensure valid OAuth2 credentials are configured.

Links

Discussion