Getting Started

In order to get started with Gluey, you need to request credentials. Send an email to engineering@gluey.ai and we will help you. You will need two things:

• x-key - an api key to include in the header and which authenticate you in the APIs.
• account_number - your account ID which you need when you subscribe to our webhooks.

Feedback

We welcome any feedback on how we can improve both endpoints and documentation.

You can give us feedback in several ways:

• The first is to create a pull request / issue in our docs repo on  where we host this developer portal.
• The second option is to email engineering@gluey.ai with your feedback.

Environments

We use two primary environments to launch integrations:

Sandbox (Test):

https://api-sandbox.gluey.ai

Production:

https://api.gluey.ai

Endpoint Overview

Single Shipment Endpoints:

• POST/shipments
• GET/shipments/{id}
• DELETE/shipments/{id}
• GET/shipments/{id}/labels
• POST/shipments/{id}/documents
• POST/shipments/{id}/collection
• POST/shipments/{id}/collection/{collection_id}/time/{time_id}
• DELETE/shipments/{id}/collection/{collection_id}
• POST/shipment_with_labels_documents
• POST/shipments/{id}/manifests
• GET/shipments/{id}/manifests/{manifest_id}
• GET/shipments/{id}/track

Batch Endpoints:

• POST/manifests
• GET/manifests/{manifest_id}
• POST/tracking
• GET/pudo

Webhook Subscriptions:

• POST/accounts/{account_number}/webhooks/shipment/subscriptions
• DELETE/accounts/{account_number}/webhooks/shipment/subscriptions
• POST/accounts/{account_number}/webhooks/tracking/subscriptions
• DELETE/accounts/{account_number}/webhooks/tracking/subscriptions

Webhooks:

• EVENT/webhooks/shipment
• EVENT/webhooks/tracking