Warehouse Events for Returns

Use the Return Processed API to trigger different return flows based on the acceptance or rejection of the registered return.

Overview

parcelLab provides an API you can use to trigger different flows in your returns experience based on a review of a return after it is received at your warehouse.

You can use the Return Processed API to send a custom event to parcelLab to update a return registered in your Returns Portal based on the outcome of returns that were processed in your warehouse. This event can be used to trigger subsequent events (for example: paying out a refund, sending emails to the customer).

You can use the Return Processing app as an alternative to send the same information via devices in your warehouses or retail locations. For full details on configuring and using the Return Processing app, refer to the product documentation.

Return Processed API

You can submit a custom event to update a registered return using the hook-rma-processed endpoint.

Trackings can be identified using one of the following ways, as shown in the sample requests:

• Courier and tracking number

• xid reference

• RMA identifier and order number

The tracking identifier combination you use determines which fields are required in the request body.

Process RMA updates

post

Handles updates for RMA processed items and creates tracking updates

Header parameters

userstringRequired

Your parcelLab account ID

Example: 1619884

tokenstringRequired

Your parcelLab authentication token

Example: <API-Token>

Content-Typestring · enumRequired

Must be application/json

Possible values:

Body

application/json

xidstringOptional

External identifier for the return

Example: 66d8980c0c49874aecd20b68

orderNumberstringOptional

Original order number

Example: ORDER-0001

rmaIdstringOptional

RMA identifier

Example: RMA-1001

courierstringOptional

Courier handling the return

Example: ups

trackingNumberstringOptional

Tracking number for the return shipment

Example: 1Z0001730802157555

treatUnspecifiedAsRejectedbooleanOptional

When true, articles with unspecified rejected quantities are treated as fully rejected. Defaults to false if not provided.

Example: false

Responses

202

RMA update accepted and being processed

application/json

400

Invalid request payload

application/json

401

Unauthorized request

application/json

500

Internal server error

application/json

post

/hook-rma-processed

HTTPcURLJavaScriptPython

POST /hook-rma-processed HTTP/1.1
Host: api.parcellab.com
user: text
token: text
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "courier": "ups",
  "trackingNumber": "1Z0001730802157555",
  "articles": [
    {
      "articleNo": "SKU-123",
      "acceptedQuantity": 1,
      "rejectedQuantity": 0
    }
  ]
}

Using courier and tracking numberUsing xid referenceUsing RMA and order number

{
  "message": "Accepted"
}