First steps

In this section we will guide you through your first request.

Environments

In Shippify, we provide two environments, one for production and the other for testing. These consist of 2 different accounts, both pointing to the same endpoint but with different credentials. To create your accounts, please review this website.

Authentication

Access to deliveries via API is based on HTTP basic authentication. To call our API, you must use your credentials found in the company settings.

Credenciales

You'll obtain an APP ID and an APP SECRET from the dashboard to construct your token using basic auth. In tools like Postman, you can directly input your credentials, and it's not necessary to construct the token.

Autenticación en postman

However, for code integration, you'll need to construct the basic token to add it to the headers of the requests under the key Authorization. This is done by encoding the credentials (separated by :) to base64.

const apiId="XXXXXXXX";
const apiToken="XXXXXXXXXX";
const token = `Basic ${btoa(`${apiId}:${apiToken}`)}`;

Header con basic token

The domain to call the endpoints is:

https://api.shippify.co

First request

To test our API, you only need the authentication credentials. For our first request, we will consume an endpoint for countries. In this space, you can test the request with your credentials.

Países.

Obtiene la lista de países donde opera shippify.

GEThttps://api.shippify.co/v1/country

Authorization

Basic_Auth

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Success"

payloadarray of Country (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/country', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200401

{
  "code": "OK",
  "message": "Success",
  "payload": [
    {
      "id": 1,
      "name": "BRASIL",
      "countryCode": "BR",
      "isSaasVisible": 1,
      "defaultCityId": 1,
      "defaultCityName": "Belo Horizonte",
      "created_at": "2022-10-14T15:01:23.000Z"
    }
  ]
}

Response API status codes

Each interaction with the Shippify API returns an HTTP status code indicating whether the request was successful, failed, or requires particular actions for further steps.

Status code	Description
200 OK	The request was successfully processed by Shippify.
400 Bad Request	The Shippify server could not decode the request body, typically due to malformed syntax or incorrect headers.
401 Unauthorized	The caller was not authorized to make the request because authentication credentials were missing or incorrect. Please consult the Authentication link for proper authentication methods.
404 Not Found	The requested resource could not be found. Please refer to the Shippify API to find the correct endpoint names.
412 Precondition Failed	Payload with incorrect format.
429 Too Many Requests	The request exceeded the rate limit.
500 Internal Server Error	An internal server error occurred at Shippify. If the issue persists, please contact Support.
503 Service Unavailable	The Shippify server is temporarily unavailable. If the issue persists, please contact Support.
504 Gateway Timeout	The Shippify server acting as a gateway or proxy timed out while trying to fulfill the request. Please try again later or, if the issue persists, contact Support.

Restrictions

For most of our endpoints, we have certain limits configured when making a request, and it's important to keep in mind when integrating:

• You cannot make more than 100 requests per minute to the API.

• You cannot create or edit more than 100 orders in one request.

Postman collection

We provide our public API in a Postman collection with examples added for each request so you can test it. In this collection, there are two environments. Once you clone the collection, you can enter your credentials to use it.

Shippify Public APIPostman