Overview

This node operation retrieves a specific order from the Square API using the provided Order ID. It is useful for scenarios where you need to fetch detailed information about a particular order, such as its status, items, customer details, and payment information. For example, you might use this operation to display order details in a dashboard or to verify order information before processing a refund.

Use Case Examples

1. Retrieve an order by its ID to display order details in a customer service application.
2. Fetch order information to verify payment status before shipping products.

Properties

Output

JSON

• order_id - The unique identifier of the retrieved order.
• location_id - The location associated with the order.
• customer_id - The customer who placed the order.
• line_items - Details of items included in the order.
• state - Current state or status of the order.
• total_money - Total amount of money for the order.
• created_at - Timestamp when the order was created.
• updated_at - Timestamp when the order was last updated.

Dependencies

• Square API access with an API key credential

Troubleshooting

• Ensure the Order ID is valid and exists in the Square system to avoid 'not found' errors.
• Check API credentials and permissions if authentication errors occur.
• Handle JSON parsing errors gracefully if input data is malformed.

Links

• Square API - Retrieve Order - Official Square API documentation for retrieving an order by ID.