RMA frontend REST API
RMA Address REST API
Endpoint: /V1/lofmp-returns/address
Method: GET
Params:
Response Data:
{
"items": [
{
"name": "string",
"sort_order": 0,
"seller_id": 0,
"address": "string",
"is_active": true,
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/lofmp-returns/address/:addressId
Method: GET
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"seller_id": 0,
"address": "string",
"is_active": true,
"id": 0
}
RMA Condition REST API
Endpoint: /V1/lofmp-returns/condition
Method: GET
Params:
Response Data:
{
"items": [
{
"name": "string",
"sort_order": 0,
"is_active": true,
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/lofmp-returns/condition/:conditionId
Method: GET
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"is_active": true,
"id": 0
}
RMA Resolution REST API
Endpoint: /V1/lofmp-returns/resolution
Method: GET
Params:
Response Data:
{
"items": [
{
"name": "string",
"sort_order": 0,
"is_active": true,
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/lofmp-returns/resolution/:resolutionId
Method: GET
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"is_active": true,
"id": 0
}
RMA Status REST API
Endpoint: /V1/lofmp-returns/status
Method: GET
Params:
Response Data:
{
"items": [
{
"name": "string",
"sort_order": 0,
"is_show_shipping": true,
"customer_message": "string",
"admin_message": "string",
"history_message": "string",
"is_active": true,
"code": "string",
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/lofmp-returns/status/:statusId
Method: GET
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"is_show_shipping": true,
"customer_message": "string",
"admin_message": "string",
"history_message": "string",
"is_active": true,
"code": "string",
"id": 0
}
RMA Quick response REST API
Endpoint: /V1/lofmp-returns/quickresponse
Method: GET
Params:
Response Data:
{
"items": [
{
"name": "string",
"template": "string",
"is_active": true,
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/lofmp-returns/quickresponse/:quickresponseId
Method: GET
Params:
Response Data:
{
"name": "string",
"template": "string",
"is_active": true,
"id": 0
}
RMA Custom Fields REST API
Endpoint: /V1/lofmp-returns/customfield
Method: GET
Params:
Response Data:
{
"items": [
{
"name": "string",
"code": "string",
"type": "string",
"values": "string",
"description": "string",
"is_active": true,
"sort_order": 0,
"is_required_staff": true,
"is_visible_customer": true,
"is_editable_customer": true,
"visible_customer_status": "string",
"is_show_in_confirm_shipping": true,
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint:/V1/lofmp-returns/customfield/:fieldId
Method: GET
Params:
Response Data:
{
"name": "string",
"code": "string",
"type": "string",
"values": "string",
"description": "string",
"is_active": true,
"sort_order": 0,
"is_required_staff": true,
"is_visible_customer": true,
"is_editable_customer": true,
"visible_customer_status": "string",
"is_show_in_confirm_shipping": true,
"id": 0
}
RMA REST API
Endpoint: /V1/lofmp-returns/me/rma
Method: GET
Params:
Response Data:
{
"items": [
{
"rma_id": 0,
"increment_id": "string",
"customer_id": 0,
"order_id": 0,
"status_id": 0,
"store_id": 0,
"tracking_code": "string",
"is_resolved": true,
"created_at": "string",
"updated_at": "string",
"is_gift": true,
"is_admin_read": true,
"user_id": 0,
"last_reply_name": "string",
"return_address": "string",
"return_address_html": "string",
"code": "string",
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/lofmp-returns/me/rma/:rmaId
Method: GET
Params:
Response Data:
{
"rma_id": 0,
"increment_id": "string",
"customer_id": 0,
"order_id": 0,
"status_id": 0,
"store_id": 0,
"tracking_code": "string",
"is_resolved": true,
"created_at": "string",
"updated_at": "string",
"is_gift": true,
"is_admin_read": true,
"user_id": 0,
"last_reply_name": "string",
"return_address": "string",
"return_address_html": "string",
"code": "string",
"id": 0
}
Endpoint: /V1/lofmp-returns/me/rma
Method: POST
Params:
Response Data:
{
"rma_id": 0,
"increment_id": "string",
"customer_id": 0,
"order_id": 0,
"status_id": 0,
"store_id": 0,
"tracking_code": "string",
"is_resolved": true,
"created_at": "string",
"updated_at": "string",
"is_gift": true,
"is_admin_read": true,
"user_id": 0,
"last_reply_name": "string",
"return_address": "string",
"return_address_html": "string",
"code": "string",
"id": 0
}
Endpoint: /V1/lofmp-returns/me/bundlerma
Method: POST
Params:
Response Data:
{
"rma_id": 0,
"increment_id": "string",
"customer_id": 0,
"order_id": 0,
"status_id": 0,
"store_id": 0,
"tracking_code": "string",
"is_resolved": true,
"created_at": "string",
"updated_at": "string",
"is_gift": true,
"is_admin_read": true,
"user_id": 0,
"last_reply_name": "string",
"return_address": "string",
"return_address_html": "string",
"code": "string",
"id": 0
}
RMA Item REST API
Endpoint: /V1/lofmp-returns/me/item
Method: GET
Params:
Response Data:
{
"items": [
{
"item_id": 0,
"rma_id": 0,
"order_item_id": 0,
"product_id": 0,
"order_id": 0,
"reason_id": 0,
"resolution_id": 0,
"condition_id": 0,
"qty_requested": 0,
"qty_returned": 0,
"created_at": "string",
"updated_at": "string",
"name": "string",
"seller_commission": "string",
"admin_commission": "string",
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/lofmp-returns/me/item/:itemId
Method: GET
Params:
Response Data:
{
"item_id": 0,
"rma_id": 0,
"order_item_id": 0,
"product_id": 0,
"order_id": 0,
"reason_id": 0,
"resolution_id": 0,
"condition_id": 0,
"qty_requested": 0,
"qty_returned": 0,
"created_at": "string",
"updated_at": "string",
"name": "string",
"seller_commission": "string",
"admin_commission": "string",
"id": 0
}
Endpoint: /V1/lofmp-returns/me/itembyrma/:rmaId
Method: GET
Params:
Response Data:
{
"items": [
{
"item_id": 0,
"rma_id": 0,
"order_item_id": 0,
"product_id": 0,
"order_id": 0,
"reason_id": 0,
"resolution_id": 0,
"condition_id": 0,
"qty_requested": 0,
"qty_returned": 0,
"created_at": "string",
"updated_at": "string",
"name": "string",
"seller_commission": "string",
"admin_commission": "string",
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/lofmp-returns/me/item
Method: POST
Params:
Response Data:
{
"item_id": 0,
"rma_id": 0,
"order_item_id": 0,
"product_id": 0,
"order_id": 0,
"reason_id": 0,
"resolution_id": 0,
"condition_id": 0,
"qty_requested": 0,
"qty_returned": 0,
"created_at": "string",
"updated_at": "string",
"name": "string",
"seller_commission": "string",
"admin_commission": "string",
"id": 0
}
RMA Message REST API
Endpoint: /V1/lofmp-returns/me/message
Method: GET
Params:
Response Data:
{
"items": [
{
"rma_id": 0,
"user_id": 0,
"customer_id": 0,
"customer_name": "string",
"text": "string",
"is_html": true,
"internal": true,
"is_customer_notified": true,
"created_at": "string",
"updated_at": "string",
"email_id": 0,
"is_read": true,
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/lofmp-returns/me/message/:messageId
Method: GET
Params:
Response Data:
{
"rma_id": 0,
"user_id": 0,
"customer_id": 0,
"customer_name": "string",
"text": "string",
"is_html": true,
"internal": true,
"is_customer_notified": true,
"created_at": "string",
"updated_at": "string",
"email_id": 0,
"is_read": true,
"id": 0
}
Endpoint: /V1/lofmp-returns/me/messagebyrma/:rmaId
Method: GET
Params:
Response Data:
{
"items": [
{
"rma_id": 0,
"user_id": 0,
"customer_id": 0,
"customer_name": "string",
"text": "string",
"is_html": true,
"internal": true,
"is_customer_notified": true,
"created_at": "string",
"updated_at": "string",
"email_id": 0,
"is_read": true,
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/lofmp-returns/me/message
Method: POST
Params:
Response Data:
{
"rma_id": 0,
"user_id": 0,
"customer_id": 0,
"customer_name": "string",
"text": "string",
"is_html": true,
"internal": true,
"is_customer_notified": true,
"created_at": "string",
"updated_at": "string",
"email_id": 0,
"is_read": true,
"id": 0
}
RMA admin REST API
RMA REST API
Endpoint: /V1/admin/lofmp-returns/rma
Method: POST
Params:
Response Data:
{
"rma_id": 0,
"increment_id": "string",
"customer_id": 0,
"order_id": 0,
"status_id": 0,
"store_id": 0,
"tracking_code": "string",
"is_resolved": true,
"created_at": "string",
"updated_at": "string",
"is_gift": true,
"is_admin_read": true,
"user_id": 0,
"last_reply_name": "string",
"return_address": "string",
"return_address_html": "string",
"code": "string",
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/rma/:rmaId
Method: PUT
Params:
Response Data:
{
"rma_id": 0,
"increment_id": "string",
"customer_id": 0,
"order_id": 0,
"status_id": 0,
"store_id": 0,
"tracking_code": "string",
"is_resolved": true,
"created_at": "string",
"updated_at": "string",
"is_gift": true,
"is_admin_read": true,
"user_id": 0,
"last_reply_name": "string",
"return_address": "string",
"return_address_html": "string",
"code": "string",
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/rma/:rmaId
Method: DELETE
Params:
Response Data:
RMA Message REST API
Endpoint: /V1/admin/lofmp-returns/message
Method: POST
Params:
Response Data:
{
"rma_id": 0,
"user_id": 0,
"customer_id": 0,
"customer_name": "string",
"text": "string",
"is_html": true,
"internal": true,
"is_customer_notified": true,
"created_at": "string",
"updated_at": "string",
"email_id": 0,
"is_read": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/message/:messageId
Method: PUT
Params:
Response Data:
{
"rma_id": 0,
"user_id": 0,
"customer_id": 0,
"customer_name": "string",
"text": "string",
"is_html": true,
"internal": true,
"is_customer_notified": true,
"created_at": "string",
"updated_at": "string",
"email_id": 0,
"is_read": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/message/:messageId
Method: DELETE
Params:
Response Data:
RMA Address REST API
Endpoint: /V1/admin/lofmp-returns/address
Method: POST
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"seller_id": 0,
"address": "string",
"is_active": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/address/:addressId
Method: PUT
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"seller_id": 0,
"address": "string",
"is_active": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/address/:addressId
Method: Delete
Params:
Response Data:
RMA Condition REST API
Endpoint: /V1/admin/lofmp-returns/condition
Method: POST
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"is_active": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/condition/:conditionId
Method: PUT
Params:
/V1/admin/lofmp-returns/condition/:conditionId
Response Data:
{
"name": "string",
"sort_order": 0,
"is_active": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/condition/:conditionId
Method: DELETE
Params:
Response Data:
RMA Resolution REST API
Endpoint: /V1/admin/lofmp-returns/resolution
Method: POST
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"is_active": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/resolution/:resolutionId
Method: PUT
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"is_active": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/resolution/:resolutionId
Method: DELETE
Params:
Response Data:
RMA Reason REST API
Endpoint: /V1/admin/lofmp-returns/reason
Method: POST
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"is_active": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/reason/:reasonId
Method: PUT
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"is_active": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/reason/:reasonId
Method: DELETE
Params:
Response Data:
RMA Status REST API
Endpoint: /V1/admin/lofmp-returns/status
Method: POST
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"is_show_shipping": true,
"customer_message": "string",
"admin_message": "string",
"history_message": "string",
"is_active": true,
"code": "string",
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/status/:statusId
Method: PUT
Params:
Response Data:
{
"name": "string",
"sort_order": 0,
"is_show_shipping": true,
"customer_message": "string",
"admin_message": "string",
"history_message": "string",
"is_active": true,
"code": "string",
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/status/:statusId
Method: DELETE
Params:
Response Data:
RMA QuickResponse REST API
Endpoint: /V1/admin/lofmp-returns/quickresponse
Method: POST
Params:
Response Data:
{
"name": "string",
"template": "string",
"is_active": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/quickresponse/:quickresponseId
Method: PUT
Params:
Response Data:
{
"name": "string",
"template": "string",
"is_active": true,
"id": 0
}
Delete by Id QuickResponse
Endpoint: /V1/admin/lofmp-returns/quickresponse/:quickresponseId
Method: DELETE
Params:
Response Data:
RMA Field REST API
Endpoint: /V1/admin/lofmp-returns/customfield
Method: POST
Params:
Response Data:
{
"name": "string",
"code": "string",
"type": "string",
"values": "string",
"description": "string",
"is_active": true,
"sort_order": 0,
"is_required_staff": true,
"is_visible_customer": true,
"is_editable_customer": true,
"visible_customer_status": "string",
"is_show_in_confirm_shipping": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/customfield/:fieldId
Method: PUT
Params:
Response Data:
{
"name": "string",
"code": "string",
"type": "string",
"values": "string",
"description": "string",
"is_active": true,
"sort_order": 0,
"is_required_staff": true,
"is_visible_customer": true,
"is_editable_customer": true,
"visible_customer_status": "string",
"is_show_in_confirm_shipping": true,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/customfield/:fieldId
Method: DELETE
Params:
Response Data:
RMA Work Flow Rule REST API
Endpoint: /V1/admin/lofmp-returns/rule
Method: POST
Params:
Response Data:
{
"items": [
{
"name": "string",
"event": "string",
"email_body": "string",
"email_subject": "string",
"is_active": true,
"conditions_serialized": "string",
"is_send_owner": true,
"is_send_department": true,
"is_send_user": true,
"other_email": true,
"sort_order": 0,
"is_stop_processing": 0,
"status_id": 0,
"user_id": 0,
"is_send_attachment": 0,
"is_resolved": 0,
"id": 0
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 0,
"current_page": 0
},
"total_count": 0
}
Endpoint: /V1/admin/lofmp-returns/rule/:ruleId
Method: POST
Params:
Response Data:
{
"name": "string",
"event": "string",
"email_body": "string",
"email_subject": "string",
"is_active": true,
"conditions_serialized": "string",
"is_send_owner": true,
"is_send_department": true,
"is_send_user": true,
"other_email": true,
"sort_order": 0,
"is_stop_processing": 0,
"status_id": 0,
"user_id": 0,
"is_send_attachment": 0,
"is_resolved": 0,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/rule
Method: POST
Params:
Response Data:
{
"name": "string",
"event": "string",
"email_body": "string",
"email_subject": "string",
"is_active": true,
"conditions_serialized": "string",
"is_send_owner": true,
"is_send_department": true,
"is_send_user": true,
"other_email": true,
"sort_order": 0,
"is_stop_processing": 0,
"status_id": 0,
"user_id": 0,
"is_send_attachment": 0,
"is_resolved": 0,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/rule/:ruleId
Method: PUT
Params:
Response Data:
{
"name": "string",
"event": "string",
"email_body": "string",
"email_subject": "string",
"is_active": true,
"conditions_serialized": "string",
"is_send_owner": true,
"is_send_department": true,
"is_send_user": true,
"other_email": true,
"sort_order": 0,
"is_stop_processing": 0,
"status_id": 0,
"user_id": 0,
"is_send_attachment": 0,
"is_resolved": 0,
"id": 0
}
Endpoint: /V1/admin/lofmp-returns/rule/:ruleId
Method: DELETE
Params:
Response Data: