returnlogic_list_rmas
List returns (RMAs)
List return merchandise authorizations (RMAs, i.e. customer returns) with workflow status, return type (refund, exchange, warranty, giftcard), items, customer email and order. Filter by status, type, reason, email, order, date range, flags or 'requires action'. GET /v1/rmas.
Parametersskipemaillimitorder_namereturn_typeonly_flaggedcreated_aftershow_archivedcreated_beforerequires_actionworkflow_statusthird_party_only+4 more
returnlogic_count_rmas
Count returns (RMAs)
Count RMAs matching the same filters as returnlogic_list_rmas (for example how many returns are Requested or require action). GET /v1/rmas/count.
Parametersemailorder_namereturn_typeonly_flaggedcreated_aftershow_archivedcreated_beforerequires_actionworkflow_statusthird_party_onlyreturn_reason_codeonly_unpaid_invoices+2 more
returnlogic_get_rma
Get return (RMA)
One RMA by id: status, comments, order link, shopper and warehouse addresses, items with quantities, reasons, approval/receipt state, labels and timeline. GET /v1/rmas/{rlRmaId}.
Parametersrma_idrequired
returnlogic_get_rma_item_type_history
Get return type history of an RMA item
The history of return-type changes (e.g. refund changed to exchange) of one RMA item. GET /v1/rmas/{rlRmaItemId}/returntypehistory.
Parametersrma_item_idrequired
returnlogic_get_rma_metafields
Get RMA metafields
Custom metafields (key, value, reportable) stored on an RMA. GET /v1/rmas/{rlRmaId}/metafields.
Parametersrma_idrequired
returnlogic_get_rma_item_metafields
Get RMA item metafields
Custom metafields stored on one item of an RMA. GET /v1/rmas/{rlRmaId}/items/{rlRmaItemId}/metafields.
Parametersrma_idrequiredrma_item_idrequired
returnlogic_list_orders
List orders
List orders known to ReturnLogic (synced from the store) with items, customer, amounts and statuses. Filter by order number/name, email, date range or financial status. GET /v1/orders.
Parametersskipemaillimitorder_nameorder_numbercreated_aftercreated_beforefinancial_status
returnlogic_count_orders
Count orders
Count orders matching the same filters as returnlogic_list_orders. GET /v1/orders/count.
Parametersemailorder_nameorder_numbercreated_aftercreated_beforefinancial_status
returnlogic_get_order
Get order
One order by ReturnLogic order id (rlOrderId) with its line items, addresses and statuses. GET /v1/orders/{rlOrderId}.
Parametersorder_idrequired
returnlogic_list_customers
List customers
List customers, or find one by email or external customer id. GET /v1/customers/list.
Parametersskipemaillimitexternal_customer_id
returnlogic_get_customer
Get customer
One customer by ReturnLogic customer id (rlCustomerId). GET /v1/customers/{rlCustomerId}.
Parameterscustomer_idrequired
returnlogic_list_products
List products
List products with their variants (SKUs, barcodes). Filter by SKU, category id, status or external (store) product ids. GET /v1/products.
Parametersskuskiplimitstatuscategory_idexternal_product_ids
returnlogic_count_products
Count products
Count products matching a SKU, category or status filter. GET /v1/products/count.
Parametersskustatuscategory_id
returnlogic_get_product
Get product
One product by ReturnLogic product id (rlProductId) with its variants. GET /v1/products/{rlProductId}.
Parametersproduct_idrequired
returnlogic_list_product_categories
List product categories
List product categories (used for return rules). Search by name or external category ids. GET /v1/productCategories.
Parametersnameskiplimitexternal_category_ids
returnlogic_flag_rma
Flag an RMA
WRITE: flag an RMA so the team can filter for it, with an optional comment. A flag cannot be removed afterwards. It sends nothing to the customer. POST /v1/rmas/{rlRmaId}/flag.
Parametersrma_idrequiredcomment
returnlogic_mark_rma_items_received
Mark RMA items received
WRITE: record the warehouse receipt of one or more RMA items (received true/false, optional disposition code that must already exist in ReturnLogic). When every item is received the RMA becomes Received, and if the store uses Automated Processing for Received, the RMA may then be processed automatically (refund, exchange or gift card issued, and the customer notified by ReturnLogic). Use only on the operator's instruction. PUT /v1/rmas/{rlRmaId}/fulfillment.
Parametersitemsrequiredrma_idrequired
returnlogic_add_rma_metafields
Add RMA metafields
WRITE: add custom metafields (key/value notes or reference numbers) to an RMA. A key can be used once per RMA. 'reportable' true makes the field visible on RMAs and reports; false keeps it API-only. Nothing is sent to the customer. POST /v1/rmas/{rlRmaId}/metafields.
Parametersrma_idrequiredmetafieldsrequired
