How to Connect to Profill PromoStandards API

Profill PromoStandards Integration Guide: Return Authorization (RMA)

This guide walks you through integrating with Profill’s Return Authorization (RMA) REST API, including how to submit return orders and retrieve return status updates.

API Endpoints

Test Environment:

Return Order Submission: https://profillds.profillholdings.com:8443/profill-rest-api-dev/rma/returnOrder

Return Status Check: https://profillds.profillholdings.com:8443/profill-rest-api-dev/rma/rmaStatusLines

Production Environment:

Return Order Submission: https://profillds.profillholdings.com:8443/profill-rest-api-production/rma/returnOrder

Return Status Check: https://profillds.profillholdings.com:8443/profill-rest-api-production/rma/rmaStatusLines

1. Submit a Return Order

HTTP Method: POST

Headers:
Accept: application/json
Content-Type: application/json
token: <your-token>

URL Parameter: c=<customer_number>

Request Body Schema:

{
"po_num": "string (required)",
"contact_name": "string (required)",
"address1": "string (required)",
"address2": "string (optional)",
"city": "string (required)",
"state": "string (required)",
"zip": "string (required)",
"country": "string (optional)",
"shipping_method": "string (required)",
"items": [
   {
     "profill_sku": "string (required)",
     "quantity_ordered": "int (required)",
     "price": "double (required)",
     "eta": "YYYY-MM-DD (required)",
     "shipDate": "YYYY-MM-DD (required)",
     "type": "int (required)",
     "line_number": "int (required)",
     "lineNote": "string (required)"
   }
],
"notes": "string (optional)"
}

Sample Request:

{
"po_num": "RMA000030",
"contact_name": "Acme Corporation",
"address1": "8645 Se 28th Ave",
"address2": "",
"city": "Milwaukie",
"state": "OR",
"zip": "97222",
"country": "United States",
"shipping_method": "UPS",
"items": [
   {
     "profill_sku": "EPET-TESTING IN",
     "quantity_ordered": 5,
     "price": 50.00,
     "eta": "2023-04-30",
     "shipDate": "2023-04-23",
     "type": 1,
     "line_number": 1,
     "lineNote": ""
   }
],
"notes": "TEST"
}

Sample Response:

{
"received": true,
"error": null,
"warehouseOrderId": null
}

2. Check Return Status

HTTP Method: POST

Headers:
Accept: application/json
Content-Type: application/json
token: <your-token>

URL Parameter: c=<customer_number>

Request Body Schema:

{
"from": "YYYY-MM-DD",
"to": "YYYY-MM-DD"
}

Notes

- Ensure your token is valid and refreshed as needed.

- All date fields must be in YYYY-MM-DD format.

- Contact Profill support to obtain your API token and production endpoint access.