> For the complete documentation index, see [llms.txt](https://docs.parcellab.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parcellab.com/docs/developers/v2/returns/rma-actions-api/reschedule-pickup-order-api.md).

# Reschedule Pickup Order API

Use this endpoint to move an existing scheduled pickup to a new date/time window.

Production endpoint URL:

```
https://returns-api.parcellab.com/prod/reschedulePickUpOrder
```

For details on access, view the overview here:

{% content-ref url="/pages/ECzngWMawj0hRD9NBSDr" %}
[RMA Actions API](/docs/developers/v2/returns/rma-actions-api.md)
{% endcontent-ref %}

### What This Endpoint Achieves

When successful, the API:

* Requests pickup rescheduling with the configured courier
* Stores updated pickup status on the return
* Propagates new pickup information to tracking updates

### Request

#### Headers

<table><thead><tr><th width="158">Header</th><th width="141.5">Required</th><th>Type</th></tr></thead><tbody><tr><td><code>user</code></td><td>yes</td><td>string</td></tr><tr><td><code>Content-Type</code></td><td>yes</td><td>string (<code>application/json</code>)</td></tr></tbody></table>

#### Query Parameters

<table><thead><tr><th width="146">Parameter</th><th width="120">Required</th><th width="130">Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>returnId</code></td><td>yes</td><td>string</td><td>24-character return ID.</td></tr><tr><td><code>lang</code></td><td>yes</td><td>string</td><td>Language context.</td></tr><tr><td><code>country</code></td><td>yes</td><td>string</td><td>Country/market context.</td></tr><tr><td><code>draft</code></td><td>no</td><td>string</td><td>Set to <code>true</code> for draft config.</td></tr></tbody></table>

#### JSON Body

<table><thead><tr><th width="206">Field</th><th width="129.5">Required</th><th width="143.5">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>pickupDate</code></td><td>yes</td><td>string</td><td>New pickup date.</td></tr><tr><td><code>earliestPickupTime</code></td><td>no</td><td>string</td><td>Earliest requested pickup time.</td></tr><tr><td><code>latestPickupTime</code></td><td>no</td><td>string</td><td>Latest requested pickup time.</td></tr></tbody></table>

### Example Request

```bash
curl \
  -X POST "https://returns-api.parcellab.com/prod/reschedulePickUpOrder?returnId=af0000000000000000000001&lang=en&country=us" \
  -H "user: 1612198" \
  -H "Content-Type: application/json" \
  -d '{
    "pickupDate": "2026-02-20",
    "earliestPickupTime": "08:00",
    "latestPickupTime": "16:00"
  }'
```

### Success Response (`200 OK`)

```json
{
  "returnId": "af0000000000000000000001",
  "status": true,
  "pickUpStatus": {
    "pickupWindow": "2026-02-20T08:00:00-2026-02-20T16:00:00",
    "pickupConfirmationCode": "ABC123"
  }
}
```

<table><thead><tr><th width="166.5">Field</th><th width="130">Type</th><th>Meaning</th></tr></thead><tbody><tr><td><code>returnId</code></td><td>string</td><td>Return ID affected.</td></tr><tr><td><code>status</code></td><td>boolean</td><td><code>true</code> when reschedule flow succeeded.</td></tr><tr><td><code>pickUpStatus</code></td><td>object</td><td>Courier-provided updated pickup status payload.</td></tr></tbody></table>

### Notes

* This endpoint applies to returns with an existing scheduled pickup.
* If no reschedulable pickup exists, the request may fail with a business error.
* Depending on merchant configuration, an external RMA update export may also run.

### Error Responses

<table><thead><tr><th width="148">Status</th><th>Error value</th><th>Meaning</th></tr></thead><tbody><tr><td><code>400</code></td><td><code>Payload schema validation failed.</code></td><td>Missing/invalid request input.</td></tr><tr><td><code>400</code></td><td><code>Pickup order could not be rescheduled.</code></td><td>Courier reschedule failed.</td></tr><tr><td><code>400</code></td><td><code>RMA export failed.</code></td><td>External RMA update export failed.</td></tr><tr><td><code>400</code></td><td><code>No modifiers to update is set</code></td><td>No state change could be applied.</td></tr><tr><td><code>400</code></td><td><code>Pickup failed to be stored on the database.</code></td><td>DB update failed after courier success.</td></tr><tr><td><code>403</code></td><td><code>FORBIDDEN</code></td><td><code>returnId</code> is not accessible in caller context.</td></tr><tr><td><code>404</code></td><td><code>User not found.</code></td><td>Merchant context not found.</td></tr><tr><td><code>404</code></td><td><code>Order does not exist.</code></td><td><code>returnId</code> not found.</td></tr><tr><td><code>500</code></td><td>implementation-defined</td><td>Unexpected server error.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parcellab.com/docs/developers/v2/returns/rma-actions-api/reschedule-pickup-order-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
