Returns
The Return resource
carrier
String
Carrier name
completed_handling_at
ISO8601 datetime
When the return handling finished
created_at
ISO8601 datetime
When the return was created
id
Integer
Hive's unique identifier
order
Details of the associated order
photos
Photos of the returned items
received_at
ISO8601 datetime
When the return was received
return_items
List of items announced by the customer (via the Customer Portal). Can be empty if the return is not a Customer Portal return.
return_line_items
List of items that were actually handled in the FC. Can be empty if return items have not been handled in the FC yet.
return_reason
String
Possible values:
customer_return
not_picked_up
invalid_address
rejected_by_customer
customs_documents_missing
other
null or empty string
return_reason_type
String
Possible values: active - customer return (the end-customer actively shipped the return)
passive - carrier return (the end-customer never touched the parcel - it was shipped back by the carrier for reasons such as invalid address, the customer didn’t pick up their parcel from the shop or requested that it be sent back before receiving it, damages, customs documents missing, etc.)
null or empty string - this happens in the rare case that a return is created before it’s processed and it is not a Customer Portal return, all Customer Portal returns are "active"
started_processing_at
ISO8601 datetime
When processing at the fulfillment center started
status
String
Possible values: on_the_way - is on the way to a fulfillment center
arrived - arrived to a fulfillment center
processing - the return processing is in progress
action_required - waiting for merchant guidance
handling_completed - the return processing is in completed
tracking_code
String
Tracking number assigned by the carrier
tracking_url
String
Carrier website showing tracking information
The ReturnItem resource
customer_return_message
String
Reason details provided by the customer
customer_return_reason
String
Reason provided by the customer
id
Integer
Hive's unique identifier
quantity
Integer
Quantity of items announced
sku
SKU details of the item
The ReturnLineItem resource
condition
String
Possible values: A - Unused and in original packaging. B - Unused with missing/damaged packaging. C - Product is used or damaged.
follow_up_action
String
Action to be performed on the returned item. Possible values: restock, dispose and send_back Those actions are pre-selected based on return rules (Hive account manager inserts return rules into the system after negotiation with a merchant).
id
Integer
Hive's unique identifier
inventory_batch_id
Integer
Unique identifier in Hive system of the inventory batch (if present) into which returned item is going to be restocked (relevant only when "follow_up_action": "restock"
)
photos
Photos of the returned item
return_item_id
Integer
Announced return item's unique identifier in Hive system (can be blank, e.g. when the return is not a Customer Portal return)
sku
SKU details of the item
The ReturnSku resource
id
Integer
Hive's unique SKU identifier
merchant_sku_id
String
Merchant's unique SKU identifier
The ReturnOrder resource
id
Integer
Hive's unique order identifier
merchant_order_id
String
Merchant's unique order identifier
name
String
Customer's order identifier
The ReturnPhoto resource
id
Integer
Hive's unique identifier
image_url
String
Publicly accessible URL (for 15 minutes)
photo_type
String
Type of photo. Usual values: inside or outside
The ReturnLineItemPhoto resource
id
Integer
Hive's unique identifier
image_url
String
Publicly accessible URL (for 15 minutes)
List all returns
Lists all order returns
GET
https://app.hive.app/merchant_api/v1/returns
Returns paginated order returns ordered by descending creation time.
Query Parameters
created_at[lt]
ISO8601 datetime
Return results where the created_at
field is less than this value.
created_at[lte]
ISO8601 datetime
Return results where the created_at
field is less than or equal to this value.
created_at[gt]
ISO8601 datetime
Return results where the created_at
field is greater than this value.
created_at[gte]
ISO8601 datetime
Return results where the created_at
field is greater than or equal to this value.
Get one return
Get one specific order return
GET
https://app.hive.app/merchant_api/v1/returns/{id}
Returns specific order return belonging to the merchant and with matching Hive ID
Path Parameters
id*
Integer
The (Hive) ID of the return
Last updated