Pickup Request API
Inleiding
Met de ophaalverzoek-API kunt u de beschikbaarheid van een ophaling controleren, de ophaling door een koerier plannen en een ophaalverzoek annuleren.
De ophaalverzoek-API is bruikbaar voor nieuwe of eerder verwerkte FedEx Express- en FedEx Ground-zendingen (uitgaand en retour) in alle regio's. Deze gedetailleerde gids helpt u op weg en geeft u alle nodige informatie over de ophaalverzoek-API.
Meer over de ophaalverzoek-API
De belangrijkste kenmerken van de ophaalverzoek-API zijn:
Beschikbaarheid van de ophaalservice
Met de ophaalverzoek-API kunt u de beschikbaarheid van de ophaalservice controleren op basis van het ingevoerde verzoek. De beschikbaarheid van de ophaalservice is afhankelijk van twee factoren: de eerst mogelijke en uiterste tijd van de ophaling.
Uiterste tijd: het laatst mogelijke tijdstip waarop een ophaling kan worden gepland. Dit tijdstip is de lokale tijd voor de postcode van ophaling.
Eerst mogelijke tijd: de tijd tussen het eerste tijdstip waarop ophaling mogelijk is (wanneer het pakket klaar is om te worden opgehaald) en het tijdstip waarop de chauffeur klaar is om het pakket op te halen.
Ophaling aanmaken
Met deze optie kunt u een ophaling plannen van binnenlandse en internationale FedEx Express® - en FedEx Ground®-zendingen. De ophaalverzoek-API voor FedEx Ground en Express retourneert een ophaalbevestigingsnummer. Daarnaast wordt de locatiecode geretourneerd met het Express-ophaalverzoek voor de geplande ophaling. U kunt met deze API ook de ophaling van een retourzending plannen.
Met de extra adresregel van de ontvanger (adresregel 3) kunt u meer volledige en nauwkeurige locatiegegevens verstrekken voor een snellere aflevering van FedEx Express®-zendingen. U kunt tijd en moeite besparen door een FedEx-koerier in te plannen voor zendingen afhalen op uw eigen locatie of, tegen een toeslag, op een andere locatie.
Ophaling annuleren
Met deze optie kunt u een eerder geplande ophaling annuleren. Deze optie is beschikbaar voor binnenlandse en internationale FedEx Express- en FedEx Ground-zendingen. De ophaling van binnenlandse en internationale FedEx Express-zendingen kan op dezelfde dag worden geannuleerd. Voor binnenlandse en internationale FedEx Ground-zendingen geldt dat annulering mogelijk is tot 24 uur nadat het ophaalverzoek is ingediend. Als uw zending al is opgehaald, dient u contact op te nemen met de FedEx-klantenservice via 800 FedEx (800 3339) om de annulering voort te zetten.
Details van het ophaalverzoek
FedEx Express-ophaalverzoeken
- Het tijdstip waarop uw pakketten klaar zijn om te worden opgehaald, mag niet later zijn dan de uiterste tijd van de postcode voor uw locatie. De uiterste tijd kan worden gevonden in het verzoek voor de beschikbaarheid van de ophaling.
- De tijdsduur tussen het moment dat uw pakketten klaar zijn voor ophaling en het moment waarop de koerier het pand niet meer kan betreden om de pakketten op te halen, mag niet korter zijn dan de 'toegangstijd'. Deze tijd kan ook worden gevonden in het verzoek voor de beschikbaarheid van de ophaling.
- De ophaling van FedEx Express-zendingen kan worden gepland voor de huidige of de volgende werkdag.
- Het maximumaantal pakketten voor een enkel ophaalverzoek is 99.
- Het is voor een reguliere geplande ophaling niet nodig om een eenmalige ophaling in te plannen of een andere reguliere geplande ophaling toe te voegen.
- U kunt een ophaalverzoek niet wijzigen. Voor het wijzigen van een verzoek, moet u het oorspronkelijke verzoek annuleren en een nieuw verzoek indienen.
- FedEx-systemen ondersteunen nu ook binnenlandse ophalingen in het Verenigd Koninkrijk.
Bijvoorbeeld: 'PT4H0M' geeft aan dat de ophaaltijd 4 uur en 0 minuten is.
Ophaalverzoek voor FedEx Ground-zendingen
- De ophaling kan tot twee weken van tevoren worden gepland voor de volgende of elke andere werkdag.
- Het maximumaantal pakketten voor een enkel ophaalverzoek is 99.
- Het is voor een reguliere geplande ophaling niet nodig om een eenmalige ophaling in te plannen of een andere reguliere geplande ophaling toe te voegen.
- U kunt tegen een toeslag de ophaling op een woonadres plannen.
- U kunt een ophaalverzoek niet wijzigen. Voor het wijzigen van een verzoek, moet u het oorspronkelijke verzoek annuleren en een nieuw verzoek indienen.
Beschikbare servicestypes voor de ophaalverzoek-API
FedEx Express Ophalen
Er worden ophaalkosten in rekening gebracht wanneer u een ophaalverzoek voor FedEx Express-zendingen indient. Dit geldt ook voor verzoeken die via fedex.com of de FedEx-klantenservice zijn ingediend.
FedEx Ground Ophalen
FedEx Ground biedt tegen een toeslag een ophaalservice op aanvraag. Voor klanten die regelmatig een ophaalverzoek indienen, brengen we de wekelijkse ophaalkosten in rekening op het klantnummer dat aan de reguliere geplande ophaling is gekoppeld.
- Voor klanten die geen vaste ophaling hebben, brengen we de kosten van elke afzonderlijke ophaling per pakket in rekening. Er worden geen kosten voor de ophaling in rekening gebracht als u uw pakket aflevert op een FedEx-verzendlocatie. Er worden geen kosten voor de ophaling in rekening gebracht voor FedEx Ground® Economy (voorheen FedEx SmartPost®) Print Return Label, FedEx Ground® Economy (voorheen FedEx SmartPost®) Email Return Label en FedEx Ground® pakketten die onderdeel zijn van het programma voor retourneren.
- Voor klanten die regelmatig een ophaalverzoek indienen, biedt FedEx Ground een ophaalservice op aanvraag vanaf een ander adres dan de verzendlocatie die aan het FedEx Ground-klantnummer is gekoppeld. Voor deze service wordt wekelijks een toeslag in rekening gebracht voor elke ophaling vanaf een alternatief adres.
FedEx Extra Hours
FedEx Extra Hours-services kunnen van maandag t/m vrijdag worden opgehaald en de volgende werkdag worden afgeleverd, waardoor winkeliers 's avonds bestellingen kunnen vervullen en deze kunnen verzenden met FedEx Express voor lokale aflevering op de volgende werkdag.
Ga voor meer informatie over de beschikbare services naar fedex.com.
Zo werkt de ophaalverzoek-API
Voor de ophaalverzoek-API zijn de volgende ophaalopties beschikbaar:
Beschikbaarheid van de ophaalservice controleren
Gebruik dit eindpunt om planningsgegevens voor een beschikbare ophaling aan te vragen.
De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:
- Ophaaladres/postgegevens.
- Type ophaalverzoek (bijvoorbeeld dezelfde dag/toekomstige dag).
- FedEx-transportvervoerder voor de ophaling (bijvoorbeeld: Express/Ground).
- Of er sprake is van ophalen in het binnenland/buitenland.
De succesvolle respons voor dit verzoek retourneert de planningsgegevens voor de beschikbare ophaling, zoals de uiterste tijd van de ophaling, datum van de ophaling, eerst mogelijke tijd voor de ophaling, standaardophaaltijd en andere planningsgegevens over de beschikbaarheid van de ophaling. In het geval van eventuele mislukkingen, worden de fouten en beschrijvingen geretourneerd.
Ophaling aanmaken
Gebruik dit eindpunt voor het aanmaken van een ophaalverzoek voor een pakket dat kan worden opgehaald.
De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:
- FedEx-klantnummer dat voor de ophaling wordt gefactureerd.
- Herkomstgegevens (adres, de locatie en het type ophaaladres, zoals klantnummer/verzender/overig).
- FedEx-transportvervoerder voor de ophaling (Express/Ground).
- Adresgegevens voor het gekoppelde account.
Een succesvolle ophaalrespons retourneert een ophaalbevestigingsnummer, ophaalmelding en locatiecode voor de geplande ophaling. In het geval van eventuele mislukkingen, worden de fouten en beschrijvingen geretourneerd.
Ophaling annuleren
Gebruik dit verzoek om een gepland ophaalverzoek voor een pakket te annuleren.
De belangrijkste gegevens die voor dit verzoek moeten worden ingevoerd, zijn:
- Ophaalbevestigingscode (deze is verkregen na het indienen van een ophalingsverzoek).
- FedEx-transportvervoerder voor de ophaling (Express/Ground)
- Geplande datum (de datum waarop de ophaling wordt verzonden)
- Locatie (de FedEx Express-locatie die verantwoordelijk is voor het verwerken van het ophaalverzoek)
Een succesvolle annulering van de ophaling retourneert een bevestigingsnummer en een bericht waarin het annuleren van de ophaling wordt bevestigd. In het geval van eventuele mislukkingen, worden de fouten en beschrijvingen geretourneerd.
Opmerking: voor het annuleren van de geplande ophaling verstrekt u het ophaalbevestigingsnummer en de bijbehorende locatiecode in (alleen van toepassing op FDXE). Het ophaalbevestigingsnummer en de bijbehorende locatiecode (alleen van toepassing op FDXE) ontvangt u tijdens het indienen van een ophaalverzoek. Er wordt een foutmelding verzonden wanneer u een ophaling probeert te annuleren waarvoor de FedEx-koerier al onderweg is naar de ophaallocatie.
Bedrijfsregels
- Als u een ophaalverzoek voor een ander land indient, moet u voor het land waarin de FedEx-zending wilt ophalen het landelement met de juiste landcode toevoegen.
- Voor een geslaagd verzendverzoek retourneert FedEx een verzendbevestigingsnummer. Verzendverzoeken moeten worden beperkt tot één verzoek per dag, tenzij u pakketten toevoegt die groter zijn dan de afmetingen of het gewicht van het oorspronkelijke verzoek.
- Verzendverzoeken kunnen mislukken als u een te krap venster invoert voor de tijd tussen het moment waarop het pakket klaar is voor ophaling en de uiterste tijd waarop het kan worden opgehaald (sluitingstijd). Neem contact op met de FedEx-klantenservice als u vragen hebt over de ophaaltijden.
- De ophaalverzoek-API ondersteunt gewichtseenheden als 'LB' en 'KG'. De gewichtseenheid voor het pakket en het artikel moeten hetzelfde zijn, anders leidt het verzoek tot fouten.
- Als u een ophaling wilt plannen voor zowel FedEx Express- (inclusief zendingen binnen Mexico) als FedEx Ground-pakketten, moet u voor elke vervoerder afzonderlijk een ophaling plannen.
- Als uw ophaallocatie zich in een afgelegen gebied bevindt, zorg er dan voor dat uw pakketten zijn voorbereid op een afgelegen ophaling.
- Vermeld altijd het uiterste tijdstip waarop uw pakket kan worden opgehaald (of de sluitingstijd van uw bedrijf).
- De service 'Ophaling op zaterdag' wordt aangeboden op geselecteerde locaties voor uw FedEx Express-pakketten. Aflevering op zaterdag is ook op vele FedEx-locaties beschikbaar. Gebruik het eindpunt 'Locatieservices' voor een lijst met locaties die op zaterdag beschikbaar zijn voor aflevering.
- Voor de ophaling van FedEx Ground- en FedEx Express-zendingen kunt u een ophaaladres aanvragen dat anders is dan de verzendlocatie die aan uw FedEx-klantnummer is gekoppeld.
- Neem contact op met uw FedEx account executive als u een reguliere FedEx Express of FedEx Ground-ophaalservice wilt.
- U kunt de ophaling van een FedEx Express- of FedEx Ground-zending alleen annuleren als:
- Het tijdstip waarop de zending klaar is voor ophaling nog niet is aangevangen, en
- De koerier nog niet onderweg is.
JSON API-verzameling
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
- Full_Schema_Create_Pickup
- Create_Pickup_Ground
- Create_Pickup_Express
- MinimumSamplePayload-ExpressFreightPickup
associatedAccountNumber required | object (AccountNumber) This is the FedEx 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. |
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. |
carrierCode required | string Enum: "FDXE" "FDXG" Specify the four letter code of a FedEx operating company that meets your requirements.
|
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. |
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. |
trackingNumber | string This is a Tracking number for FedEx packages used for tracking a single package or group of packages. |
commodityDescription | string Description of the commodity being shipped. |
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
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "associatedAccountNumber": {
- "value": "Your account number"
- "originDetail": {
- "pickupAddressType": "ACCOUNT",
- "pickupLocation": {
- "contact": {
- "companyName": "Fedex",
- "personName": "John Taylor",
- "phoneNumber": "7194446666",
- "phoneExtension": "phone extension"
- "address": {
- "streetLines": [
- "123 Ship Street",
- "Suite 302"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "accountNumber": {
- "value": "XXX289837"
- "deliveryInstructions": "deliveryInstructions"
- "readyDateTimestamp": "2020-04-02T11:00:00Z",
- "customerCloseTime": "18:00:00",
- "pickupDateType": "SAME_DAY",
- "packageLocation": "FRONT",
- "buildingPart": "APARTMENT",
- "buildingPartDescription": "111",
- "earlyPickup": false,
- "suppliesRequested": "Supplies requested by customer",
- "geographicalPostalCode": "geographicalPostalCode"
- "associatedAccountNumberType": "FEDEX_GROUND",
- "totalWeight": {
- "units": "KG",
- "value": 20
- "packageCount": 5,
- "carrierCode": "FDXE",
- "accountAddressOfRecord": {
- "streetLines": [
- "123 Ship Street"
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "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": {
- "truckType": "DROP_TRAILER_AGREEMENT",
- "service": "FEDEX_1_DAY_FREIGHT",
- "trailerLength": "TRAILER_28_FT",
- "bookingNumber": "1234AGTT",
- "dimensions": {
- "length": 20,
- "width": 15,
- "height": 12,
- "units": "CM"
- "oversizePackageCount": 2,
- "pickupNotificationDetail": {
- "emailDetails": [
- {
- "address": "sample@gmail.com",
- "locale": "en_US"
- "format": "HTML",
- "userMessage": "This is the user message"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "pickupConfirmationCode": "3001",
- "message": "Courier on the way",
- "location": "COSA",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
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
- 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. |
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. |
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. |
pickupType | string Enum: "ON_CALL" "TAG" Indicate the pickup type method by which the shipment to be tendered to FedEx. |
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. |
numberOfBusinessDays | integer <int32> Specify number of business days to consider when checking availability. |
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. |
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. |
carriers required | Array of strings Items Enum: "FDXE" "FDXG" Specify the four letter code of a FedEx operating company thet meets your requirements.
|
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. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "pickupAddress": {
- "streetLines": [
- "123 Ship Street"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "dispatchDate": "2020-10-14",
- "packageReadyTime": "15:30:00",
- "customerCloseTime": "18:00:00",
- "pickupType": "ON_CALL",
- "pickupRequestType": [
- "SAME_DAY"
- "shipmentAttributes": {
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "weight": {
- "units": "KG",
- "value": 20
- "packagingType": "YOUR_PACKAGING",
- "dimensions": {
- "length": 7,
- "width": 8,
- "units": "CM",
- "height": 9
- "numberOfBusinessDays": 1,
- "packageDetails": [
- {
- "packageSpecialServices": {
- "specialServiceTypes": [
- "SIGNATURE_OPTION"
- "associatedAccountNumber": "613787364",
- "associatedAccountNumberType": "FEDEX_EXPRESS",
- "carriers": [
- "FDXE"
- "countryRelationship": "INTERNATIONAL"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "requestTimestamp": "2020-04-02T04:19:00",
- "options": [
- {
- "carrier": "FDXE",
- "available": true,
- "pickupDate": "2019-01-20",
- "cutOffTime": "18:30:00",
- "accessTime": {
- "hours": 1,
- "minutes": 30
- "residentialAvailable": true,
- "countryRelationship": "INTERNATIONAL",
- "scheduleDay": "SAME_DAY",
- "defaultReadyTime": "14:00:00",
- "defaultLatestTimeOptions": "19:00:00",
- "earlyCutOffTime": "14:30:00",
- "earlyAccessTime": {
- "hours": 1,
- "minutes": 30
- "earlyPickupLocationId": "PITA",
- "readyTimeOptions": [
- "11:00:00"
- "latestTimeOptions": [
- "12:00:00"
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
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
- Full_Schema_Cancel_Pickup
- Cancel_Pickup_Ground
- Cancel_Pickup_Express
associatedAccountNumber required | object (AccountNumber) This is the FedEx account number. |
pickupConfirmationCode required | string The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested. |
remarks | string Placeholder for any message to be passed to the FedEx pickup courier. |
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. |
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. |
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
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "associatedAccountNumber": {
- "value": "Your account number"
- "pickupConfirmationCode": "7",
- "remarks": "Please ring bell at loading dock.",
- "carrierCode": "FDXE",
- "accountAddressOfRecord": {
- "streetLines": [
- "123 Ship Street"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "ON",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "scheduledDate": "2019-10-15",
- "location": "LOSA"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "pickupConfirmationCode": "NQAA97",
- "cancelConfirmationMessage": "Requested pickup has been cancelled Successfully.",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
Response