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

Summary

Returns consignments are used to return an existing package or satchel back to originating address. As a returning reference label must be supplied, you can only return a single item at a time

Optional Services can also be added to a Return using the same array of values.

Consigning - Additional properties

The minimum amount of information required to return a label is:

1. A ConTypeId property is required to be set to 4
2. A returningLabel property, containing the label number of the original consignment

Fields not required:

1. No address information is required, as the sender and receiver can be derived from the original consignment. Any from and to address blocks passed up will be ignored.

{
  "conTypeId": 4,
  "returningLabel": "AA0000000001"
}

Returning Packages - Changing the weight, dimensions and item reference

By supplying new weights, dimensions and item reference to the model, the original values can be overridden

{
  "conTypeId": 4,
  "returningLabel": "AA0000000001",
  "Items": [
    {
      "Reference": "",
      "WeightDead": 0,
      "WeightCubic": 0,
      "Length": 0,
      "Width": 0,
      "Height": 0
    }
  ],
  "InstructionsPublic": "",
  "InstructionsPrivate": ""
}

Returning Satchels - Changing the size and item reference

By supplying a new size and item reference to the model, the original values can be overridden

{
  "conTypeId": 4,
  "returningLabel": "AA0000000001",
  "Items": [
    {
      "Reference": "",
      "SatchelSize": "A4"
    }
  ],
  "InstructionsPublic": "",
  "InstructionsPrivate": ""
}