> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Pickup

Create a pickup request for a package or shipment, scheduling a FedEx courier to collect the items from the specified location.

<Note>
  External Documentation

  To learn more, visit the [FedEx documentation](https://developer.fedex.com/api/en-us/catalog/pickup/v1/docs.html#operation/Create%20Pickup).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter                                | Description                                                                                                                          |
  | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
  | Account Number                           | The FedEx account number associated with the shipment.                                                                               |
  | Carrier Code                             | The specific FedEx operating company (carrier) that will handle the pickup and shipment.                                             |
  | Customer Close Time                      | The latest time the customer is available for the driver to pick up the package. <br /><br />**Note**: Must be in `HH:MM:SS` format. |
  | Package Ready Time                       | The date and time when the shipment or package will be available for the courier to pick up.                                         |
  | Pickup Location - Address City           | The city or town name for the pickup location address.                                                                               |
  | Pickup Location - Address Country Code   | The two-letter country code associated with the Pickup Location’s address.                                                           |
  | Pickup Location - Address Street Lines   | The street address of the pickup location, including the street number, name, and any specific suite or delivery details.            |
  | Pickup Location - Phone Number           | The phone number of the contact at the pickup location.                                                                              |
  | Pickup Location - State Or Province Code | The two-letter country code associated with the Pickup Location’s address.                                                           |
  | Pickup Location Address Postal Code      | The postal code of the pickup location.                                                                                              |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter               | Description                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Additional Parameters   | A JSON object for additional body parameters. Values specified in this parameter will override equivalent parameters.<br /><br />For example:<br /><pre><code>\{<br />    "first\_key": 12345,<br />    "second\_key": "some\_value"<br />}</code></pre>The object must follow the vendor's structure as defined in the [API documentation](https://developer.fedex.com/api/en-us/catalog/pickup/v1/docs.html#operation/Create%20Pickup). |
  | Customer Transaction ID | An ID to assign to the customer transaction.                                                                                                                                                                                                                                                                                                                                                                                              |
  | Language Codes          | The language and country code to use in the request.                                                                                                                                                                                                                                                                                                                                                                                      |
</div>

## Example Output

```json theme={"dark"}
{
	"customerTransactionId": "AnyCo_order123456789",
	"output": {
		"alerts": [
			{
				"alertType": "NOTE",
				"code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
				"message": "Recipient Postal-City Mismatch."
			}
		],
		"location": "COSA",
		"message": "Courier on the way",
		"pickupConfirmationCode": "3001"
	},
	"transactionId": "624deea6-b709-470c-8c39-4b5511281492"
}
```

## Workflow Library Example

[Create Pickup with Fedex and Send Results Via Email](https://library.blinkops.com/workflows/create-pickup-with-fedex-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/create-pickup-with-fedex-and-send-results-via-email/canvas" />
</div>