> For the complete documentation index, see [llms.txt](https://shiply-integration-apis.gitbook.io/shiply-integration-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://shiply-integration-apis.gitbook.io/shiply-integration-documentation/integration-apis.md).

# Integration APIs

Dive into the specifics of each APIs group by checking out our complete documentation.

## General Instructions

### Authentication

To authenticate your API requests, include your API key in the request body of each API call. Use the field name <mark style="color:blue;">Shiply\_API\_KEY</mark> to pass the key.

{% hint style="info" %}
To get your <mark style="color:blue;">Shiply\_API\_KEY,</mark> contact Shiply support team.
{% endhint %}

If you are a **premium customer** and want to allow your **sales employees** to integrate with the Shiply system using their existing Shiply accounts, follow these steps:

Required request parameters

* <mark style="color:blue;">Shiply\_API\_KEY</mark>: The API key of the **premium customer** (used for standard authentication)
* <mark style="color:$primary;">employee\_email</mark>:&#x20;
  * The email address of the **sales employee.**
  * Must match the email used for the employee’s account in the Shiply system.

Notes:

* The sales employee must have the permission to integrate with Shiply system, this permission should be enabled from the employee permissions list. Without this permission, the employee will not be allowed to integrate with the Shiply system.&#x20;
* The presence of <mark style="color:$primary;">employee\_email</mark> indicates that the request is being made on behalf of a **sales employee**, not the parent customer.
* Ensure the email is correctly matched with an existing Shiply account to allow successful authentication.

### API Host Server

Prefix all integration APIs routes with these:

{% tabs %}
{% tab title="Palestine" %}
For real environment: [https://shiplylogistics.com/api/v1 ](https://shiplylogistics.com/api/v1)

For testing environment: <https://stage.shiplylogistics.com/api/v1>
{% endtab %}

{% tab title="Jordan" %}
For real environment: [https://jordan.shiplylogistics.com/api/v1](https://shiplypalestine.com/api/v1)

For testing environment: <https://stagejordan.shiplylogistics.com/api/v1>
{% endtab %}
{% endtabs %}

## Integration APIs Groups

### Shipping Address

This section covers integration APIs related to the shipping address within the Shiply system which are: get cities and villages, calculate shipping cost .

{% content-ref url="/pages/qDRqPTkYScu9mkwQZXrf" %}
[Shipping Address](/shiply-integration-documentation/integration-apis/shipping-address.md)
{% endcontent-ref %}

### Parcels

This section covers integration APIs related to parcels within the Shiply system which are: create parcel, update parcel, get all parcels, get specific parcel, get returned parcels, submit parcel & assign QR code, cancel parcel, calculate parcel extra size fee.&#x20;

{% content-ref url="/pages/UcMkWRQoxqsnclNFLC4o" %}
[Parcels](/shiply-integration-documentation/integration-apis/parcels.md)
{% endcontent-ref %}

### Companion Parcels

This section covers integration APIs related to companion parcels within Shiply system which are: create companion parcel, update companion parcel, delete companion parcel.

{% content-ref url="/pages/mBAgj3JSxEAsmWVrTiz0" %}
[Companion Parcels](/shiply-integration-documentation/integration-apis/companion-parcels.md)
{% endcontent-ref %}

### Invoices

This section covers integration APIs related to invoices within Shiply system which are: get all invoices, get specific invoice details.

{% content-ref url="/pages/0ldzu37F9Nre4p5bU8Ma" %}
[Invoices](/shiply-integration-documentation/integration-apis/invoices.md)
{% endcontent-ref %}

### Premium Customers

This section covers integration APIs related to premium customers within the Shiply system which are: get all employees, create employee, update employee, remove employee.

{% content-ref url="/pages/E0MXco26N2YTTqcyIIpc" %}
[Premium Customers](/shiply-integration-documentation/integration-apis/premium-customers.md)
{% endcontent-ref %}

### Parcel Content

This section covers integration APIs related to parcel content within the Shiply system which are: create parcel content, update parcel content, delete parcel content.

{% content-ref url="/pages/9MfqqeVWv3ddYpyfnkza" %}
[Parcel Content](/shiply-integration-documentation/integration-apis/parcel-content.md)
{% endcontent-ref %}

### Recipients

This section covers integration API related to recipients information within the Shiply system which is: find recipients by phone number.

{% content-ref url="/pages/NbBzzznXr1gD3tILATKJ" %}
[Recipients](/shiply-integration-documentation/integration-apis/recipients.md)
{% endcontent-ref %}