> For the complete documentation index, see [llms.txt](https://docs.shiptify.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shiptify.com/carrier-api-galaxy/carrier-galaxy/general-considerations.md).

# General considerations

### API Key

Before using our REST API services, you must obtain:

* An <mark style="color:blue;">**API key**</mark> from your SHIPTIFY sales representative.&#x20;
* <mark style="color:purple;">**Galaxy Manager**</mark> access for the user associated with the API.

The API key is tied to a specific <mark style="color:purple;">**user**</mark>. 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.

{% hint style="info" %}
The API key is persistent and does not expire. You can test your API key using the “Hello” endpoint in the [Postman collection](/carrier-api-galaxy/carrier-galaxy/general-considerations/postman-project.md).
{% endhint %}

### 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 [Postman file](/carrier-api-galaxy/carrier-galaxy/general-considerations/postman-project.md) with all the endpoints and information outlined here, which can be imported directly into your Postman project.

### Objects

<figure><img src="/files/FkGqxPZv0iAeirI80QrV" alt=""><figcaption></figcaption></figure>

#### #SR ID: Shipment Request

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

#### #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.&#x20;

#### #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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.shiptify.com/carrier-api-galaxy/carrier-galaxy/general-considerations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.