SocialHub icon

SocialHub

SocialHub System API Integration Node
Join our community

Actions18

Overview

This node integrates with the SocialHub system API to synchronize transaction information related to order management. It allows users to send detailed transaction data, including member identification, order details, payment amounts, and product details, to the SocialHub platform. This is useful for keeping the SocialHub system updated with the latest transaction records from various sales channels, such as Shopify, enabling accurate tracking and management of orders, returns, exchanges, and associated loyalty points.

Use Case Examples

  1. Synchronize a new order transaction from Shopify with member identified by mobile phone, including product details and payment amounts.
  2. Update the SocialHub system with a return order transaction, specifying the original order number and transaction status.
  3. Send detailed transaction data for an exchange order, including discounts, coupon amounts, and freight charges.

Properties

Name Meaning
Member Identifier Type Type of member identifier used (mobile phone, email, or employee ID). Determines how the member is identified in the transaction.
Member Identifier Parameter The actual identifier value corresponding to the selected member identifier type (e.g., phone number, email, or employee ID).
Phone Prefix Phone number prefix, required only if the member identifier type is mobile phone.
Loyalty Program Code Optional code representing the loyalty program associated with the transaction.
Order Source Channel The sales channel from which the order originated (e.g., Shopify).
Transaction Number Unique identifier for the transaction being synchronized.
Store Code Code identifying the store where the transaction took place.
Order Date Date and time when the order was placed, formatted as YYYY-MM-DD HH:MM:SS.
Transaction Direction Indicates whether the transaction is a normal order, return, or exchange.
Transaction Status Current status of the transaction (paid, shipped, delivered, or returned).
Transaction Score Point Status Status of score points related to the transaction, indicating if points are issued, processing, or exception.
Original Sales Amount Original sales amount in cents before discounts or coupons.
Receivable Amount Amount receivable in cents after discounts and coupons.
Coupon Amount Amount discounted by coupons in cents.
Discount Amount Additional discount amount in cents.
Total Discount Amount Total discount amount in cents combining all discounts and coupons.
Actual Received Amount Actual amount received in cents for the transaction.
Actual Received Tax-Deducted Amount Actual amount received after tax deduction in cents.
Freight Freight charges in cents associated with the transaction.
Original Order Number Original order number, used for return transactions to reference the initial order.
Transaction Product Details Collection Collection of product details involved in the transaction, including product codes, quantities, prices, discounts, and amounts.

Output

JSON

  • data - Response data from the SocialHub API after synchronizing the transaction.

Dependencies

  • An API key credential for SocialHub API authentication

Troubleshooting

  • Ensure all required fields are provided, especially member identifier and transaction details, to avoid validation errors.
  • Verify the phone prefix is set correctly when using mobile phone as the member identifier type.
  • Check that the transaction date is formatted correctly as 'YYYY-MM-DD HH:MM:SS' to prevent parsing errors.
  • If the API returns authentication errors, confirm that the SocialHub API credentials are correctly configured and valid.
  • For errors related to product details, ensure each product entry includes all required fields such as product code, quantity, and price.

Links

Discussion