Dicom

Overview

Dicom is the Canadian carrier that has both Shipping and Tracking capabilities. It trades within Domestic and international areas, and has various services which include Regional Parcel, Less than truckload (LTL), Full truckload, Logistics, Cross-border services, Dedicated logistics, and Residential. But we, PB- SendTech Solutions, deal with domestic services only.

Registering a Dicom Carrier Account

To create a Dicom carrier account, individuals must furnish the following essential information:

Carrier ID
Account Number and Type
User credentials (Username and Password)

The process of registering a Dicom carrier account involves initiating an API request, incorporating all the necessary details. Below, you will find an illustrative example of such a registration request.

Sample Dicom Onboarding Request

Copy

Copied

{
    "accountNumber": "xxxxxx",
    "carrierID": "DICOM",
    "description": "DICOM by API",
    "carrierAccountType": "Shipping",
    "provisioningType": "API",
    "parameters": {
        "username": "xxxx@xxxx.com",
        "password": "xxxxx",
        "ACCOUNT_TYPE": "VOL"
    }
}

If the request to establish a Dicom carrier account is successful, the ensuing response will resemble the provided Sample Response below.

Sample Dicom Registration Response

Copy

Copied

{
    "carrierAccountID": "xxxxxxxx",
    "description": "DICOM by API",
    "carrierID": "DICOM",
    "accountNumber": "xxxxxxx",
    "parameters": {
        "ACCOUNT_TYPE": "VOL",
        "username": "xxxxm@xxxx.com"
    },
    "carrierAccountType": "Shipping",
    "provisioningType": "API"
}

API Operations for Shipping with Dicom

The APIs integrate with Dicom through the following operations:

Operations	Method	Resource Path
Add a Carrier Account	POST	/api/v1/carrierAccounts
Rate a Parcel	POST	/api/v1/rates
Create a Shipping Label	POST	/api/v1/shipments
Reprint a Label	GET	/api/v1/shipments/{{shipmentId}}/reprint
Void a Label	PUT	/api/v1/shipments/{{shipmentId}}/cancel
Get Tracking Information	GET	/api/v1/tracking/{{trackingNumber}}

Metadata

Metadata provides information about Dicom carrier services, including origin and destination countries, supported carrier services, supported package types, and supported special services. Users can select specific origin and destination countries from the provided dropdown menu to dynamically view relevant metadata specific to those countries.

Metadata information not available