Fedex Logo
Developer Portal

Pickup Request API

Johdanto

Noutopyyntö-APIn avulla voit tarkistaa noutopalvelun saatavuuden, sopia kuriirin tekemän noudon ja peruuttaa noutopyynnön.

Noutopyyntö-APIa voi käyttää uusiin tai aiemmin käsiteltyihin paketteihin kaikilla FedEx Express- ja FedEx Ground -lähetysten alueilla (palautukset ja lähtevät). Tämän yksityiskohtaisen oppaan avulla pääset ajan tasalle ja opit kaiken tarvittavan noutopyyntö-APIsta.

Noutopyyntö-APIn tiedot

Seuraavassa on tärkeimmät noutopyyntö-APIin liittyvät ominaisuudet:

Noudon saatavuus

Noudon saatavuudella voit tarkistaa noutopalvelun saatavuuden syötetyn pyynnön perusteella. Noudon saatavuus riippuu kahdesta tekijästä: noutoajan päättymisajasta ja siirtymisajasta.

Noutoajan päättymisaika - Myöhäisin sallittu ajankohta, johon noudon voi sopia. Aika on noutopaikan postinumeroalueen mukainen.

Siirtymisaika - Aika, joka kuluu noutovalmiudesta (ajankohta, jolloin paketti on valmis noudettavaksi) siihen, kun kuljettaja on valmis noutamaan paketin.

Luo nouto

Tämän vaihtoehdon avulla voit sopia noudon. Se koskee kotimaisia ja kansainvälisiä FedEx Express®- ja FedEx Ground® -lähetyksiä. FedEx Groundin ja Expressin noutopyyntö-API palauttaa noudon vahvistusnumeron sekä paikkakoodin sovitulle Express-noutopyynnölle. Voit myös sopia noudon palautuslähetykselle tämän APIn avulla.

Ylimääräisen vastaanottajan osoiterivin (osoiterivi 3) avulla voit antaa täydellisemmät ja tarkat paikkatiedot, minkä ansiosta FedEx Express® -lähetykset voidaan toimittaa nopeammin. Voit säästää aikaa ja vaivaa sopimalla FedExin kuriirin kanssa lähetysten noudosta luotasi tai jostain muusta kohteesta lisämaksua vastaan.

Peruuta nouto

Tämän vaihtoehdon avulla voit peruuttaa aiemmin sovitun noudon. Tämä vaihtoehto on käytettävissä kotimaisissa ja kansainvälisissä FedEx Express- ja FedEx Ground -lähetyksissä. Kotimaiset ja kansainväliset FedEx Express -noudot voidaan peruuttaa samana päivänä. Kotimaiset ja kansainväliset FedEx Ground -lähetykset voidaan peruuttaa 24 tuntia noutopyynnön lähettämisen jälkeen. Jos lähetyksesi on jo noudettu, soita FedExin asiakaspalveluun numerossa 800 3339 tehdäksesi peruutuksen.

Noutopyynnön tiedot

FedEx Express -noutopyynnöt

  • Ajankohta, jona pakettisi ovat valmiina noudettaviksi, ei saa olla myöhäisempi kuin postinumeroalueesi noutoajan päättymisaika. Noutoajan päättymisajan voi hakea käyttämällä noudon saatavuus -pyyntöä.
  • Aika siitä kun pakettisi ovat valmiina siihen kun kuriiri ei enää pääse sisään noutamaan paketit ei saa olla pienempi kuin "siirtymisaika", jonka voit myös hakea noudon saatavuus -pyynnöllä.

    • Esimerkki: 'PT4H0M' ilmoittaa, että noutoaika on 4 tuntia ja 0 minuuttia.

  • FedEx Express -noudot voidaan sopia kuluvalle tai seuraavalle arkipäivälle.
  • Paketteja voi olla yhdessä noutopyynnössä enintään 99 kpl.
  • Jos sinulla on jo säännöllinen sovittu nouto, ei ole tarpeen sopia kertaluontoista noutoa tai lisätä uutta säännöllistä sovittua noutoa.
  • Noutopyyntöä ei voi muuttaa. Jos haluat muuttaa pyyntöä, sinun on peruutettava alkuperäinen pyyntö ja syötettävä uusi pyyntö.
  • FedExin järjestelmät tukevat nyt Yhdistyneen kuningaskunnan sisäistä noutotoiminnallisuutta.

FedEx Ground -noutopyynnöt

  • Noudon voi sopia seuraavalle arkipäivälle tai mille tahansa arkipäivälle enintään kaksi viikkoa etukäteen.
  • Paketteja voi olla yhdessä noutopyynnössä enintään 99 kpl.
  • Jos sinulla on jo säännöllinen sovittu nouto, ei ole tarpeen sopia kertaluontoista noutoa tai lisätä uutta säännöllistä sovittua noutoa.
  • Nouto asunto-osoitteesta on saatavilla lisämaksua vastaan.
  • Noutopyyntöä ei voi muuttaa. Jos haluat muuttaa pyyntöä, sinun on peruutettava alkuperäinen pyyntö ja syötettävä uusi pyyntö.

Noutopyyntö-APIn palvelutyypit

FedEx Express -nouto

Veloitamme FedEx Express -noutopyynnöistä kuriirin noutomaksun. Tämä koskee sekä fedex.com-sivuston että FedExin asiakaspalvelun kautta tehtyjä pyyntöjä.

FedEx Ground -nouto

FedEx Ground tarjoaa noutopalvelun pyynnöstä lisämaksua vastaan. Määritämme säännölliset noudot sopineille asiakkaille viikoittaisen noutomaksun sovittuun säännölliseen noutoon liittyvälle asiakasnumerolle.

  • Määritämme pakettikohtaisen noutomaksun asiakkaille, joilla ei ole sovittua vakionoutoa. Noutomaksua ei veloiteta, jos jätät pakettisi FedExin lähetystoimipisteeseen. Noutomaksut eivät myöskään koske FedEx Ground® Economy (ennen FedEx SmartPost®) Print Return Label-, FedEx Ground® Economy (ennen FedEx SmartPost®) Email Return Label- ja FedEx Ground® Package Returns Program -palveluiden noutoja.
  • FedEx Ground tarjoaa säännöllisen noudon sopineille asiakkaille noutopalvelun pyynnöstä FedEx Ground -asiakasnumeron lähetyspaikasta eroavasta osoitteesta. Tähän palveluun sisältyy lisämaksu noudoista vaihtoehtoisista osoitteista jokaista eri osoitetta kohti viikossa.

FedEx Extra Hours

FedEx Extra Hours -palvelut ovat saatavilla noutoihin yhden päivän yön yli -kuljetuksiin maanantaista perjantaihin, minkä ansiosta kauppiaat voivat täyttää illalla tehdyt tilaukset FedEx Expressin seuraavan päivän paikallistoimituksilla.

Lisätietoja saatavilla olevista palveluista saat fedex.com-verkkosivustolta.

Noutopyyntö-APIn toiminta

Noutopyyntö-APIssa ovat käytettävissä seuraavat noutovaihtoehdot:

Tarkista noudon saatavuus

Käytä tätä päätepistettä saatavilla olevien noutojen aikataulutietojen pyytämiseen.

Tähän pyyntöön liittyvät tärkeimmät syöttötiedot ovat:

  • Nouto-osoite-/postiosoitetiedot.
  • Noutopyynnön tyyppi (esim. sama päivä / päivä tulevaisuudessa).
  • FedExin kuljetusliike noutoa varten (esim. Express/Ground).
  • Onko kyseessä kotimaisen vai kansainvälisen lähetyksen nouto.

Tämän pyynnön onnistunut vastaus palauttaa saatavilla olevan noudon aikataulutiedot, kuten noudon päättymisajan, noudon päivämäärän, noudon siirtymisajan, oletusvalmiusajan ja muut noudon saatavuuden aikataulutiedot. Se palauttaa myös virheet ja niiden kuvaukset, jos jotain menee vikaan.

Luo nouto

Käytä tätä päätepistettä noudettavan paketin noutopyynnön luomiseen.

Tähän pyyntöön liittyvät tärkeimmät syöttötiedot ovat:

  • FedEx-asiakasnumero, jota laskutetaan noudosta.
  • Alkuperätiedot (osoite, sijainti ja nouto-osoitetyyppi, kuten asiakasnumero/lähettäjä/muu).
  • FedExin kuljetusliike noutoa varten (Express/Ground).
  • Liittyvät asiakasnumeron osoitetiedot.

Onnistunut noutopyyntö määrittää ajastettavalle noudolle noudon vahvistusnumeron, noutoilmoituksen ja paikkakoodin. Se palauttaa myös tiedot virheistä ja kuvaukset epäonnistumisista.

Peruuta nouto

Käytä tätä pyyntöä paketille jo sovitun noudon peruuttamiseen.

Tähän pyyntöön liittyvät tärkeimmät syöttötiedot ovat:

  • Noudon vahvistuskoodi (saadaan noutopyynnön lähettämisen yhteydessä).
  • FedExin kuljetusliike noutoa varten (Express/Ground)
  • Ajastuspäivä (päivä, jolloin nouto tapahtuu).
  • Sijainti (FedEx Express -sijainti, joka on vastuussa noutopyynnön käsittelystä).

Onnistunut noudon peruutus määrittää tapahtuman vahvistusnumeron ja peruutuksen vahvistusviestin. Se palauttaa myös tiedot virheistä ja kuvaukset epäonnistumisista.

Huomautus: Anna noudon vahvistusnumero ja sitä vastaava toimipistekoodi (koskee vain FDXE:tä) peruuttaaksesi jo varatun noudon. Noudon vahvistusnumero ja sitä vastaava sijaintikoodi (koskee vain FDXE:tä) saadaan samalla, kun lähetetään noutopyyntö. Saat ilmoituksen epäonnistumisesta, jos yrität peruuttaa noudon sen jälkeen, kun FedEx-kuriiri on lähtenyt noutopaikalle

Liiketoimintasäännöt 

  • Jos haluat pyytää noutoa eri maasta, anna maaelementti asianmukaisella maakoodilla ilmoittaaksesi mistä haluaisit FedExin noutavan lähetyksesi.
  • FedEx palauttaa jakelun vahvistusnumeron onnistuneelle jakelupyynnölle. Jakelupyynnöt tulee rajoittaa yhteen pyyntöön päivässä paitsi jos lisäät paketteja, joiden koko tai paino ylittää alkuperäisessä pyynnössä ilmoitetut.
  • Jakelupyyntö voi epäonnistua, jos syöttämäsi paketin valmistumisen ja virka-ajan päättymisen välinen aika on liian lyhyt. Jos sinulla on kysyttävää noutoajoista, ota yhteyttä alueelliseen FedExin puhelintukeen.
  • Pickup Request API tukee painotyyppejä ″LB″ ja ″KG″. Paketin ja hyödykkeen painoyksikön pitää olla sama, muuten pyyntö on virheellinen.
  • Jos sinun tarvitsee sopia nouto sekä FedEx Express- (ml. Meksikon sisäiset lähetykset) ja FedEx Ground -paketeille, sinun on sovittava noudot erikseen molemmille kuljetuspalveluille.
  • Jos noutopaikkasi on syrjäseudulta, varmista, että pakettisi ovat valmiit aikaisemmin etänoutoaikataulujen huomioon ottamiseksi.
  • Ilmoita aina myös myöhäisin aika, jolloin pakettisi voidaan noutaa (tai yrityksesi sulkemisaika).
  • Lauantainoutopalvelu on saatavilla FedEx Express -paketeille tietyissä paikoissa eri puolilla maailmaa. Useisiin FedExin toimipisteisiin voi myös tuoda lähetyksiä lauantaisin. Sijainnit-palvelusta saat luettelon toimipisteistä, joihin voi tuoda lähetyksiä lauantaisin.
  • Voit pyytää FedEx Ground- ja FedEx Express -noutoa osoitteesta, joka eroaa FedEx-asiakasnumeroosi liitetystä lähetyspaikasta.
  • Jos haluat tilata säännöllisen FedEx Express- tai FedEx Ground -noutopalvelun, ota yhteyttä FedExin Account Executive -myyntiedustajaan.
  • Voit peruuttaa FedEx Express- tai FedEx Ground -noudon vain, jos:
    • Pyynnössä ilmoitettu paketin valmiinaoloaikaa ei ole vielä ohitettu, ja
    • Kuriiri ei ole lähtenyt matkaan.

JSON API -kokoelma

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