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
api.json
api.yaml
Overview
License © 2024 project44 - Terms of Use
Languages
Servers
Mock server
https://developers.project44.com/_mock/guides/shippers/visibility/ocean/api/
NA - Endpoint for project44 tenants created in the NA region
https://na12.api.project44.com/
EU - Endpoint for project44 tenants created in the EU region
https://eu12.api.project44.com/
Sandbox - Endpoint for project44 tenants created in the sandbox environment
https://na12.api.sandbox.p-44.com/

Manage Client Applications

Operations

Generate Tokens

Operations

Unified Shipment Tracking

Operations

Deprecated Ocean Tracking

Operations

Webhook

Operations

Retrieve all push configurations.

Request

Retrieve all push configurations for a tenant and user.

curl -i -X GET \
  https://developers.project44.com/_mock/guides/shippers/visibility/ocean/api/api/v4/webhooks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
webhookEndpointsArray of objects(WebhookEndpoint)

A list of webhook endpoints.

Response
{
  "webhookEndpoints": [
    { … }
  ]
}

Create or update a push configuration.

Request

Create or update a single push configuration. A maximum of 50 push configurations may be saved per tenant.

Body
required

webhookEndpoint

authParamsobject

(Deprecated) The webhookAuthenticationMethod parameters. The subordinate fields for the 'authParams' field depend on the authType. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

authTypestring

(Deprecated) The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

Enum"API_KEY""BASIC""OAUTH2""MTLS""AD_OAUTH2_CERT"
authenticationMethodsArray of objects(WebhookAuthenticationMethod)

A list of authentication methods. Each authentication method consists of 'type' and 'parameters' fields. Typically only one form of authentication is used, though it is possible to have two API keys or both an API key and OAuth2 authentication.

configNamestring

A unique name used to identify the push configuration.

idinteger(int64)

A unique identifier of the push configuration. Assigned by the push configuration API service and used for updates only.

methodstring

The HTTP method associated with the webhook endpoint. If not provided, will default to POST.

Enum"GET""POST""PUT""PATCH"
methodHeadersobject

A map of optional headers to pass to the webhook.

methodParamsobject

A map of optional method parameters. If provided, these will appear as query parameters on the URL.

payloadFormatstring

The format of the payload to send to the webhook. JSON is the only format supported.

Value"JSON"
urlstring

The URL of the webhook endpoint.

versioninteger(int64)

An optional version of the push configuration.

curl -i -X PUT \
  https://developers.project44.com/_mock/guides/shippers/visibility/ocean/api/api/v4/webhooks \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "authParams": {},
    "authType": "API_KEY",
    "authenticationMethods": [
      {
        "parameters": {},
        "type": "API_KEY"
      }
    ],
    "configName": "string",
    "id": 0,
    "method": "GET",
    "methodHeaders": {
      "property1": "string",
      "property2": "string"
    },
    "methodParams": {},
    "payloadFormat": "JSON",
    "url": "string",
    "version": 0
  }'

Responses

OK

Body
authParamsobject

(Deprecated) The webhookAuthenticationMethod parameters. The subordinate fields for the 'authParams' field depend on the authType. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

authTypestring

(Deprecated) The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

Enum"API_KEY""BASIC""OAUTH2""MTLS""AD_OAUTH2_CERT"
authenticationMethodsArray of objects(WebhookAuthenticationMethod)

A list of authentication methods. Each authentication method consists of 'type' and 'parameters' fields. Typically only one form of authentication is used, though it is possible to have two API keys or both an API key and OAuth2 authentication.

configNamestring

A unique name used to identify the push configuration.

idinteger(int64)

A unique identifier of the push configuration. Assigned by the push configuration API service and used for updates only.

methodstring

The HTTP method associated with the webhook endpoint. If not provided, will default to POST.

Enum"GET""POST""PUT""PATCH"
methodHeadersobject

A map of optional headers to pass to the webhook.

methodParamsobject

A map of optional method parameters. If provided, these will appear as query parameters on the URL.

payloadFormatstring

The format of the payload to send to the webhook. JSON is the only format supported.

Value"JSON"
urlstring

The URL of the webhook endpoint.

versioninteger(int64)

An optional version of the push configuration.

Response
{
  "authParams": {},
  "authType": "API_KEY",
  "authenticationMethods": [
    { … }
  ],
  "configName": "string",
  "id": 0,
  "method": "GET",
  "methodHeaders": {
    "property1": "string",
    "property2": "string"
  },
  "methodParams": {},
  "payloadFormat": "JSON",
  "url": "string",
  "version": 0
}

Retrieve a push configuration by id.

Request

Retrieve a push configuration by id.

Path
webhookIdinteger(int64)required

webhookId

curl -i -X GET \
  'https://developers.project44.com/_mock/guides/shippers/visibility/ocean/api/api/v4/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
authParamsobject

(Deprecated) The webhookAuthenticationMethod parameters. The subordinate fields for the 'authParams' field depend on the authType. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

authTypestring

(Deprecated) The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

Enum"API_KEY""BASIC""OAUTH2""MTLS""AD_OAUTH2_CERT"
authenticationMethodsArray of objects(WebhookAuthenticationMethod)

A list of authentication methods. Each authentication method consists of 'type' and 'parameters' fields. Typically only one form of authentication is used, though it is possible to have two API keys or both an API key and OAuth2 authentication.

configNamestring

A unique name used to identify the push configuration.

idinteger(int64)

A unique identifier of the push configuration. Assigned by the push configuration API service and used for updates only.

methodstring

The HTTP method associated with the webhook endpoint. If not provided, will default to POST.

Enum"GET""POST""PUT""PATCH"
methodHeadersobject

A map of optional headers to pass to the webhook.

methodParamsobject

A map of optional method parameters. If provided, these will appear as query parameters on the URL.

payloadFormatstring

The format of the payload to send to the webhook. JSON is the only format supported.

Value"JSON"
urlstring

The URL of the webhook endpoint.

versioninteger(int64)

An optional version of the push configuration.

Response
{
  "authParams": {},
  "authType": "API_KEY",
  "authenticationMethods": [
    { … }
  ],
  "configName": "string",
  "id": 0,
  "method": "GET",
  "methodHeaders": {
    "property1": "string",
    "property2": "string"
  },
  "methodParams": {},
  "payloadFormat": "JSON",
  "url": "string",
  "version": 0
}

Delete a push configuration.

Request

Delete a push configuration.

Path
webhookIdinteger(int64)required

webhookId

curl -i -X DELETE \
  'https://developers.project44.com/_mock/guides/shippers/visibility/ocean/api/api/v4/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
Response
{
  "httpStatusCode": 0,
  "httpMessage": "string",
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "supportReferenceId": "string"
}

Retrieve a push configuration by name.

Request

Retrieve a push configuration by name.

Path
webhookNamestringrequired

webhookName

curl -i -X GET \
  'https://developers.project44.com/_mock/guides/shippers/visibility/ocean/api/api/v4/webhooks/name/{webhookName}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
authParamsobject

(Deprecated) The webhookAuthenticationMethod parameters. The subordinate fields for the 'authParams' field depend on the authType. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

authTypestring

(Deprecated) The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

Enum"API_KEY""BASIC""OAUTH2""MTLS""AD_OAUTH2_CERT"
authenticationMethodsArray of objects(WebhookAuthenticationMethod)

A list of authentication methods. Each authentication method consists of 'type' and 'parameters' fields. Typically only one form of authentication is used, though it is possible to have two API keys or both an API key and OAuth2 authentication.

configNamestring

A unique name used to identify the push configuration.

idinteger(int64)

A unique identifier of the push configuration. Assigned by the push configuration API service and used for updates only.

methodstring

The HTTP method associated with the webhook endpoint. If not provided, will default to POST.

Enum"GET""POST""PUT""PATCH"
methodHeadersobject

A map of optional headers to pass to the webhook.

methodParamsobject

A map of optional method parameters. If provided, these will appear as query parameters on the URL.

payloadFormatstring

The format of the payload to send to the webhook. JSON is the only format supported.

Value"JSON"
urlstring

The URL of the webhook endpoint.

versioninteger(int64)

An optional version of the push configuration.

Response
{
  "authParams": {},
  "authType": "API_KEY",
  "authenticationMethods": [
    { … }
  ],
  "configName": "string",
  "id": 0,
  "method": "GET",
  "methodHeaders": {
    "property1": "string",
    "property2": "string"
  },
  "methodParams": {},
  "payloadFormat": "JSON",
  "url": "string",
  "version": 0
}