ShipHero for Sidekick

This Documentation is for a Sidekick Integration

This documentation is for an integration used by Gladly automation and AI/Sidekick products. Apps like this will soon also be able to display data and provide actions that interact with external systems and products within Agent-facing Customer Profiles. However, if you are looking for this capability now, you may be more interested in our list of integrations for Gladly Hero.

Who maintains the integration

The Shiphero for Sidekick integration is built and maintained by Gladly.

Benefits

Quick Resolutions

Customers can access information instantly without contacting an Agent, improving satisfaction.

Optimized Agent Productivity

Agents can focus on high-value tasks that require their expertise rather than handling routine inquiries.

24/7 Availability

Customers can get answers anytime, even outside business hours, enhancing convenience and accessibility.

Available Actions

- Lookup Order by Order Number
- Detailed Order Data
  Orders returned from ShipHero can contain:
  id
  order number
  partner order id
  total tax (currency)
  total discounts (currency)
  subtotal
  total price
  order date
  updated at datetime
  email
  account id
  shipping lines:
  carrier
  method
  price
  title
  shipping address
  billing address
  tags
  line items:
  id
  quantity
  product name
  sku
  fulfillment status
  product details: id, name, tags
  holds: address, client, fraud, operator, payment, or shipping method holds
  currency
  hold-until date
  tax id
  tax type
Lookup Orders by Email Address
- Returns a list of orders, including the detailed order data above
Track Shipments by Order ID
- Returns a list of shipments
- Detailed Shipment Data
  Shipments returned from ShipHero can contain:
  id
  order id
  user id
  warehouse id
  pending shipment id
  picked up status
  needs refund status
  refunded status
  delivered status
  address
  created date
  line items:
  id
  shipment id
  shipping label id
  line item id
  quantity
  shipping labels:
  id
  account id
  box id
  carrier
  carrier account id
  created date
  delivered status
  full size to print
  insurance amount
  needs refund status
  order account id
  order id
  order number
  packing slip
  partner fulfillment id
  picked up status
  refunded status
  shipment id
  shipping method
  shipping name
  source
  status
  tracking number
  tracking url
  warehouse
  warehouse id

Technical Documentation Available!
Technical Documentation, as well as an extensible version of this App are available on GitHub.

Example Use Cases

Answer WISMO (Where Is My Order) questions, such as:
- "What happened to my order?" (e.g., details about an attempted delivery yesterday)
- "Did I send it to the right address?" (e.g., verifying the shipping address).
Estimate delivery times
- Look up a Customer’s order, find the corresponding shipment, and check the shipping status and date information from the associated shipping label to estimate a delivery date based on historical data.

Setup & Installation

Before You Start

You will need to obtain a GraphQL API Access & Refresh Token as described here.
For “Developer Details” put:
Name: Gladly
Last Name: Inc
Email: [email protected]
Click “Add Developer”
Make a note of the “Access Token” and “Refresh Token”
Contact Gladly Support, and request that the Shiphero for Sidekick App be installed in your Gladly instance. You will need to provide the Access Token you generated, using a secure password sharing service like One Time Secret.