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

Summary

Resellers have the ability to consign from anywhere within the Fastway network. To become a reseller, 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 reseller options must be included:

1. A ConTypeId property is required to be set to 5
2. A validated from address object (or contactId) from within the Fastway network

Optional fields:

1. a fromInstructionsPublic can be added against the consignment

Note: All address validation rules apply when Validating the from address

{
  "conTypeId": 5,
  "from": {
    "ContactCode": "",
    "BusinessName": "",
    "ContactName": "",
    "PhoneNumber": "",
    "Email": "",
    "Address": {
      "AddressId": 0,
      "StreetAddress": "",
      "AdditionalDetails": "",
      "Locality": "",
      "StateOrProvince": "",
      "PostalCode": "",
      "Country": "",
      "Lat": 0,
      "Lng": 0,
      "Hash": ""
    }
  },
  "fromInstructionsPublic": "",
  ....
}

Known Contacts (sender or receiver) Request

As with a standard consignment, previously saved contacts can be used for both the sender and the receiver using the ContactId

{
  "conTypeId": 5,
  "from": {
    "ContactId": 0,
  },
  "to": {
    "ContactId": 0,
  },
  ....
}