1 Summary
- 1.1 Get all subscriptions
- 1.2 Get by subscription ID
- 1.3 Get all booking details by subscription ID
- 1.4 Get by booking Number

Summary

Once you have created a Subscription you can use a variety of GET options to check and confirm the subscription details.

These GET options work for subscriptions create via V1 and/or V2.

Get all subscriptions

Returns a summary of all subscriptions and their details.

GET https://api.portconnect.io/v2/subscriptions

Example Response

[
     {
        "subscriptionId": 82,
        "bookingsCount": 1,
        "containers": [],
        "eventTypeCodes": [],
        "category": "EXPORT",
        "facilityCode": "NZWII",
        "webhookURI": "https://e261c292d202dea2a1102f30b298394b.m.pipedream.net",
        "webhookToken": "123-456-789-000",
        "emailAddressList": null,
        "portCode": "NZAKL"
    },
    {
        "subscriptionId": 84,
        "bookingsCount": 1,
        "containers": [
            {
                "expirationDatetime": "2024-12-17T17:05:37.703+13:00",
                "subscriptionContainerId": 832,
                "containerNumber": "TSSU5011511",
                "userDefinedReference": "LFT IddO code"
            }
        ],
        "eventTypeCodes": [
            "ACTIVE",
            "AVAILABLE",
            "CLEARED",
            "CUSTOMSRELEASE",
            "DISCHARGE",
            "GATEIN",
            "GATEOUT",
            "LFT24HOURS",
            "LFTCHANGED",
            "LFTEXCEEDED",
            "LOAD",
            "LOPRELEASE",
            "MPIRELEASE",
            "PINAVAILABLE",
            "PINSUSPENDED",
            "PRIORITYGATEIN",
            "VBSCHANGED"
        ],
        "category": "IMPORT",
        "facilityCode": "",
        "webhookURI": "https://eohggl3prd5zey5.m.pipedream.net",
        "webhookToken": "123-456-789-000",
        "emailAddressList": [
            "info@portconnect.co.nz"
        ],
        "portCode": "NZTRG"
    },
]

Get by subscription ID

Returns subscription details and a list of all Containers against a subscription. Returns a Count of all Bookings against a subscription.

GET https://api.portconnect.io/v2/subscriptions/{SubscriptionID}

Example Response

Get all booking details by subscription ID

Returns a list of all Bookings.

Example Response

Get by booking Number

Returns the specific details of a Booking against a Subscription.

Example Response

PortConnect Help

GET Options

Analytics

Summary

Get all subscriptions

Get by subscription ID

Get all booking details by subscription ID

Get by booking Number

Related content