UpdateTrackingRequest

The base request type of the updateTracking method, which can be used to provide updated shipment tracking information for a return item.

Call that uses UpdateTrackingRequest:

/post-order/v2/return/{returnId}/update_tracking PUT

Fields

newCarrierEnum ( string )

newCarrierName ( string )

newTrackingNumber ( string )

usedCarrierEnum ( string )

usedCarrierName ( string )

usedTrackingNumber ( string )

newCarrierEnum ( string ) [0..?]

This enumeration value represents a new shipping carrier that will replace the enumeration value specified in the usedCarrierEnumfield. To update the shipping carrier, either the usedCarrierEnum and newCarrierEnum fields can be used, or the usedCarrierName and newCarrierName fields.

See the Field Index to learn which calls use newCarrierEnum.

newCarrierName ( string ) [0..?]

This string value represents a new shipping carrier that will replace the string value specified in the usedCarrierNamefield. To update the shipping carrier, either the usedCarrierName and newCarrierName fields can be used, or the usedCarrierEnum and newCarrierEnum fields.

See the Field Index to learn which calls use newCarrierName.

newTrackingNumber ( string ) [0..?]

This string value represents a new tracking number that will replace the tracking number value specified in the usedTrackingNumber field. This field, along with the usedTrackingNumber field is required if the shipment tracking number is being updated.

See the Field Index to learn which calls use newTrackingNumber.

usedCarrierEnum ( string ) [0..?]

This enumeration value represents the current shipping carrier being used to ship the item. To update the shipping carrier, either the usedCarrierEnum and newCarrierEnum fields can be used, or the usedCarrierName and newCarrierName fields. This enumeration value must be accurate or the shipping carrier will not be updated to the new value specified in the newCarrierEnum field.

See the Field Index to learn which calls use usedCarrierEnum.

usedCarrierName ( string ) [0..?]

This string value represents the current shipping carrier being used to ship the item. To update the shipping carrier, either the usedCarrierName and newCarrierName fields can be used, or the usedCarrierEnum and newCarrierEnum fields. This value must be accurate or the shipping carrier will not be updated to the new value specified in the newCarrierName field.

See the Field Index to learn which calls use usedCarrierName.

usedTrackingNumber ( string ) [0..?]

This string value represents the current tracking number of the item. This field, along with the newTrackingNumber field is required if the shipment tracking number is being updated. This tracking number must be accurate or the shipment tracking number will not be updated to the new value specified in the newTrackingNumber field.

See the Field Index to learn which calls use usedTrackingNumber.