About the API

• The custom order tracking API endpoint allows you to provide Zipchat's AI agent with access to your order database so it can help customers with their order status and tracking information.
• Whenever a customer asks about order tracking, Zipchat will collect their order info and email.
• Once the agent has the right information, it will call the custom endpoint provided by you, expect to receive context, and generate a reply based on the context that you provided.

Prerequisites

In order to connect the custom endpoint to your chat, we'll need the following things from you:

• Endpoint URL
• API key
• Order number format (used so Zipchat knows what to look for, e.g., "#1001", "5555", etc.) - this should be a number that the customer has access to so they can provide it

This guide is for developers implementing the response handling for the Order Lookup Service. Your system will receive GET requests and should respond according to the specifications below.

Implementation

Incoming Request

You will receive GET requests with the following characteristics:

• Endpoint: [Your endpoint URL]
• Authentication: [ Your API Key ] in x-api-key header
• Query Parameters:
  • order_id: string (required)
  • customer_email: string (required)