Fedex Logo
Developer Portal

Pickup Request API

Bevezetés

A Küldeményfelvételi kérés API lehetővé teszi, hogy ellenőrizze a küldeményfelvétel lehetőségét, küldeményfelvételi időpontot egyeztessen a futárral, valamint küldeményfelvételi kérést töröljön.

A Küldeményfelvételi kérés API új vagy korábban feldolgozott csomagok esetén használható minden régióban a FedEx Express és FedEx Ground (visszáru és kimenő) szolgáltatás esetén. Ebben a részletes útmutatóban mindent megtalál, amit a Küldeményfelvételi kérés API-ról tudni kell.

A Küldeményfelvételi kérés API részletes adatai

A Küldeményfelvételi kérés API legfontosabb funkciói a következők:

Küldeményfelvétel lehetősége

A küldeményfelvétel lehetőségének ellenőrzésével megtudhatja, hogy elérhető-e a küldeményfelvételi szolgáltatás a megadott adatok alapján. A küldeményfelvétel lehetősége két tényezőtől függ: a munkaidő vége és a hozzáférési időszak.

Munkaidő vége - A legkésőbbi lehetséges küldeményfelvételi időpont. A küldeményfelvétel helyét jelölő irányítószám esetén érvényes helyi idő szerint értendő.

Hozzáférési időszak - Azt az időszakot jelöli, amely a küldeménynek a felvételre való készen állása és a sofőrnek a küldemény felvételére való készen állása között telik el.

Küldeményfelvétel létrehozása

Ez a funkció lehetővé teszi küldeményfelvétel ütemezését, és FedEx Express® and FedEx Ground® szolgáltatással feladott belföldi és nemzetközi küldemények esetén vehető igénybe. A FedEx Ground és Express szolgáltatások Küldeményfelvételi kérelem API-ja a kérésre válaszul megjelenít egy küldeményfelvételi megerősítő számot, az Express esetén pedig egy kirendeltségkód is megjelenik az ütemezett küldeményfelvételhez. Az API segítségével visszaküldött küldemény esetén is ütemezhet küldeményfelvételt.

A címzett címének beírásához extra címsor (3. címsor) áll rendelkezésére, így részletesebb és pontosabb helyadatokat adhat meg, ami a FedEx Express® szolgáltatással feladott küldemények gyorsabb kézbesítését tesz lehetővé. Időt és fáradságot takaríthat meg, ha beütemezi, hogy a FedEx futárja mikor vegye fel a küldeményeket az Ön tartózkodási helyén vagy egy másik helyszínen, felár ellenében.

Küldeményfelvétel törlése

Ezzel a lehetőséggel lemondhatja a korábban beütemezett küldeményfelvételt. A lehetőség a FedEx Express és FedEx Ground szolgáltatással feladott belföldi és nemzetközi küldemények esetén vehető igénybe. A FedEx Express szolgáltatással feladott belföldi és nemzetközi küldemények felvételét a küldeményfelvétel napján is le lehet mondani. A FedEx Ground szolgáltatással feladott belföldi és nemzetközi küldemények esetében a küldeményfelvételi kérés beküldését követő 24 órán belül lehet lemondani a küldeményfelvételt. Ha már felvették a küldeményét, kérjük, vegye fel a kapcsolatot a FedEx ügyfélszolgálatával a 800 FedEx (800 3339) számon a lemondás kéréséhez.

Küldeményfelvételi kérelem részletes adatai

FedEx Express szolgáltatással feladott küldemény felvételi kérelme

  • A csomagok felvételre való készen állásának időpontja nem lehet későbbi a tartózkodás helyén érvényes, postai irányítószám szerinti küldeményfelvételi határidőnél. A küldeményfelvételi határidő lekérhető a Küldeményfelvétel lehetősége funkcióval küldött kérés beküldésével.
  • A csomagok készenlététől addig az időpontig eltelt idő, amikor a futár már nem tudja átvenni a csomagokat a helyszínen, nem lehet kevesebb, mint a „hozzáférési időszak”, amely szintén lekérdezhető a Küldeményfelvétel lehetősége funkcióval küldött kérés beküldésével.

    • Példa: A „PT4H0M“ rövidítés azt jelenti, hogy a küldeményfelvételi időszak 4 óra 0 perc hosszúságú.

  • A FedEx Express szolgáltatással küldött küldemények felvételét aznapra vagy a következő munkanapra lehet ütemezni.
  • Az egyszerre felvehető küldemények maximális száma 99.
  • Ha rendszeres küldeményfelvétel van beállítva Önnél, nem szükséges egyszeri küldeményfelvételt ütemeznie vagy még egy rendszeres küldeményfelvételt létrehoznia.
  • Nem változtathatja meg a küldeményfelvételi kérést. Kérés megváltoztatásához le kell mondania az eredeti kérést, és új kérést kell beküldenie.
  • A FedEx rendszerei már támogatják az egyesült királyságbeli belföldi küldeményfelvétel funkciót.

FedEx Ground szolgáltatással küldött küldemények felvételének kérése

  • A küldeményfelvételt a következő munkanapra vagy két héten belül bármelyik másik munkanapra lehet ütemezni.
  • Az egyszerre felvehető küldemények maximális száma 99.
  • Ha rendszeres küldeményfelvétel van beállítva Önnél, nem szükséges egyszeri küldeményfelvételt ütemeznie vagy még egy rendszeres küldeményfelvételt létrehoznia.
  • Pótdíj ellenében lehetőség van a küldemény lakcímen történő felvételére is.
  • Nem változtathatja meg a küldeményfelvételi kérést. Kérés megváltoztatásához le kell mondania az eredeti kérést, és új kérést kell beküldenie.

A Küldeményfelvételi kérés API szolgáltatástípusai

FedEx Express csomagfelvétel

Ha a FedEx Express szolgáltatáson belül küldeményfelvételt kér, futár általi felvételért járó pótdíjat kell fizetni; ez vonatkozik a fedex.com webhelyen és a FedEx ügyfélszolgálaton leadott kérésekre is.

FedEx Ground csomagfelvétel

A FedEx Ground keretében igénybe vehető küldeményfelvételi szolgáltatás pótdíj ellenében. A rendszeres, ütemezett küldeményfelvételt beállító ügyfelek esetén heti küldeményfelvételi díjat terhelünk a megfelelő ügyfélszámlára.

  • A rendszeres, ütemezett küldeményfelvétellel nem rendelkező ügyfelek esetén csomagonkénti küldeményfelvételi díjat számolunk fel a kiszállásért. A kiszállásért felszámolt díjat nem kell megfizetni, amennyiben a FedEx egyik szállítási kirendeltségén adja le a csomagját. Továbbá, a telefonon egyeztetett csomagfelvételi díjak nem vonatkoznak a FedEx Ground® Economy (korábban FedEx SmartPost®) nyomtatott visszárucímkéjére, a FedEx Ground® Economy (korábban FedEx SmartPost®) e-mailes visszárucímkéjére, valamint a FedEx Ground® csomagvisszaküldési programjának felvételeire.
  • A rendszeres, ütemezett küldeményfelvételt igénybe vevő ügyfelek kérhetik a FedEx Ground szolgáltatásban a FedEx Ground ügyfélazonosítóhoz tartozó szállítási helyszíntől eltérő címről történő csomagfelvételt. Az alternatív küldeményfelvételi cím igényléséért címenként és heti bontásban szolgáltatási díjat számítunk fel.

FedEx Extra Hours

A FedEx Extra Hours szolgáltatásokkal a küldeményfelvétel után egynapos éjszakai szállítást vállalunk hétfőtől péntekig, így a kiskereskedők az esti rendeléseket FedEx Express másnapi helyi kiszállítással teljesíthetik.

A rendelkezésre álló szolgáltatásokkal kapcsolatos további információkért tekintse meg a fedex.com webhelyet.

A Küldeményfelvételi kérés API működése

A Küldeményfelvételi kérés API keretén belül a következő küldeményfelvételi lehetőségek állnak rendelkezésre:

Küldeményfelvétel lehetőségének ellenőrzése

Ezzel a végponttal kérheti le a rendelkezésre álló csomagfelvételi ütemezés részleteit.

A kérelemhez kapcsolódó legfontosabb beviteli adatok a következők:

  • Küldeményfelvételi cím/postai adatok.
  • Küldeményfelvételi kérés típusa (pl. aznapi/későbbi).
  • A küldeményfelvételt kezelő FedEx-szolgáltatás (pl. Express/Ground).
  • Belföldi vagy nemzetközi küldeményfelvétel.

Az erre a kérésre jövő sikeres válasz visszaküldi a rendelkezésre álló csomagfelvételi ütemezés részleteit, például a felvétel határidejét, dátumát, elérési idejét, az alapértelmezett készenléti időt és a felvétel rendelkezésre állásának egyéb ütemezett részleteit. Hibák esetén hibaüzenetet is küld, és leírást nyújt a hibákról.

Küldeményfelvétel létrehozása

Ezzel a végponttal hozhat létre felvételi kérelmet egy csomag felvételére.

A kérelemhez kapcsolódó legfontosabb beviteli adatok a következők:

  • FedEx ügyfélazonosító, amelyre a küldeményfelvétel költségét lehet terhelni.
  • Kiindulási hely adatai (cím, kirendeltség és küldeményfelvételi cím típusa, pl. ügyfélszámla/feladó/egyéb).
  • A küldeményfelvételt kezelő FedEx-szolgáltatás (Express/Ground).
  • A megfelelő ügyfélszámla címadatai.

Sikeres küldeményfelvételi kérés esetén a rendszer megjelenít egy küldeményfelvételt megerősítő számot, egy küldeményfelvételi értesítést és egy kirendeltségkódot a beütemezett küldeményfelvételhez. Hibák esetén hibaüzenetet is küld, és leírást nyújt a hibákról.

Küldeményfelvétel törlése

Ezzel a kérelemmel lemondhat már beütemezett küldeményfelvételi kéréseket.

A kérelemhez kapcsolódó legfontosabb beviteli adatok a következők:

  • Küldeményfelvételt megerősítő kód (küldeményfelvételi kérés benyújtásakor kapott szám)
  • A küldeményfelvételt kezelő FedEx-szolgáltatás (Express/Ground).
  • Beütemezett dátum (a küldeményfelvétel napja)
  • Kirendeltség (a küldeményfelvételi kérést feldolgozó FedEx Express kirendeltség)

A küldemény sikeres lemondása esetén a rendszer megerősítő számot és a küldeményfelvétel lemondásáról szóló megerősítő üzenetet jelenít meg. Hibák esetén hibaüzenetet is küld, és leírást nyújt a hibákról.

Megjegyzés: Beütemezett küldeményfelvétel lemondásához adja meg a küldeményfelvételt megerősítő számot és a megfelelő kirendeltségkódot (csak FDXE-re vonatkozik). A küldeményfelvételt megerősítő kódot és a megfelelő kirendeltségkódot (csak FDXE-re vonatkozik) a küldeményfelvételi kérés beküldésekor kapja meg. A rendszer üzenetet küld a kérés elutasításáról, ha a küldeményfelvételt azután próbálja meg lemondani, hogy a FedEx futárja már elindult a küldeményfelvétel helyszínére.

Üzleti szabályok 

  • Ha egy másik országban kíván küldeményfelvételt kérni, adja meg azt az országot is a megfelelő országkóddal együtt, ahol szeretné, hogy a FedEx felvegye a küldeményét.
  • A FedEx futárindítási megerősítő számot küld sikeres futárkérés esetén. Egy nap legfeljebb egy futárkérést lehet beküldeni, hacsak nem ad hozzá a kéréséhez olyan csomagokat, amelyek meghaladják az eredeti kérésben megadott méreteket és súlyt.
  • A futárkéréseket elutasíthatja a rendszer, amennyiben a csomag elkészültéhez megadott idő és a munkaidő vége közötti időszak túl rövid. A küldeményfelvételi időkkel kapcsolatos kérdés esetén hívja fel a FedEx helyi ügyfélszolgálatának telefonszámát.
  • A Küldeményfelvételi kérelem API a tömeg mértékegységeként csak „LB“-ot (font) és „KG“-ot (kilogramm) fogad el. A csomag és az árucikk esetén azonosnak kell lennie a tömeg mértékegységének, különben hibaüzenet érkezik a kérésre.
  • Ha FedEx Express (beleértve a Mexikón belüli szállítást is) és FedEx Ground szolgáltatással küldött csomagok felvételét is szeretné beütemezni, akkor mindkét fuvarozó számára külön-külön kell beütemeznie egy-egy küldeményfelvételt.
  • Ha az Ön küldeményfelvételi helyszíne távoli területen van, gondoskodjon arról, hogy csomagjai időben elkészüljenek, hogy megfeleljenek a távol eső területekre vonatkozó csomagfelvételi rendnek.
  • Mindig adja meg a legkésőbbi időpontot, amikor a csomagját fel lehet venni (vagy a vállalata zárási idejét).
  • Világszerte egyes kirendeltségeken igénybe vehető szombati küldeményfelvételi szolgáltatás a FedEx Express csomagokhoz. Szombati csomagleadásra is van lehetőség több FedEx kirendeltségen. A Kirendeltségszolgáltatások végponttal kilistázhatja azokat a kirendeltségeket, ahol szombaton is leadhatók csomagok.
  • A FedEx Ground és FedEx Express szolgáltatással küldendő csomagok esetében kérheti a FedEx ügyfélazonosítójához tartozó szállítási helyszíntől eltérő küldeményfelvételi címről történő felvételt.
  • Ha rendszeres FedEx Express vagy FedEx Ground küldeményfelvételi szolgáltatást szeretne igényelni, vegye fel a kapcsolatot a FedEx kereskedelmi képviselőjével.
  • Csak a következő esetekben mondhatja le FedEx Express vagy FedEx Ground szolgáltatással szállítandó küldemény felvételét:
    • a kérésben szereplő csomagkészenléti idő még nem érkezett el, és
    • a futár még nem indult el.

JSON API-gyűjtemény

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