Actions16
- Customers Actions
- Options Actions
- Orders Actions
- Products Actions
- Variants Actions
Overview
This node integrates with the Sharpei API to retrieve detailed information about a specific order. It is designed to fetch an order by its unique identifier (Order Pid). This functionality is useful in scenarios where you need to access order details for processing, reporting, or integration with other systems such as CRM or ERP.
Practical examples:
- Fetching order details to display in a custom dashboard.
- Retrieving order information to trigger shipment or fulfillment workflows.
- Integrating order data into accounting or inventory management systems.
Properties
| Name | Meaning |
|---|---|
| Order Pid | The unique identifier of the order to retrieve. This is a required string input. |
Output
The node outputs JSON data representing the full details of the requested order. This typically includes fields such as order metadata, customer information, items ordered, status, and timestamps. The exact structure depends on the Sharpei API response for an order.
If the node supports binary data output (not indicated here), it would represent any associated files or attachments related to the order, but this is not evident from the provided code.
Dependencies
- Requires an active connection to the Sharpei API.
- Needs an API authentication token or key configured in the node credentials to authorize requests.
- The base URL for API requests is
https://api.prod.gosharpei.com/api. - The node expects JSON responses and sends JSON requests.
Troubleshooting
- Missing or invalid Order Pid: The node requires a valid order identifier; ensure this is correctly provided.
- Authentication errors: Verify that the API key or token credential is correctly set up and has sufficient permissions.
- Network issues or API downtime: Check connectivity to the Sharpei API endpoint.
- Unexpected API responses: Confirm that the order exists and the API version matches the node's expectations.
Common error messages might include:
- Unauthorized or 401 errors indicating credential problems.
- 404 Not Found if the order ID does not exist.
- 400 Bad Request if the input parameters are malformed.
Resolving these usually involves verifying inputs, credentials, and API availability.
Links and References
- Sharpei API Documentation (Assumed official docs for further details)
- n8n documentation on creating custom nodes