Salla icon

Salla

Interact with Salla.sa e-commerce platform API

Actions45

Shipment → Get

AI-generated

Overview

This node interacts with the Salla.sa e-commerce platform API to retrieve shipment information. Specifically, for the Shipment resource with the Get operation, it fetches details of a single shipment by its ID. This is useful for scenarios where you need to track or manage shipment details of orders, such as checking shipment status or verifying shipment data.

Use Case Examples

  1. Retrieve shipment details by providing the shipment ID to monitor delivery status.
  2. Use the node to fetch shipment information for customer support or order management purposes.

Properties

Name Meaning
ID The ID of the shipment resource to retrieve.

Output

JSON

  • id - The unique identifier of the shipment.
  • courier_id - The ID 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 - Amount for cash on delivery payment, if applicable.
    • currency - Currency code for cash on delivery payment.
  • status - Current status of the shipment.
  • created_at - Timestamp when the shipment was created.
  • updated_at - Timestamp when the shipment was last updated.

Dependencies

  • Salla.sa API OAuth2 credentials

Troubleshooting

  • Ensure the shipment ID provided is valid and exists in the Salla.sa system to avoid 'resource not found' errors.
  • Check that the OAuth2 credentials for Salla.sa API are correctly configured and have the necessary permissions to access shipment data.
  • If the API request fails, verify network connectivity and API endpoint availability.

Discussion