Fedex Logo
Developer Portal

Pickup Request API

Úvod

Rozhraní API požadavku na vyzvednutí umožňuje zkontrolovat dostupnost vyzvednutí, naplánovat vyzvednutí kurýrem a zrušit požadavek na vyzvednutí.

Rozhraní API požadavku na vyzvednutí je použitelné pro nové nebo dříve zpracované zásilky ve všech regionech pro zásilky FedEx Express a FedEx Ground (zpáteční a odchozí). Tento podrobný průvodce vás uvede do problematiky a naučí vás vše, co potřebujete vědět o rozhraní API požadavku na vyzvednutí.

Podrobnosti o rozhraní API pro požadavek na vyzvednutí

Níže jsou uvedeny hlavní funkce související s rozhraním API požadavku pro vyzvednutí:

Dostupnost vyzvednutí

Pomocí funkce Dostupnost vyzvednutí můžete zkontrolovat dostupnost služby vyzvednutí na základě zadaného požadavku. Dostupnost vyzvednutí závisí na dvou faktorech: době ukončení a času přístupu.

Doba ukončení - Nejzazší povolená doba pro naplánování vyzvednutí. Čas je místní, podle poštovního směrovacího čísla místa vyzvednutí.

Čas přístupu - Doba mezi časem připravenosti k vyzvednutí (kdy je balíček připraven k vyzvednutí) a časem, kdy je řidič připraven zásilku vyzvednout.

Vytvořit vyzvednutí

Tato možnost vám umožní naplánovat vyzvednutí a týká se FedEx Express® a FedEx Ground® vnitrostátních a mezinárodních zásilek. Rozhraní API pro žádosti o vyzvednutí FedEx Ground a Express vrací číslo potvrzení o vyzvednutí a u žádosti o vyzvednutí Express je navíc vrácen kód místa plánovaného vyzvednutí. Pomocí rozhraní API můžete také naplánovat vyzvednutí vrácené zásilky.

Dodatečný adresní řádek příjemce (Address line 3) umožňuje uvést úplnější a přesnější údaje o místě a dosáhnout tak rychlejšího doručení zásilek FedEx Express®. Za příplatek si můžete ušetřit čas i práci naplánováním vyzvednutí zásilky kurýrem FedEx přímo u vás nebo odjinud.

Zrušit vyzvednutí

Tato možnost vám umožní zrušit dříve naplánované vyzvednutí. Tato možnost se vztahuje na FedEx Express a FedEx Ground vnitrostátní a mezinárodní zásilky. FedEx Express vnitrostátní a mezinárodní vyzvednutí lze zrušit ve stejný den. FedEx Ground vnitrostátní a mezinárodní zásilky je možné zrušit během 24 hodin po potvrzení požadavku na vyzvednutí. Pokud již byla vaše zásilka vyzvednuta, kontaktujte prosím zákaznický servis FedEx na 800 FedEx (800 3339) pro zpracování zrušení.

Podrobnosti požadavku na vyzvednutí

Požadavky na vyzvednutí FedEx Express

  • Čas, kdy budou vaše zásilky připraveny k vyzvednutí, nesmí být pozdější než doba ukončení poštovního směrovacího čísla pro vaši provozovnu. Dobu ukončení lze získat pomocí požadavku na dostupnost vyzvednutí.
  • Doba od okamžiku, kdy budou vaše zásilky připraveny, do okamžiku, kdy kurýr již nebude moci vstoupit do objektu, aby zásilky vyzvedl, nesmí být kratší než "čas přístupu", který lze rovněž zjistit pomocí požadavku na dostupnost vyzvednutí.
  • Například: ‘PT4H0M’ znamená, že doba vyzvednutí je 4 hodiny a 0 minut.

  • FedEx Express vyzvednutí lze naplánovat na aktuální nebo příští pracovní den.
  • Maximální počet balíků pro jeden požadavek na vyzvednutí je 99.
  • Pokud již máte naplánovaný pravidelný svoz, není nutné plánovat jednorázový svoz nebo přidávat další pravidelný plánovaný svoz.
  • Požadavek na vyzvednutí nelze změnit. Pro změnu požadavku musíte původní požadavek zrušit a zadat nový.
  • FedEx systémy nyní podporují funkci vnitrostátního vyzvednutí v UK.

Požadavky na vyzvednutí FedEx Ground

  • Vyzvednutí lze naplánovat na následující pracovní den nebo jakýkoliv pracovní den až 2 týdny dopředu.
  • Maximální počet balíků pro jeden požadavek na vyzvednutí je 99.
  • Pokud již máte naplánovaný pravidelný svoz, není nutné plánovat jednorázový svoz nebo přidávat další pravidelný plánovaný svoz.
  • Vyzvednutí na adrese bydliště je možné za příplatek.
  • Požadavek na vyzvednutí nelze změnit. Pro změnu požadavku musíte původní požadavek zrušit a zadat nový.

Typy služeb rozhraní API pro požadavek na vyzvednutí

FedEx Express – vyzvednutí

Poplatek za vyzvednutí kurýrem se účtuje, pokud požádáte o FedEx Express vyzvednutí, včetně požadavků podaných prostřednictvím stránek fedex.com a zákaznického servisu FedEx.

FedEx Ground – vyzvednutí

FedEx Ground poskytuje za příplatek službu vyzvednutí na vyžádání. U zákazníků s pravidelným plánovaným svozem vyměříme týdenní poplatek za svoz na číslo účtu spojené s pravidelným plánovaným svozem.

  • Zákazníkům, kteří nemají pravidelný plánovaný svoz, účtujeme poplatek za svoz na zavolání. Poplatky za vyzvednutí na zavolání se neúčtují, pokud zásilku předáte v provozovně společnosti FedEx. Poplatky za vyzvednutí se rovněž neúčtují u služby FedEx Ground® Economy (dříve pod názvem FedEx SmartPost®) Print Return Label, FedEx Ground® Economy (dříve pod názvem FedEx SmartPost®) Email Return Label a FedEx Ground® Package Returns Program.
  • Pro zákazníky s pravidelným plánovaným svozem poskytuje FedEx Ground službu vyzvednutí na vyžádání z jiné adresy, než je místo odeslání uvedené v čísle účtu FedEx Ground. Na tuto službu se vztahuje dodatečný poplatek za vyzvednutí na náhradní adrese za každou jedinečnou adresu týdně.

FedEx Extra Hours

Služby FedEx Extra Hours jsou k dispozici pro vyzvednutí s jednodenní přepravou od pondělí do pátku, což umožňuje maloobchodníkům vyřídit večerní objednávky s místním doručením FedEx Express následující den.

Pro více informací o dostupných službách jděte na fedex.com.

Jak funguje rozhraní API požadavku na vyzvednutí

Níže jsou uvedeny možnosti dostupné pro požadavek na vyzvednutí rozhraní API:

Kontrola dostupnosti vyzvednutí

Tento poslední krok slouží k vyžádání dostupných podrobností o naplánovaném vyzvednutí.

Hlavní vstupní informace spojené s tímto požadavkem jsou:

  • Podrobnosti o adrese vyzvednutí.
  • Požadovaný typ vyzvednutí (např. tentýž den / následující den).
  • Přepravce FedEx pro vyzvednutí (př: express/ground).
  • Zda se jedná o vnitrostátní/mezinárodní vyzvednutí.

Úspěšná odpověď na tento požadavek vrátí dostupné podrobnosti o naplánovaném vyzvednutí, například nejpozdější čas vyzvednutí, datum vyzvednutí, čas přístupu k vyzvednutí, výchozí čas připravenosti a další podrobnosti o dostupnosti vyzvednutí. V případě jakéhokoli selhání rovněž vrátí chyby a jejich popisy.

Vytvořit vyzvednutí

Tento poslední krok slouží k vytvoření požadavku na vyzvednutí zásilky.

Hlavní vstupní informace spojené s tímto požadavkem jsou:

  • FedEx číslo účtu, na který bude vyzvednutí fakturováno.
  • Podrobnosti o místě původu (adresa, provozovna a typ adresy vyzvednutí jako účet/odesílatel/jiný).
  • Přepravce FedEx pro vyzvednutí (Express/Ground).
  • Podrobnosti o adrese přidruženého účtu.

Úspěšný požadavek na vyzvednutí vrátí potvrzovací číslo vyzvednutí, oznámení o vyzvednutí a kód provozovny pro naplánované vyzvednutí. V případě jakéhokoli selhání rovněž vrátí chyby a jejich popisy.

Zrušit vyzvednutí

Použijte tento požadavek pro zrušení již naplánovaného požadavku na vyzvednutí zásilky.

Hlavní vstupní informace spojené s tímto požadavkem jsou:

  • Potvrzovací kód vyzvednutí (získaný při odeslání požadavku na vyzvednutí)
  • Přepravce FedEx pro vyzvednutí (Express/Ground)
  • Naplánované datum (datum, kdy dojde k vyzvednutí)
  • Provozovna (provozovna FedEx Express odpovědná za zpracování požadavku na vyzvednutí)

Úspěšné zrušení vyzvednutí vrátí potvrzovací číslo a potvrzovací zprávu o zrušení vyzvednutí. V případě jakéhokoli selhání rovněž vrátí chyby a jejich popisy.

Poznámka: Chcete-li zrušit již naplánované vyzvednutí, odešlete potvrzovací číslo vyzvednutí a kód příslušné provozovny (platí pouze pro FDXE). Potvrzovací číslo vyzvednutí a kód příslušné provozovny (platí pouze pro FDXE) získáte při odeslání požadavku na vyzvednutí. Jestliže se pokusíte zrušit vyzvednutí poté, co byl vyslán kurýr FedEx na místo vyzvednutí zásilky, obdržíte oznámení o neúspěšném požadavku.

Obchodní pravidla 

  • Chcete-li požádat o vyzvednutí v jiné zemi, uveďte jí s příslušným kódem země, kde chcete, aby FedEx zásilku vyzvedl.
  • Společnost FedEx zašle číslo potvrzení o odeslání v případě úspěšného požadavku na odeslání. Požadavky na odeslání by měly být omezeny na jeden požadavek denně, pokud nepřidáte zásilky, které přesahují rozměry nebo hmotnost původního požadavku.
  • Požadavky na odeslání mohou selhat, pokud zadáte nedostatečné časové okno mezi připraveností zásilky a uzavřením obchodu. Pokud máte dotazy ohledně časů vyzvednutí, kontaktujte regionální linku podpory společnosti FedEx.
  • Požadavek na vyzvednutí rozhraní API podporuje jednotky hmotnosti LB a KG. Hmotnostní jednotka zásilky a komodity musí být stejná, jinak dojde k chybě.
  • Pokud potřebujete naplánovat vyzvednutí jak pro zásilky FedEx Express (včetně přepravy v rámci Mexika), tak pro zásilky FedEx Ground, musíte naplánovat jedno vyzvednutí pro každého z dopravců zvlášť.
  • Pokud se vaše místo vyzvednutí nachází v odlehlé oblasti, ujistěte se, že jsou vaše zásilky připraveny dříve pro přizpůsobení harmonogramu vyzvednutí ve vzdálené oblasti.
  • Vždy uveďte nejzazší čas, kdy je možné zásilku vyzvednout (nebo čas konce provozní doby vaší společnosti).
  • Sobotní vyzvedávání zásilek FedEx Express je nabízeno ve vybraných oblastech pro celém světě. V mnoha provozovnách FedEx je rovněž nabízena možnost sobotního zanechání zásilky v provozovně. Pomocí koncového bodu služby Locations získáte seznam provozoven otevřených v sobotu.
  • V případě vyzvednutí FedEx Ground a FedEx Express můžete požádat o jinou alternativní adresu pro vyzvednutí, než je místo odeslání spojené s číslem vašeho účtu FedEx.
  • Chcete-li službu pravidelného vyzvedávání FedEx Express nebo FedEx Ground, kontaktujte prosím svého obchodního zástupce FedEx.
  • Vyzvednutí FedEx Express nebo FedEx Ground můžete zrušit pouze když:
    • Požadavek doby připravenosti zásilky ještě nebyl splněn a
    • Nebyl vyslán kurýr.

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.


EXPAND ALLCOLLAPSE ALL
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 - Create Pickup

Content type
application/json
Example
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 - Create Pickup

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.


EXPAND ALLCOLLAPSE ALL
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 - Check Pickup Availability

Content type
application/json
Example
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 - Check Pickup Availability

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.


EXPAND ALLCOLLAPSE ALL
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 - Cancel Pickup

Content type
application/json
Example
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 - Cancel Pickup

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

Response

Copy