Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

project44 REST API (4.0.0)

Version 4.0.0 of project44's API

Download OpenAPI description
Languages
Servers
Mock server
https://developers.project44.com/_mock/guides/shippers/visibility/parcel/api/
API endpoint for project44 tenants created in NA region
https://na12.api.project44.com/
API endpoint for project44 tenants created in EU region
https://eu12.api.project44.com/
API endpoint for project44 tenants created in the Sandbox environment
https://na12.api.sandbox.p-44.com/

Manage Client Applications

Operations

Get client applications.

Request

List all client applications registered in your project44 account.

curl -i -X GET \
  -u <username>:<password> \
  https://developers.project44.com/_mock/guides/shippers/visibility/parcel/api/api/v4/oauth2/client-applications

Responses

OK

Body*/*
clientApplicationsArray of objects(ClientApplication)

The list of client applications registered in your project44 account.

Register client application.

Request

Register a new client application, in order to receive a client id and secret that can be used to authenticate with project44's OAuth 2.0 token generation endpoint. Generate tokens to access other project44 APIs. Note you must record the client secret returned here securely as it cannot be retrieved again. You can, however, generate a new client secret via the "new-secret" endpoint in case you forget it or need to rotate it.

Required Fields

  • name
Bodyapplication/jsonrequired

clientApplication

namestring

Your name for the client application. Every application is required to have a name.

curl -i -X POST \
  -u <username>:<password> \
  https://developers.project44.com/_mock/guides/shippers/visibility/parcel/api/api/v4/oauth2/client-applications \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

Created

Body*/*
idstringread-only

The id of the client application, generated and assigned by project44. It is an alphanumeric id. In OAuth 2.0, this is referred to as the "client_id". This id is not considered a secret, but it is generally known only to you, your application, and project44, and is part of your application's credentials, along with the client secret, which are required to authenticate your application to generate access tokens for use with project44's other APIs. If provided via HTTP Basic Authentication when generating an access token, this id is the "username" part of the base64-encoded Authorization header value.

namestring

Your name for the client application. Every application is required to have a name.

secretstringread-only

The secret part of the client application's credentials, generated and assigned by project44. In OAuth 2.0, this is referred to as the "client_secret". It cannot be retrieved again after the first time project44 returns it to you, but a new secret can be set for an application via the "new-secret" endpoint. It is confidential and should be stored encrypted at rest in a secure location for your application's use only. It is needed to authenticate your application to generate access tokens for use with project44's other APIs. If provided via HTTP Basic Authentication when generating an access token, this secret is the "password" part of the base64-encoded Authorization header value.

Get client application.

Request

Get a specific client application by client id.

Required Fields

  • id
Path
idstringrequired

The id of the client application, generated and assigned by project44 via the OAuth 2.0 client applications APIs.

curl -i -X GET \
  -u <username>:<password> \
  'https://developers.project44.com/_mock/guides/shippers/visibility/parcel/api/api/v4/oauth2/client-applications/{id}'

Responses

OK

Body*/*
idstringread-only

The id of the client application, generated and assigned by project44. It is an alphanumeric id. In OAuth 2.0, this is referred to as the "client_id". This id is not considered a secret, but it is generally known only to you, your application, and project44, and is part of your application's credentials, along with the client secret, which are required to authenticate your application to generate access tokens for use with project44's other APIs. If provided via HTTP Basic Authentication when generating an access token, this id is the "username" part of the base64-encoded Authorization header value.

namestring

Your name for the client application. Every application is required to have a name.

secretstringread-only

The secret part of the client application's credentials, generated and assigned by project44. In OAuth 2.0, this is referred to as the "client_secret". It cannot be retrieved again after the first time project44 returns it to you, but a new secret can be set for an application via the "new-secret" endpoint. It is confidential and should be stored encrypted at rest in a secure location for your application's use only. It is needed to authenticate your application to generate access tokens for use with project44's other APIs. If provided via HTTP Basic Authentication when generating an access token, this secret is the "password" part of the base64-encoded Authorization header value.

Update client application.

Request

Update the name of an existing client application by id. The secret cannot be updated by the client. To generate a new secret, use the "new-secret" endpoint.

Required Fields

  • id
  • name
Path
idstringrequired

The id of the client application, generated and assigned by project44 via the OAuth 2.0 client applications APIs.

Bodyapplication/jsonrequired

clientApplication

namestring

Your name for the client application. Every application is required to have a name.

curl -i -X PUT \
  -u <username>:<password> \
  'https://developers.project44.com/_mock/guides/shippers/visibility/parcel/api/api/v4/oauth2/client-applications/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

OK

Body*/*
idstringread-only

The id of the client application, generated and assigned by project44. It is an alphanumeric id. In OAuth 2.0, this is referred to as the "client_id". This id is not considered a secret, but it is generally known only to you, your application, and project44, and is part of your application's credentials, along with the client secret, which are required to authenticate your application to generate access tokens for use with project44's other APIs. If provided via HTTP Basic Authentication when generating an access token, this id is the "username" part of the base64-encoded Authorization header value.

namestring

Your name for the client application. Every application is required to have a name.

secretstringread-only

The secret part of the client application's credentials, generated and assigned by project44. In OAuth 2.0, this is referred to as the "client_secret". It cannot be retrieved again after the first time project44 returns it to you, but a new secret can be set for an application via the "new-secret" endpoint. It is confidential and should be stored encrypted at rest in a secure location for your application's use only. It is needed to authenticate your application to generate access tokens for use with project44's other APIs. If provided via HTTP Basic Authentication when generating an access token, this secret is the "password" part of the base64-encoded Authorization header value.

Delete client application.

Request

Delete an existing client application by id. Deleting an application invalidates its client credentials (id and secret) and deletes its associated project44 app user (with username "app-{client_id}@client-applications.project44.com").

Required Fields

  • id
Path
idstringrequired

The id of the client application, generated and assigned by project44 via the OAuth 2.0 client applications APIs.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://developers.project44.com/_mock/guides/shippers/visibility/parcel/api/api/v4/oauth2/client-applications/{id}'

Responses

No Content

Body

Generate a new client secret.

Request

In case you have forgotten your application's client secret, or you wish to rotate it, generate a new one. Doing so invalidates the former client secret for the application, but does not invalidate any active access tokens you may have outstanding. Note you must record the client secret returned here securely as it cannot be retrieved again.

Required Fields

  • id
Path
idstringrequired

The id of the client application, generated and assigned by project44 via the OAuth 2.0 client applications APIs.

curl -i -X POST \
  -u <username>:<password> \
  'https://developers.project44.com/_mock/guides/shippers/visibility/parcel/api/api/v4/oauth2/client-applications/{id}/new-secret'

Responses

Created

Body*/*
idstringread-only

The id of the client application, generated and assigned by project44. It is an alphanumeric id. In OAuth 2.0, this is referred to as the "client_id". This id is not considered a secret, but it is generally known only to you, your application, and project44, and is part of your application's credentials, along with the client secret, which are required to authenticate your application to generate access tokens for use with project44's other APIs. If provided via HTTP Basic Authentication when generating an access token, this id is the "username" part of the base64-encoded Authorization header value.

namestring

Your name for the client application. Every application is required to have a name.

secretstringread-only

The secret part of the client application's credentials, generated and assigned by project44. In OAuth 2.0, this is referred to as the "client_secret". It cannot be retrieved again after the first time project44 returns it to you, but a new secret can be set for an application via the "new-secret" endpoint. It is confidential and should be stored encrypted at rest in a secure location for your application's use only. It is needed to authenticate your application to generate access tokens for use with project44's other APIs. If provided via HTTP Basic Authentication when generating an access token, this secret is the "password" part of the base64-encoded Authorization header value.

Generate Tokens

Operations

Unified Shipment Tracking

Operations

Deprecated Parcel Tracking

Operations

Shipment Attributes

Operations

Webhook

Operations

Deprecated Parcel Webhook

Operations