API ReferenceReturns

Get Return

Returns a single return by ID.

Requires scope: returns:read

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Return ID.

Response

This endpoint returns an object.
idUUID
Unique identifier for the return.
statusenum
Current lifecycle status of the return.
itemCountinteger
Number of line items in this return.
assignedUserIdslist of UUIDs
IDs of users assigned to this return.
returnNumberstring

Human-readable reference number for the return.

purchaseOrderobject

Reference to the originating purchase order (ID and order number as name).

locationobject
Reference to the location associated with this return.
trackingNumberstring
Shipping carrier tracking number for the return shipment.
notestring

Free-text notes about this return.

totalMaterialsCostdouble
Sum of all line item costs.
totalFeesdouble

Additional fees associated with the return (e.g. restocking fees).

finalPricedouble
Final total after materials cost and fees.
returnDatedate

ISO 8601 date the return was or will be shipped (e.g. 2026-03-25).

createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error