Parcels

Events

Action Event name
purchasing a parcel parcel.created
cancelling a parcel parcel.updated
purchasing a parcel (receive scan) parcel.scan.created
scanning a parcel parcel.scan.created
changing parcel status parcel.scan.created

Payload example

{
  "attemptId":"34060f33-614b-43d9-9cdd-8a2ba23fae1e",
  "created":1623784960,
  "data": {
    "pricesIncludeTaxes":false,
    "displayTotalTaxes":2266000,
    "displayTotal":14856000,
    "displayUnits":{
        "dimensions":"in",
        "weight":"kg"
    },
    "totalForTransaction":12590000,
    "agencyName":"",
    "shiftId":"60z82622e81e574c31125b76",
    "total":14856000,
    "scans":[
        
    ],
    "changeable":true,
    "createdAt":{
        "offset":0,
        "value":"2021-06-15T19:22:20.691Z"
    },
    "manualFees":[
        
    ],
    "promos":[
        
    ],
    "parcelZoneId":null,
    "lastName":"Last",
    "userId":"55zz2f318791db6e1a0000b0",
    "lastScan":null,
    "trxId":"60z8zzzz09660c0621590eb9",
    "adjustmentType":null,
    "totalTaxes":2266000,
    "fees":[
        {
          "calculated":289000,
          "displayCalculated":0,
          "displayPriceWithTaxes":null,
          "displaySubTotal":0,
          "displayValue":245000,
          "internalId":"parcel trx fee",
          "isRefundable":true,
          "lexiconKeys":{
              "name":"fee-name-52a377ec430c7d4e220001zz-1517e18e-77d4-4946-a87e-911169d545bb"
          },
          "name":"parcel spl fee",
          "priceWithTaxes":null,
          "products":{
              "59ca8fb0169785a044acdf37":1,
              "607898c4f69a0339906aa7c7":1,
              "parcel_test":1,
              "parcel_zone":1
          },
          "rules":{
              "parcel":1
          },
          "subTotal":245000,
          "taxable":true,
          "taxes":[
              {
                "calculated":32000,
                "displayCalculated":0,
                "name":"hst",
                "province":"all",
                "value":13000
              },
              {
                "calculated":12000,
                "displayCalculated":0,
                "name":"ontax",
                "province":"Ontario",
                "value":5000
              }
          ],
          "value":245000,
          "valueType":"$"
        }
    ],
    "measure":{
        "height":{
          "unit":"mm",
          "value":51
        },
        "length":{
          "unit":"mm",
          "value":51
        },
        "width":{
          "unit":"mm",
          "value":51
        }
    },
    "_purchaseGroupId":"60c8fdec09660c0621590eba",
    "shiftLocation":{
        "name":"B (testB)",
        "stationId":"52a378c8430c7d4e2200020e"
    },
    "parcelNumber":1,
    "displayPrice":12345000,
    "createdByUserEmail":"LastFirst+break@example.com",
    "cancellable":true,
    "displayTotalForTransaction":12590000,
    "displayCurrency":{
        "buy":1,
        "isocode":"CAD",
        "sell":1,
        "symbol":"$"
    },
    "price":12345000,
    "agencyId":"",
    "channel":"callcenter",
    "weight":{
        "unit":"gr",
        "value":2000
    },
    "transactionId":"7HRB8PBM",
    "taxablePercentage":100000,
    "productDef":{
        "hasFares":true,
        "isFlexPass":false,
        "terms":"",
        "taxProductFrom":"any",
        "useStationGroups":false,
        "hasRoutes":true,
        "ord":110,
        "type":"parcel_zone",
        "useAutocomplete":false,
        "icon":"fa-gift",
        "readOnly":false,
        "pricingType":"zonepricing",
        "openReturn":null,
        "products":[
          {
              "channels":{
                "backoffice":true,
                "websales":true
              },
              "expire":0,
              "name":"One way",
              "priceAdjustment":{
                "times":1,
                "type":"",
                "value":0
              },
              "qty":{
                "max":50,
                "min":1
              },
              "returnDateDefault":false,
              "type":"oneway",
              "uses":1
          }
        ],
        "isBundle":false,
        "_id":"607898c4f69a0339906aa7c7",
        "todayDefaultForOutbound":null,
        "hasDates":true,
        "isPass":false,
        "hasPassengerInfo":false,
        "availableChannels":{
          "inPerson":true,
          "online":true
        },
        "isParcel":true,
        "comments":true,
        "name":"Parcel zone",
        "cutoffs":{
          "inPerson":{
              "minutes":0,
              "point":"start"
          },
          "online":{
              "minutes":0,
              "point":"start"
          }
        },
        "notifications":{
          "receiver":{
              "delivered":true,
              "transit":true
          },
          "sender":{
              "delivered":true,
              "transit":true
          }
        },
        "dow":null,
        "earlySeatSelection":false,
        "serviceTypes":true,
        "shipTrackIntegration":true,
        "description":"",
        "requiredInsurance":false,
        "daysInAdvance":null,
        "lexiconKeys":{
          "description":"product-description-52a377ec430c7d4e220001zz-20a33605-e307-4a08-88cc-bdc18bb968a9",
          "name":"product-name-52a377ec430c7d4e220001zz-833df233-2f9a-4ca2-a739-f1df915424f3",
          "terms":"product-terms-52a377ec430c7d4e220001zz-e94412c6-53ff-4942-89c4-8df885f51d3e"
        },
        "flexPassOptions":null,
        "accountId":"52a377ec430c7d4e220001zz",
        "hasQty":false,
        "openReturnBundleId":null,
        "family":"parcel",
        "shipTrackIntegrationParams":{
          "companyId":"7a9f7fd6-e9c4-48f6-8bc9-b4cbecfe892e"
        },
        "dontShowStations": true
    },
    "crossBorderTaxation":false,
    "_id":"60c8fdec09660c0621590ebb",
    "taxExempted":false,
    "customerNumber":"511-037-301",
    "serviceType":{
        "_id":"605ba169ea6a729a8ab19c34",
        "accountId":"52a377ec430c7d4e220001zz",
        "createdAt":{
          "offset":0,
          "value":"2021-03-24T20:28:14.181Z"
        },
        "createdBy":"55zz2f318791db6e1a0000b0",
        "enabled":true,
        "lexiconKeys":{
          "name":"52a377ec430c7d4e220001zz-name-8eee4cb4-d6e4-47b7-bf9e-05f3a85bff91-8d3eaea2-a90d-4a58-8ea2-9043c5e29891"
        },
        "shipTrackId":"S03",
        "updatedAt":{
          "offset":0,
          "value":"2021-06-10T14:46:24.076Z"
        },
        "updatedBy":"55zz2f318791db6e1a0000b0"
    },
    "extra":{
        "from":{
          "address":"1 High str",
          "city":"Toronto",
          "companyId":"",
          "companyName":"",
          "country":{
              "ISO":"CA",
              "_id":"4faad0c1d4f11a3a4600005e",
              "name":"Canada"
          },
          "email":"",
          "firstName":"LastFirst",
          "lastName":"Last",
          "phone":"",
          "phoneNumber":"555-555-5555",
          "province":"Ontario",
          "selectedCountryId":"4faad0c1d4f11a3a4600005e",
          "shipTrackNotifications":{
            "delivered":false,
            "inTransit":false
          },
          "zipCode":"Postal1"
        },
        "phone":"555-555-5555",
        "to":{
          "address":"1 High str",
          "city":"Toronto",
          "companyId":"",
          "companyName":"",
          "country":{
              "ISO":"CA",
              "_id":"4faad0c1d4f11a3a4600005e",
              "name":"Canada"
          },
          "email":"",
          "firstName":"LastFirst",
          "lastName":"Last",
          "phone":"",
          "phoneNumber":"555-555-5555",
          "province":"Ontario",
          "selectedCountryId":"4faad0c1d4f11a3a4600005e",
          "shipTrackNotifications":{
            "delivered":false,
            "inTransit":false
          },
          "zipCode":"Postal1"
        }
    },
    "createdBy":"55zz2f318791db6e1a0000b0",
    "status":"paid",
    "comments":"",
    "displayId":"PA-60c8-fdec-0966-0c06-2159-0ebb",
    "qrCodeString":"52a377ec430c7d4e220001zz-PA-60c8fdec09660c0621590ebb",
    "shipTrackId":"",
    "displayTaxableDiscounts":0,
    "deleted":false,
    "updatedAt":{
        "offset":0,
        "value":"2021-06-15T19:22:25.889Z"
    },
    "paymentRates":[
        {
          "displayTotal":14856000,
          "itemDisplayId":"PA-60c8-fdec-0966-0c06-2159-0ebb",
          "itemId":"60c8fdec09660c0621590ebb",
          "rates":[
              {
                "ratio":"100.00",
                "type":"cash"
              }
          ],
          "total":14856000
        }
    ],
    "details":{
        "fare":"Package 11-20",
        "fareId":"57d2fbb71d9bebd240000062"
    },
    "serviceTypeName":"Door to Door",
    "serviceTypeId":"605ba169ea6a729a8ab19c34",
    "ratios":[
        {
          "displayTotal":14856000,
          "total":14856000,
          "type":"cash"
        }
    ],
    "productId":"607898c4f69a0339906aa7c7",
    "firstName":"LastFirst",
    "agentId":"",
    "email":"LastFirst+break@example.com",
    "shiftNumber":"S-KGU6DX3",
    "taxes":[
        {
          "calculated":1637000,
          "displayCalculated":0,
          "name":"hst",
          "province":"all",
          "value":13000
        },
        {
          "calculated":629000,
          "displayCalculated":0,
          "name":"ontax",
          "province":"Ontario",
          "value":5000
        }
    ],
    "from":{
        "isBorder":false,
        "disabled":false,
        "createdAt":{
          "offset":0,
          "value":"2017-09-27T17:16:33.619Z"
        },
        "userId":"55zz2f318791db6e1a0000b0",
        "country":"",
        "primaryCurrencyCode":null,
        "ord":0,
        "type":{
          "code":"",
          "name":""
        },
        "address":"",
        "airlines":[
          
        ],
        "canReceive":true,
        "_id":"59cbdcf16d32dd794fcc3ac6",
        "displayedCurrencies":null,
        "canSend":true,
        "province":"Ontario",
        "name":"Madison st",
        "deleted":false,
        "alternativeNames":[
          
        ],
        "connex":{
          "waitingTimes":{
              "max":0,
              "min":0,
              "override":false
          }
        },
        "updatedAt":{
          "offset":0,
          "value":"2021-06-10T14:47:26.354Z"
        },
        "longitude":"-67.4391704",
        "details":"",
        "city":"",
        "timeZone":"America/Toronto",
        "shipTrackClientId":"sp-st-id",
        "zone":"1",
        "latitude":"48.4673685",
        "acceptedCurrencies":null,
        "timeZoneDiff":"0",
        "stationsGroupedWithThisStation":[
          
        ],
        "excludeFromConnex":false,
        "accountId":"52a377ec430c7d4e220001zz",
        "zip":"Z0Z0Z0",
        "stationsInGroupAreBoarding":false,
        "terminals":[
          
        ]
    },
    "accountId":"52a377ec430c7d4e220001zz",
    "displayDiscounts":0,
    "discounts":0,
    "taxableDiscounts":0,
    "productFamily":"parcel",
    "ssrs":[
        
    ],
    "to":{
        "isBorder":false,
        "disabled":false,
        "createdAt":{
          "offset":0,
          "value":"2017-09-27T17:16:04.092Z"
        },
        "userId":"55zz2f318791db6e1a0000b0",
        "country":"CA",
        "primaryCurrencyCode":null,
        "ord":0,
        "type":{
          "code":"",
          "name":""
        },
        "address":"123 West str",
        "airlines":[
          
        ],
        "canReceive":true,
        "_id":"59cbdcd46d32dd794fcc3ac5",
        "displayedCurrencies":null,
        "canSend":true,
        "province":"Ontario",
        "name":"victoria",
        "deleted":false,
        "alternativeNames":[
          
        ],
        "connex":{
          "waitingTimes":{
              "max":0,
              "min":0,
              "override":false
          }
        },
        "updatedAt":{
          "offset":0,
          "value":"2021-06-07T20:34:55.019Z"
        },
        "longitude":"-73.197898",
        "details":"",
        "city":"Toronto",
        "timeZone":"America/Toronto",
        "shipTrackClientId":"vicotriaspid",
        "zone":"1",
        "latitude":"46.0884381",
        "acceptedCurrencies":null,
        "timeZoneDiff":"0",
        "stationsGroupedWithThisStation":[],
        "excludeFromConnex":false,
        "accountId":"52a377ec430c7d4e220001zz",
        "zip":"M9B0A1",
        "stationsInGroupAreBoarding":false,
        "terminals":[]
    },
    "displayTaxablePrice":0,
    "productType":"parcel_zone",
    "nonTaxablePrice":0,
    "taxablePrice":12345000,
    "displayNonTaxablePrice":0
    },
  "event":"parcel.created",
  "id":"02f465c6-bdfc-4ceb-b2ad-7a84bd3d559f",
  "livemode":false
}