Products꞉ Assigned Labels - Fastway-Couriers-South-Africa/myFastway.ApiClient GitHub Wiki

Summary

High Volume customers can be assigned a label range to draw from. Once a label range is assigned, a consignment item must be provided with an unused label from this range to consign. This allows customers to POST consignments after the label has been printed. To enable Assigned Labels, please contact your Account Manager to determine if this product is right for you

Consigning - Additional Properties

In addition to the standard requirements when creating a Consignment, the following Assigned Label options must be included:

1. An unused label number from the label Range provided

Consigning a Parcel

{
  "To": {
    "ContactName": "",
    "PhoneNumber": "",
    "Email": "",
    "Address": {
      "StreetAddress": "",
      "Locality": "",
      "StateOrProvince": "",
      "PostalCode": "",
      "Country": ""
    }
  },
  "Items": [
    {
      "Quantity": 1,
      "Label": "MP0000000001",
      "Reference": "",
      "PackageType": "P",
      "WeightDead": 0,
      "WeightCubic": 0,
      "Length": 0,
      "Width": 0,
      "Height": 0
    }
  ]
}

Consigning Restrictions

When consigning with an assigned label, items can no longer be consolidated (e.g. 4 x Parcels of 1 kg) as a label needs to be provided for each item. Each item must have the quantity set to 1.

Errors will be returned for:

1. Consigning without a label assigned.
2. A label assigned outside the allocated range.
3. A label assigned which has been previously used.