MarkAsShippedRequest

The base request type of the POST /post-order/v2/return/{returnId}/mark_as_shipped method, which can be used to mark a return item as shipped.

Call that uses MarkAsShippedRequest:

/post-order/v2/return/{returnId}/mark_as_shipped POST

Fields

carrierEnum ( string )

carrierName ( string )

carrierUsed ( string )

comments ( Text )

shippedDate ( DateTime )

trackingNumber ( string )

carrierEnum ( string ) [0..?]

This field is used to specify the shipping carrier used to ship the return item. ShippingCarrierEnum contains some popular shipping carriers for the US, UK, Germany, Canada, and Australia, but it is not a complete list.

This field must be used in conjunction with the trackingNumber field if using the POST /post-order/v2/return/{returnId}/mark_as_shipped method to provide tracking information.

See the Field Index to learn which calls use carrierEnum.

carrierName ( string ) [0..?]

This field is used to show the name of the shipping carrier. This field is only needed if the carrierEnum value is 'OTHER' or if it is missing.

See the Field Index to learn which calls use carrierName.

carrierUsed ( string ) [0..?]

This string value indicates the shipping carrier used to ship the item.

See the Field Index to learn which calls use carrierUsed.

comments ( Text ) [0..?]

This container is used to provide any related comments about marking the item as shipped.

See the Field Index to learn which calls use comments.

shippedDate ( DateTime ) [0..?]

This container is used to mark the date and time when the item was shipped, and is needed if the buyer is only marking the return item as 'shipped' without providing shipment tracking information.

See the Field Index to learn which calls use shippedDate.

trackingNumber ( string ) [0..?]

The shipment tracking number of the package. This field is required.

This field must be used in conjunction with the carrierEnum field if using the POST /post-order/v2/return/{returnId}/mark_as_shipped method to provide tracking information.

See the Field Index to learn which calls use trackingNumber.