Synca Superpharm icon

Synca Superpharm

Comprehensive Superpharm Marketplace API integration for Orders, Offers, Products, Inventory, Messages, Shipping, and more

Actions37

Shipping → Create Shipment

AI-generated

Overview

This node operation creates new shipments with tracking information in the Superpharm Marketplace API. It is useful for automating the process of shipping orders by sending shipment details such as order line IDs, carrier codes, and tracking numbers to the API. For example, after an order is packed and ready to ship, this node can be used to register the shipment and provide tracking data to the marketplace system.

Use Case Examples

  1. Automate shipment creation for multiple orders by providing a JSON array of shipment data including order line IDs, carrier codes, and tracking numbers.
  2. Integrate with a shipping carrier system to automatically update shipment tracking information in the Superpharm Marketplace.

Properties

Name Meaning
Credentials Select the Superpharm API credentials to use for authentication.
Shipments Data JSON array of shipment data to create shipments, including order line IDs, carrier codes, and tracking numbers.
Query Options Optional parameters for the API request such as limit, offset, page token, sort field, order direction, shop ID, and locale for internationalized data.
Advanced Options Additional options such as returning the full API response, handling rate limiting automatically, and setting request timeout in seconds.

Output

JSON

  • json - The JSON response from the Superpharm API after creating shipments. This can be either the full response including metadata or the parsed shipment data depending on the 'Return Full Response' option.

Dependencies

  • Superpharm API credentials for authentication

Troubleshooting

  • Common issues include invalid or missing shipment data in the JSON array, which can cause API errors. Ensure the shipment data includes required fields like order_line_id, carrier_code, and tracking_number.
  • API rate limiting may cause 429 errors; enabling the 'Handle Rate Limiting' option allows automatic retries.
  • Timeout errors can occur if the request takes too long; adjust the 'Request Timeout' setting as needed.
  • Error messages from the API are logged and returned in the output if 'Continue On Fail' is enabled, allowing troubleshooting of specific shipment creation failures.

Links

Discussion