Fedex Logo
Developer Portal

Pickup Request API

Introducción

La API de solicitud de recogida le permite comprobar la disponibilidad de recogida, el horario de recogida y cancelar una solicitud de recogida.

La API de solicitud de recogida es aplicable a los paquetes nuevos o previamente procesados en todas las regiones para los envíos de FedEx Express y FedEx Ground (de ida y vuelta). Esta guía detallada le pondrá al día y le enseñará todo lo que debe saber sobre la API de solicitud de recogida.

Detalles de la API de solicitud de recogida

Estas son las características principales asociadas a la API de solicitud de recogida:

Disponibilidad de recogida

Con la disponibilidad de recogida, puede comprobar la disponibilidad del servicio de recogida en función de la solicitud introducida. La disponibilidad de recogida depende de dos factores: la hora límite y el tiempo de acceso.

Hora límite: la última hora permitida para programar una recogida. Se tiene en cuenta la hora local del código postal de recogida.

Tiempo de acceso: el tiempo que transcurre entre la hora de recogida (cuando el paquete está listo para recogerse) y la hora en que el conductor está listo para recoger el paquete.

Crear una recogida

Esta opción le permite programar una recogida y se aplica a los envíos nacionales e internacionales de FedEx Express® y FedEx Ground® . La API de solicitud de recogida FedEx Ground y Express le proporciona un número de confirmación de recogida. Con la solicitud de recogida Express, además, se le proporciona un código de ubicación para la recogida programada. Con esta API, también puede programar una recogida para un envío de devolución.

La línea de dirección del destinatario adicional (línea de dirección 3) le permite proporcionar detalles de ubicación más completos y precisos para lograr una entrega más rápida de los envíos de FedEx Express®. Puede ahorrar tiempo y trabajo programando la recogida de envíos con un mensajero de FedEx en su ubicación o en otra por una tarifa adicional.

Cancelar una recogida

Esta opción le permite cancelar una recogida previamente programada. Esta opción se aplica a los envíos nacionales e internacionales con FedEx Express y FedEx Ground. Las recogidas nacionales e internacionales con FedEx Express pueden cancelarse el mismo día. Los envíos nacionales e internacionales con FedEx Ground podrán cancelarse hasta 24 horas después de haber presentado la solicitud de recogida. Si su envío ya se ha recogido, póngase en contacto con el Servicio de Atención al cliente llamando al 800 FedEx (800 3339) para proceder a la cancelación de su envío.

Detalles de la solicitud de recogida

Solicitudes de recogida FedEx Express

  • La hora en que sus paquetes estarán listos para recogerse no debe ser posterior a la hora límite del código postal de su ubicación. La hora límite se puede obtener con la solicitud de disponibilidad de recogida.
  • El tiempo que transcurre desde que sus paquetes están listos hasta el momento en que el mensajero ya no puede entrar en las instalaciones para recogerlos no debe ser inferior al «tiempo de acceso», que también puede obtenerse con la solicitud de disponibilidad de recogida.

    • Por ejemplo, «PT4H0M» indica que el tiempo de recogida es de 4 horas y 0 minutos.

  • Las recogidas FedEx Express pueden programarse para el día en curso o para el siguiente día hábil.
  • El número máximo de paquetes en una única solicitud de recogida es de 99.
  • Si ya dispone de una recogida regular programada, no es necesario programar una recogida única o añadir otra recogida regular programada.
  • No puede cambiar una solicitud de recogida. Para cambiar una solicitud, debe cancelar la solicitud original e introducir una nueva.
  • Los sistemas FedEx ahora admiten la función de recogida nacional en el Reino Unido.

Solicitudes de recogida FedEx Ground

  • La recogida puede programarse para el siguiente día hábil u otro día hábil hasta con dos semanas de antelación.
  • El número máximo de paquetes en una recogida única es de 99.
  • Si ya dispone de una recogida regular programada, no es necesario programar una recogida única o añadir otra recogida regular programada.
  • La recogida en una dirección residencial está disponible con un recargo adicional.
  • No puede cambiar una solicitud de recogida. Para cambiar una solicitud, debe cancelar la solicitud original e introducir una nueva.

Tipos de servicios de la API de solicitud de recogida

Recogida de FedEx Express

Se aplica un recargo por recogida de mensajería cuando usted solicita una recogida FedEx Express, incluyendo las solicitudes hechas a través de fedex.com y el Servicio al Cliente de FedEx.

Recogida de FedEx Ground

FedEx Ground ofrece un servicio de recogida bajo petición con un recargo adicional. En el caso de los clientes de recogida regular programada, aplicamos la tarifa de recogida semanal al número de cuenta asociado a la recogida regular programada.

  • Para los clientes que no tienen una recogida habitual programada, se aplica un recargo por petición. Los recargos por recogida por petición no se aplican si deja el envío en una ubicación FedEx. Tampoco se aplican a las etiquetas FedEx Ground® Economy (previamente FedEx SmartPost®), de devolución impresas, a las etiquetas de devolución vía e-mail de FedEx Ground® Economy (previamente FedEx SmartPost®) ni a las recogidas del programa de devolución de FedEx Ground®.
  • Para los clientes de recogidas regulares programadas, FedEx Ground proporciona el servicio de recogida bajo petición desde una dirección distinta a la dirección de envío del número de cuenta de FedEx Ground. Para este servicio de recogida en direcciones alternativas, se aplica un recargo adicional por dirección y por semana.

FedEx Extra Hours

Los servicios de recogida FedEx Extra Hours con envío inmediato de un día, de lunes a viernes, permiten a los minoristas entregar pedidos por la tarde gracias a la entrega local al día siguiente de FedEx Express .

Para más información sobre los servicios disponibles, visite fedex.com.

Cómo funciona la API de solicitud de recogida

A continuación puede encontrar las opciones de recogida disponibles para la API de solicitud de recogida:

Comprobar la disponibilidad de recogida

Utilice este punto de conexión para solicitar los detalles disponibles de su recogida programada.

Los datos más importantes de entrada asociados con esta solicitud son:

  • Dirección de recogida/datos postales.
  • Tipo de solicitud de recogida (p. ej.: mismo día/otro día).
  • Transportista FedEx para la recogida (p. ej.: Express/Ground).
  • Si es una recogida nacional o internacional.

La respuesta a esta solicitud ofrecerá detalles disponibles de la recogida programada, como son la fecha, hora límite de recogida, y hora de recogida, horario del envío por defecto y otros detalles. En caso de que haya algún fallo, también aparecerán los errores y las descripciones.

Crear una recogida

Utilice este punto de conexión para crear una solicitud de recogida de un envío.

Los datos más importantes de entrada asociados con esta solicitud son:

  • Número de cuenta de FedEx donde se facturará la recogida.
  • Datos de origen (dirección, ubicación y tipo de dirección de recogida como cuenta/remitente/otro).
  • Transportista FedEx para la recogida (Express/Ground).
  • Datos de la dirección de la cuenta asociada.

Si la solicitud de recogida es satisfactoria, obtendrá un número de confirmación de recogida, una notificación de recogida y un código de ubicación para la recogida que se está programando. En caso de que haya algún fallo, también aparecerán los errores y las descripciones.

Cancelar recogida

Utilice esta solicitud para cancelar la solicitud de recogida ya programada de un paquete.

Los datos más importantes de entrada asociados con esta solicitud son:

  • Código de confirmación de recogida (obtenido al enviar una solicitud de recogida)
  • Transportista FedEx para la recogida (Express/Ground)
  • Fecha programada (fecha en que se produce el envío de recogida)
  • Ubicación (ubicación de FedEx Express responsable de procesar la solicitud de recogida)

Si la cancelación de recogida es satisfactoria, obtendrá un número de confirmación y un mensaje de confirmación de cancelación. En caso de que haya algún fallo, también aparecerán los errores y las descripciones.

Nota: Presente el número de confirmación de recogida y el código de ubicación correspondiente (solo se aplica a FDXE) para cancelar la recogida que estaba programada. El número de confirmación de recogida y el código de ubicación correspondiente (solo se aplica a FDXE) se obtienen al enviar una solicitud de recogida. Si ya se ha enviado al mensajero de FedEx al lugar de recogida y usted intenta cancelarla, le llegará un mensaje de error.

Normas comerciales 

  • Para solicitar la recogida en un país diferente, incluya el elemento de país con el código de país adecuado donde desea que FedEx recoja su envío.
  • Si la solicitud de envío es satisfactoria, FedEx le proporcionará un número de confirmación de envío. Las solicitudes de envío están limitadas a una solicitud por día, a menos que añada paquetes que superen las dimensiones o el peso de la solicitud original.
  • Las solicitudes de envío pueden fallar si se introduce un margen de tiempo insuficiente desde que el paquete está listo hasta la hora de cierre del negocio. Si tiene preguntas sobre los horarios de recogida, póngase en contacto con la línea directa regional de FedEx.
  • La API de solicitud de recogida admite tipos de peso como «lb» y «kg». La unidad de peso del envío y la mercancía debe ser la misma, de lo contrario la solicitud generará un error.
  • Si tiene que programar una recogida tanto para paquetes de FedEx Express (incluidos los envíos dentro de México) como para paquetes de FedEx Ground, deberá programar una recogida para cada uno de los transportistas de forma individual.
  • Si su lugar de recogida está en una zona remota, asegúrese de que sus paquetes estén listos antes para ajustarse al horario de recogida remota.
  • Indique siempre la hora límite de recogida de su paquete (o la hora de cierre de su empresa).
  • El servicio de recogida en sábado se ofrece en ubicaciones seleccionadas de todo el mundo para sus envíos FedEx Express. También está disponible la entrega en sábado en muchas instalaciones FedEx. Utilice el punto de conexión de servicio de ubicaciones para recibir una lista de ubicaciones con servicio de entrega los sábados.
  • Para las recogidas de FedEx Ground y FedEx Express, puede solicitar una dirección de recogida alternativa distinta de la ubicación de envío asociada a su número de cuenta FedEx.
  • Si desea un servicio de recogida regular de FedEx Express o FedEx Ground, póngase en contacto con su ejecutivo de cuentas de FedEx.
  • Puede cancelar una recogida de FedEx Express o FedEx Ground solo si:
    • El tiempo de preparación del paquete solicitado no se ha cumplido todavía, y
    • El mensajero no se ha enviado.

Colección de API de JSON

Documentation Powered by ReDoc

Pickup Request API (1.0.0)

Create Pickup

Use this endpoint to create a pickup request for a package.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • Full_Schema_Create_Pickup
  • Create_Pickup_Ground
  • Create_Pickup_Express
  • MinimumSamplePayload-ExpressFreightPickup
associatedAccountNumber
required
object (AccountNumber)

This is the FedEx account number.
Example: Your account number

originDetail
required
object

The origin address if different than the one associated with the shipper account. This element value is required when the package is to be picked up from an address other than the shipper account address.

associatedAccountNumberType
string

This enumeration represents a kind of legacy account number from a FedEx operating entity for the account number associated to the pickup.
Valid values are: FEDEX_EXPRESS
FEDEX_GROUND

totalWeight
object

Specify The total weight of the packages for the pickup. Unit of measure is LB.

packageCount
integer <int32>

Specify the total number of packages for the pickup.
Example: 5

carrierCode
required
string
Enum: "FDXE" "FDXG"

Specify the four letter code of a FedEx operating company that meets your requirements.
Examples of FedEx Operating Comapnies are :

  • FDXE- FedEx Express
  • FDXG- FedEx Ground

accountAddressOfRecord
object

The city name, state or province code and the address classification associated with the customer account which requested the pickup.

remarks
string

Placeholder for any message to be passed to the FedEx pickup courier.
Note:Maximum length is 60 characters.
Example: Please ring bell at loading dock.

countryRelationships
string
Enum: "DOMESTIC" "INTERNATIONAL"

Describes the country relationship among the shipments being picked up. This element is not mandatory for this request, but when added, the mandatory values are DOMESTIC or INTERNATIONAL. Empty or incorrect values will result in to errors.

pickupType
string

Indicate the pickup type method by which the shipment to be tendered to FedEx.
Note: The value of this element does not specify dispatching the courier for package pickup.
Example: ON_CALL, PACKAGE_RETURN_PROGRAM, REGULAR_STOP
Click here for more information on Pickup Types.

trackingNumber
string

This is a Tracking number for FedEx packages used for tracking a single package or group of packages.
Example: 795803657326
Click here to see mock tracking numbers for FedEx Express and FedEx Ground.

commodityDescription
string

Description of the commodity being shipped.
Example:This field contains Commodity Description.
Click here to see Vague commodity descriptions

expressFreightDetail
object

Placeholder for Express Freight pickup details.

oversizePackageCount
integer <int32>

Specify the number of oversize packages that are tendered to FedEx Ground.

pickupNotificationDetail
object

This object allows user to request for pickup confirmation email. User can specify upto 5 email addresses.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/pickups

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/pickups

Production Server

https://apis.fedex.com/pickup/v1/pickups

Request samples

Content type
application/json
Example
Full_Schema_Create_Pickup
Copy
 Expand all Collapse all
{
  • "associatedAccountNumber":
    {
    },
  • "originDetail":
    {
    },
  • "associatedAccountNumberType": "FEDEX_GROUND",
  • "totalWeight":
    {
    },
  • "packageCount": 5,
  • "carrierCode": "FDXE",
  • "accountAddressOfRecord":
    {
    },
  • "remarks": "Please ring bell at loading dock.",
  • "countryRelationships": "DOMESTIC",
  • "pickupType": "ON_CALL, PACKAGE_RETURN_PROGRAM, REGULAR_STOP.",
  • "trackingNumber": "795803657326",
  • "commodityDescription": "This field contains CommodityDescription",
  • "expressFreightDetail":
    {
    },
  • "oversizePackageCount": 2,
  • "pickupNotificationDetail":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Check Pickup Availability

Use this endpoint to check the availability of a pickup service.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • Full_Schema_Pickup_Availability
  • Check_Pickup_Availability_Domestic_Express
  • Check_Pickup_Availability_Domestic_Ground
  • Check_Pickup_Availability_International_Express
pickupAddress
required
object (PickupAddress)

Specify the address for which pickup availability inquiry has been made.

dispatchDate
string

Specify the date the package is to be picked up. The format is YYYY-MM-DD. If left blank, the system considers current date as dispatch date.
Example: 2020-01-01

packageReadyTime
string

Specify the time that the package will be ready for pickup. The time format is HH:MM:SS and it refers to the local timezone. The driver should pick up the package/shipment by the given pickup time.
Example: 15:00:00

customerCloseTime
string

Specify the latest time the driver gets access to pick up the package. The time format is in HH:MM:SS and it refers to the local timezone. The driver should pick up the package by the given pickup time.
Example: 18:00:00

pickupType
string
Enum: "ON_CALL" "TAG"

Indicate the pickup type method by which the shipment to be tendered to FedEx.
Note: The value of this element does not specify dispatching the courier for package pickup.
Click here for more information on Pickup Types.

pickupRequestType
required
Array of strings
Items Enum: "SAME_DAY" "FUTURE_DAY"

Specify pickup request type.

shipmentAttributes
object (ShipmentAttributes)

Specify the shipment details, such as service type, packaging type, weight and dimensions.

Note: serviceType is required for domestic or international pickup availabilities.

numberOfBusinessDays
integer <int32>

Specify number of business days to consider when checking availability.
For example if you are indicating pickupDate for a Saturday and you indicate 3, Saturday, Sunday and Monday will be considered.
Example: 3

packageDetails
Array of objects (RequestedPickupPackageDetail)

This object is used to specify the package details.

associatedAccountNumber
string

The associated account number, which will be invoiced for the pickup.
Example:613787364.

associatedAccountNumberType
string
Enum: "FEDEX_EXPRESS" "FEDEX_GROUND"

This represents a kind of legacy account number from a FedEx operating entity for the account number associated to the pickup.
Valid values are: FEDEX_EXPRESS
FEDEX_GROUND

carriers
required
Array of strings
Items Enum: "FDXE" "FDXG"

Specify the four letter code of a FedEx operating company thet meets your requirements.
Examples of FedEx Operating Companies are:

  • FDXE - FedEx Express
  • FDXG - FedEx Ground

countryRelationship
required
string
Enum: "DOMESTIC" "INTERNATIONAL"

Specify the country relationship among the shipments being picked up. Empty or incorrect values will result in to errors.

Note: shipmentAttributes/serviceType is required for domestic or international pickup availabilities.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/pickups/availabilities

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/pickups/availabilities

Production Server

https://apis.fedex.com/pickup/v1/pickups/availabilities

Request samples

Content type
application/json
Example
Full_Schema_Pickup_Availability
Copy
 Expand all Collapse all
{
  • "pickupAddress":
    {
    },
  • "dispatchDate": "2020-10-14",
  • "packageReadyTime": "15:30:00",
  • "customerCloseTime": "18:00:00",
  • "pickupType": "ON_CALL",
  • "pickupRequestType":
    [
    ],
  • "shipmentAttributes":
    {
    },
  • "numberOfBusinessDays": 1,
  • "packageDetails":
    [
    ],
  • "associatedAccountNumber": "613787364",
  • "associatedAccountNumberType": "FEDEX_EXPRESS",
  • "carriers":
    [
    ],
  • "countryRelationship": "INTERNATIONAL"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Cancel Pickup

Use this endpoint to cancel the already scheduled pickup request.
Note: A failure notification will be sent if you attempt to cancel a pickup after the FedEx courier has been dispatched to the pickup location.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • Full_Schema_Cancel_Pickup
  • Cancel_Pickup_Ground
  • Cancel_Pickup_Express
associatedAccountNumber
required
object (AccountNumber)

This is the FedEx account number.
Example: Your account number

pickupConfirmationCode
required
string

The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested.
Example: 7

remarks
string

Placeholder for any message to be passed to the FedEx pickup courier.
Note:Maximum length is 60 characters.
Example: Please ring bell at loading dock.

carrierCode
string
Enum: "FDXE" "FDXG"

This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery. Required for FedEx Ground.
Optional for FedEx Express.
The Default is FedEx Express i.e. FDXE.

accountAddressOfRecord
object (AccountAddressOfRecord)

Address details for the associated pickup account. Indicates if the address is residential. Specifies the city name, country code, streetline number, postal code, address verification Identifier, and state or province code.

scheduledDate
required
string

Indicates the date the pickup dispatch occurs.
Format YYYY-MM-DD
Example: 2019-10-15

location
string

The FedEx Express location identifier responsible for processing the pickup request. This is returned in the CreatePickup response and is required to cancel a FedEx Express dispatch.Required only for FedEx Express Pickups. Optional for FedEx Ground. Example: LOSA

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /pickup/v1/pickups/cancel

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/pickups/cancel

Production Server

https://apis.fedex.com/pickup/v1/pickups/cancel

Request samples

Content type
application/json
Example
Full_Schema_Cancel_Pickup
Copy
 Expand all Collapse all
{
  • "associatedAccountNumber":
    {
    },
  • "pickupConfirmationCode": "7",
  • "remarks": "Please ring bell at loading dock.",
  • "carrierCode": "FDXE",
  • "accountAddressOfRecord":
    {
    },
  • "scheduledDate": "2019-10-15",
  • "location": "LOSA"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}
CLOSE

Response

Copy