JSON View in Pipe17

Common Use Cases

Use the JSON View when you need to:

• Inspect full data payloads: View every field and value associated with an entity, including ones not displayed in the standard UI.

• Troubleshoot sync issues: Validate exactly what data is stored or passed between systems.

• Debug event flows: Review complete request/response payloads under Events for integration diagnostics.

• Validate data accuracy: Confirm that specific fields (including nested or custom fields) contain the expected values.

• Align with API expectations: Understand the structure and format of data when working with the Pipe17 API.

Where to Access JSON View

The JSON View is accessible throughout the app, although not always labeled explicitly.

You can typically find it in:

• Entity detail pages: Look for a button or tab labeled “JSON” or “Raw Data” when viewing orders, products, or inventory records.

• Event records: Under the Events section, selecting “Details” displays the full request and response JSON for that event.

• Advanced filter setup: Understanding the JSON schema can help when configuring filters using specific field values.

Warning on Editing JSON Directly

Editing entity JSON directly is not recommended unless absolutely necessary.

• All validations in the app are bypassed when you edit JSON manually.

• Direct edits can lead to unexpected downstream consequences, especially based on the entity's status or relationships.

• Certain permissions are required to edit the JSON file.

• Changes cannot be undone.

If you change the shipping address in the JSON:

• Pipe17 will automatically re-run order routing for any line items not yet sent to fulfillment.

• This may trigger new routing behavior based on the updated destination.

JSON File Types in Pipe17

Pipe17 JSON

This is the canonical format used internally by the app to represent all entities (orders, products, inventory, etc.). This JSON data follows the Pipe17 canonical schema - a standardized format that allows different systems to communicate with each other through the app.

Inbound Document

The inbound document (also referred to as sourcedoc) is the raw JSON received from an external system, such as Shopify, before any transformation occurs. This view lets you see exactly how the data appeared when it first entered the app.

Use this to:

• Verify the original structure and content of incoming data

• Troubleshoot sync or transformation errors

• Understand how external systems format data sent to Pipe17

Outbound Document

The outbound document is the JSON Pipe17 sends to a destination system, such as an ERP or 3PL. It is transformed from the canonical format into the structure expected by the receiving system.

Use this to:

• Confirm the final format of data sent from Pipe17

• Diagnose mapping or delivery issues to external systems

• Validate that transformations are being applied correctly

How JSON Documents Work Together

Data typically flows through Pipe17 in the following sequence:

1. Inbound Document
   Raw data from an external source (e.g., Shopify)

2. Canonical Mapping
   Pipe17 transforms the data into its standardized internal format

3. Pipe17 JSON
   This is the core data representation used by the app

4. Outbound Mapping
   Pipe17 converts the data into the format expected by the destination system

5. Outbound Document
   Transformed JSON sent to the endpoint (e.g., ERP or fulfillment partner)

Viewing these JSON documents helps you understand how data is being transformed as it moves through your integrations, which is particularly useful for troubleshooting or customizing your data flows.

Best Practices

• Use JSON View selectively: Leverage it for troubleshooting or development work. For day-to-day tasks, the standard UI is more efficient.

• Share JSON with support: When submitting a support request, include relevant JSON sections to speed up resolution.

• Refer to JSON when developing: Use it as a reliable reference for building or maintaining integrations with Pipe17.

Need Help?

If you need additional assistance:

• Use Ask Pippen, our AI agent, located at the top of the app page.

• Submit a support request with as much relevant detail as possible. Learn how to submit a request.

• For urgent issues, email us directly at support@pipe17.com.

We're here to help you succeed with your operations.