Documentation
Carrier API (Galaxy)
Carrier API (Galaxy)
  • Carrier [Galaxy]
    • General considerations
      • Resources [api]
        • Metadata [Dictionary]
        • Shipment Modes [Dictionary]
        • Tracking points [Sample]
        • Documents Types [Sample]
        • Content Types [Sample]
        • My accounts
        • *My Active Shippers
      • Postman Project
      • Full Swagger
    • Shipments [webhook]
      • Setting up webhooks
      • Securing webhooks
      • Retry Mechanism
      • Carrier Payloads
    • Trackings [api]
      • By SH ID
        • TPs by SH ID
        • Create TP by SH ID
        • Replan Pickup by SH ID
        • Confirm Pickup by SH ID
        • Replan Delivery by SH ID
        • Confirm Delivery by SH ID
      • By TP ID
        • Update TP location by TP ID
        • Cancel TP by TP ID
        • Replan TP by TP ID
        • Confirm TP by TP ID
    • Metadata [api]
      • Shipment_request scope
        • Get MD by SR ID
        • Create MD by SR ID
        • Update MD by SR ID
      • Shipment scope
        • Get MD by SH ID
        • Create MD by SH ID
        • Update MD by SH ID
    • Documents [api]
      • Shipment scope
        • *Get Attachments by SH_ID
        • Upload Attachment by SH_ID
      • Shipment Request scope
        • *Get Attachments by SR_ID
      • Get Attachment by Attachment ID
Powered by GitBook
On this page
  • API Key
  • Environnements
  • Postman Project
  • Objects
  1. Carrier [Galaxy]

General considerations

Last updated 7 months ago

API Key

Before using our REST API services, you must obtain:

  • An API key from your SHIPTIFY sales representative.

  • Galaxy Manager access for the user associated with the API.

The API key is tied to a specific user. Therefore, when you generate a shipment via the API, it will be attributed to that user within the platform. This applies to all operations performed through the API.

The API key is persistent and does not expire. You can test your API key using the “Hello” endpoint in the .

Environnements

Shiptify provides two separate environments for setup:

  • Test Environment [BLU]: https://api.blu.shiptify.com

  • Production Environment: https://api.shiptify.com

Postman Project

This documentation includes a with all the endpoints and information outlined here, which can be imported directly into your Postman project.

Objects

#SR ID: Shipment Request

A shipper creates 1 Shipment Request, also known as booking, which is identified by an #SR ID.

#SH ID: Shipment

When 1 Shipment Request (#SR ID) is confirmed by a carrier, it generates at least 1 shipment, identified by its #SH ID.

However, if the Shipment Request (#SR ID) is not confirmed, no shipment (#SH ID) is created.

For multi-container or multi-shipment requests, a single Shipment Request (#SR ID) can generate more than one shipment, resulting in multiple _#SH ID_s.

#TP ID: Tracking Point

A shipment (#SH ID) generates at least two Tracking Points (#TP ID): 1 for pickup and 1 for delivery. There can also be additional tracking points depending on the process.

#Attachment ID

A Shipment Request and/or a Shipment can have zero or multiple documents attached to it. Each document is identified with its Attachment ID.

Postman collection
Postman file