> 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/general-overview/introduction/integration.md).

# Integration

### Accounts

In Shiptify, data is inextricably linked to an account. Each account is either:

* <mark style="color:purple;">**Shipper**</mark> : this type of account owns orders, shipment requests, shipments (tracking) and invoicing.

**or**

* <mark style="color:purple;">**Carrier**</mark> : this type of account aznswers and manages the shipment requests. It can access data from dedicated shipments of its clients (shippers).

All shipments belong to one shipper account. They can be made visible to other accounts (either carrier or shipper). An account is usually the extent of a dedicated team of transport professionals.

### Users

A user from the platform is closely interelated to one or several accounts which have:

* the same domain (ex : deachelle.com)

**and**

* the same type of account: *shipper* or *carrier*

If you need to test both sides from the API, you will be requested to provide us with two different users.

{% hint style="info" %}
The API key we deliver is attached to a <mark style="color:purple;">**user**</mark>. So if you generate a shipment via the API, the owner of the shipment inside the platform will be your API user. That will be the same for any operations on the platform that is done thanks to the API.
{% endhint %}

A shipper gets to see all available pieces of information about his account.

A carrier has less visibility on a shipment. Some attributes of objects may not be available for the carrier (Costs of a shipment per instance).

### How to check your access?

To check your credentials to SHIPTIFY APIs, you can use the hello API endpoint of API Docs in order to access the environment you are looking for (See Environment section).

1. Select the top-right-green <mark style="color:green;">Authorize</mark> button. You should see this form:

![Connection form to public API](/files/yEd2NgJcf2qIZGJugzum)

1. Write your <mark style="color:purple;">API Key</mark> in the field **Value** (the prefix <mark style="color:purple;">**Api-Key**</mark> is part of key value. For instance : Api-Key v54eix0u3xz0keiao4k234j0ewy601ml);
2. Select <mark style="color:green;">Authorize</mark> button under the filled field;
3. Then use hello api endpoint, select the button **Try it out** and **Execute**

![Example of Structured API Answer](/files/MxLuCcWpIqPPzKS05Vlg)

**You should get server response :**&#x20;

> **Code 200 : “Hello from public Shiptify API!”**

### Dictionnaries

On Shiptify Platform, we label dictionaries which are the list of common attributes: <mark style="color:purple;">content type</mark>, <mark style="color:purple;">specificities</mark>, <mark style="color:purple;">metadatas</mark>… These dictionaries are the same for all accounts.

{% hint style="info" %}
Before asking to create a new item in a dictionary, please check first if it’s not yet available. If you don’t find what you are looking for, our team will be happy to create a new one for you as long as it serves the community needs. Please be in touch with your sales representative to do so.
{% endhint %}

For a simpler interface on the platform, you can choose to restrain to your favorite items from dictionaries. On the API side, all items are always available. So you can access items which are out of your pre selected list from the Platform.

### Tips and tricks

When you call a “get all…” request, the list of objects in the response are always listed from lower to higher ID.

<mark style="color:purple;">**Limit parameter**</mark> With limit parameter, you can define the number of object you will receive in the response. Ex : if you set limit = 30, and the last shipment request id is 220, you will receive only the last 30 ID of shiptment requests’ list, from ID 191 to 220 included

<mark style="color:purple;">**Offset parameter**</mark> Offset parameter introduce a lag from the last ID send in the response. Ex : if you set offset = 10 and the last shipment request id is 180, you will only receive the ID from 1 to 170

<mark style="color:purple;">**Date format**</mark> All date format are a string with <mark style="color:purple;">YYYY-MM-DDTHH:MM:SS</mark> value, in which T is a fixed separator (example: 2020-10-20T12:00:00). Dates must be set in <mark style="color:purple;">UTC Timezone</mark>.


---

# 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/general-overview/introduction/integration.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.