Migrating from v3 to v3.1

---

Update BaseURL

• Base URL has been modified from https://packagehub-api.visiblescm.com/v3/ to https://packagehub-api.visiblescm.com/v3.1/

---

Impacted Objects

1. CustomsItem
2. Packages

---

CustomsItem

• packageNumber parameter has been added in body of CustomsItem object. For detailed description, click here.

• v3
• v3.1

{
    "weightUnit": "oz",
    "customsInfoId": "string",
    "description": "string",
    "quantity": 0,
    "weight": 0,
    "value": 0,
    "hsTariffNumber": "string",
    "originCountry": "string",
    "itemCode": "string",
    "createdDate": "2020-10-08T19:32:18.764Z"
}

---

Packages

• package object in v3 has been modified to packages array of object in v3.1. For detailed description, click here.

• v3
• v3.1

{
  "packageType": "Parcel",
  "isRectangle": true,
  "length": 0,
  "width": 0,
  "height": 0,
  "dimensionUnit": "cm",
  "weight": 0,
  "weightUnit": "oz"
}

---

Impacted Endpoints

1. ShipmentRate
2. Shipment
3. Manifest

---

ShipmentRate

• Request in v3
• Request in v3.1
• Response in v3
• Response in v3.1

{
  "fromAddress": {
    "id": "string"
  },
  "toAddress": {
    "name": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "street3": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "phone": "string",
    "email": "string",
    "save": true,
    "verify": true,
    "isResidential": true,
    "referenceType": "TaxCode",
    "referenceValue": "string",
  },
  "package": {
    "id": "string",
    "packageType": "Parcel",
    "isRectangle": true,
    "length": 0,
    "width": 0,
    "height": 0,
    "dimensionUnit": "cm",
    "weight": 0,
    "weightUnit": "oz"
  },
  "service": "ALL",
  "carrierAccountId": "string",
  "specialService": [
    "RestrictedDelivery"
  ],
  "customsInfo": {
    "customsItem": [
      {
        "weightUnit": "oz",
        "customsInfoId": "string",
        "description": "string",
        "quantity": 0,
        "weight": 0,
        "value": 0,
        "hsTariffNumber": "string",
        "originCountry": "string",
        "itemCode": "string"
      }
    ],
    "contentType": "DOCUMENTS",
    "contentsExplanation": "string",
    "customsCertify": true,
    "customsSigner": "string",
    "currency": "string",
    "nonDeliveryOption": "RETURN",
    "restrictionType": "Quarantine",
    "restrictionComments": "string",
    "eelpfc": "NOEEI3037a",
    "aesitn": "string"
  },
  "specialServiceParam": {
    "hazmatDescription": "string",
    "hazmatPhone": "string",
    "codAmount": 0,
    "registeredMailAmount": 0,
    "insuranceAmount": 0,
    "liveAnimalsType": "Bees"
  }
}

Shipment

• Request in v3
• Request in v3.1
• Response in v3
• Response in v3.1

{
  "fromAddress": {
    "id": "string"
  },
  "toAddress": {
    "name": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "street3": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "phone": "string",
    "email": "string",
    "save": true,
    "verify": true,
    "isResidential": true,
    "referenceType": "TaxCode",
    "referenceValue": "string"
  },
  "altReturnAddress": {
    "name": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "street3": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "phone": "string",
    "email": "string",
    "save": true,
    "verify": true,
    "isResidential": true,
    "referenceType": "TaxCode",
    "referenceValue": "string"
  },
  "package": {
    "packageType": "Parcel",
    "length": 0,
    "width": 0,
    "height": 0,
    "weight": 0
  },
  "postageLabel": {
    "labelType": "Base64",
    "labelFileType": "PDF",
    "customText1": "Custom Text 1",
    "customText2": "Custom Text 2"
  },
  "carrierAccountId": "string",
  "service": "PriorityMail",
  "customsInfo": {
    "customsItem": [
      {
        "weightUnit": "oz",
        "customsInfoId": "string",
        "description": "string",
        "quantity": 0,
        "weight": 0,
        "value": 0,
        "hsTariffNumber": "string",
        "originCountry": "string",
        "itemCode": "string"
      }
    ],
    "contentType": "Documents",
    "contentsExplanation": "string",
    "customsCertify": true,
    "customsSigner": "string",
    "currency": "string",
    "nonDeliveryOption": "Return",
    "restrictionType": "Quarantine",
    "restrictionComments": "string",
    "eelpfc": "NOEEI3037a",
    "aesitn": "string"
  }
}

Manifest

There is no change in request of Manifest request, however there are following changes in Manifest response:

• Response in v3
• Response in v3.1

{
  "id": "string",
  "appId": "string",
  "shipmentIds": [
   "string"
  ],
  "carrierAccountName": "USPS",
  "carrierCode": "USPS-eVS",
  "carrierAccountId": "string",
  "fromAddress": {
    "errors": [
      "string"
    ],
    "name": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "street3": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "phone": "string",
    "email": "string",
    "save": true,
    "verify": true,
    "source": "Manifest",
    "verificationStatus": "Success",
    "referenceType": "TaxCode",
    "referenceValue": "string",
    "isResidential": true,
    "id": "string",
    "createdDate": "2019-10-18T11:27:10.379Z"
  },
  "formNumber": "string",
  "formUrl": "string",
  "transactionDate": "2019-10-18T11:27:10.379Z",
  "shipDate": "2019-10-18T11:27:10.379Z",
  "message": "string",
  "messageCode": "MANIFEST_GENERATED"
}

---