Returns

Get Return

Changed on

DEPRECATED – please use Retrieve List of Returns instead with filter for RMA.

get/v1/integrations/returns

Request

  • Base URL: https://api.shipmonk.com
  • URL: https://api.shipmonk.com/v1/integrations/returns
  • Auth: API key in header Api-Key

Query parameters

rmastring required

Return Merchandise Authorization (RMA) number used to look up the return; optional query filter.

Response

Success

idinteger required

Unique numeric identifier of the return.

warehousestring required

Code of the warehouse handling this return.

order_keystring nullable required

External order key of the original order this return relates to; null when no linked order exists.

store_idinteger nullable required

Identifier of the store the return belongs to; null if the return is not linked to a store.

rmastring required

Return Merchandise Authorization (RMA) number identifying this return.

tracking_numberstring nullable required

Primary carrier tracking number of the return shipment; null if not yet known. Set to the most recently added of tracking_numbers.

tracking_numbersstring[] required

All carrier tracking numbers associated with the return shipment; empty when none are known.

status'status_created' | 'in_progress' | 'en_route' | 'returned' | 'arrived' | 'not_arrived' | 'grading_completed' required
return_reason'reason_exchange' | 'reason_changed_mind' | 'reason_undeliverable' | 'reason_unknown' | 'reason_incorrect_product' required
notestring nullable required

Optional free-text note attached to the return; null when no note was provided.

created_atstring date-time required

ISO 8601 timestamp when the return record was created.

updated_atstring date-time required

ISO 8601 timestamp when the return record was last updated.

received_atstring date-time nullable required

ISO 8601 timestamp when the return was physically received at the warehouse; null until received.

source'shipmonk' | 'loop' | 'returnly' | 'deposco' | 'happy_returns_loop' | 'happy_returns' required

Changes

  • 2306185e9d40Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 79e6b5bc43a0Revision changes
    • breaking

      the response property //// became nullable for the status

    • warning

      added the new return_unit enum value to the //// response property for the response status

    • info

      removed the optoro_inventory enum value from the //// response property for the response status

    • info

      added the required property //// to the response with the status