Fedex Logo
Developer Portal

Pickup Request API

Giriş

Alım İsteği API'si, alım uygunluğunu kontrol etmenize, teslim alım için bir kuryeyi planlamanıza ve alım isteğini iptal etmenize izin verir.

Alım İsteği API'si FedEx Express ve FedEx Ground (iade ve giden) gönderileri için tüm bölgelerde yeni veya daha önceden işleme alınmış paketler için geçerlidir. Bu ayrıntılı kılavuz size hız kazandıracak ve Alım İsteği API'si hakkında bilmeniz gereken her şeyi size öğretecektir.

Alım İsteği API'si Ayrıntıları

Aşağıda, Alım İsteği API'si ile ilgili temel özellikler verilmiştir:

Alım Uygunluğu

Alım uygunluğu ile girilen isteğe göre alım hizmetinin uygunluğunu kontrol edebilirsiniz. Alım uygunluğu iki faktöre bağlıdır: Kabul saati ve erişim saati.

Kabul saati - Bir alımın planlanması için izin verilen en son saattir. Saat, alım posta kodu için yereldir.

Erişim saati - Alıma hazır olma saati (paketin alıma hazır olduğu zaman) ve sürücünün paketi almaya hazır olduğu saat arasındaki zamandır.

Alım Oluştur

Bu seçenek bir alım planlamanıza izin verir ve FedEx Express® ve FedEx Ground® yurt içi ve uluslararası gönderiler için geçerlidir. FedEx Ground ve Express alım isteği API'si, bir alım onay numarası verir ve ayrıca konum kodu, planlanmış alım için Express alım isteğiyle birlikte verilir. Aynı zamanda bu API'yi kullanarak bir iade gönderisi için alım da planlayabilirsiniz.

Ek alıcı adres satırı (Adres satırı 3) FedEx Express® gönderilerinin daha hızlı teslim edilmesi için daha eksiksiz ve doğru konum bilgileri sunmanızı sağlar. Hem vakit kaybetmemek hem de rahatınızı bozmamak için ek ücret karşılığında bir FedEx kuryesini bulunduğunuz konumdan veya başka bir konumdan gönderi alması için çağırabilirsiniz.

Alımı İptal Et

Bu seçenek, önceden planlanmış bir alımı iptal etmenizi sağlar. Bu seçenek FedEx Express ve FedEx Ground yurt içi ve uluslararası gönderileri için geçerlidir. FedEx Express yurt içi ve Uluslararası alımlar aynı gün iptal edilebilir. FedEx Ground yurt içi ve uluslararası gönderiler, alım isteği gönderildikten 24 saat sonra iptal edilebilir. Gönderiniz zaten teslim alındıysa iptal işlemine ilerlemek için lütfen 800 FedEx (800 3339) numaralı telefondan FedEx Müşteri Hizmetlerini arayın.

Alım İsteği Ayrıntıları

FedEx Express Alım İstekleri

  • Paketlerinizin teslim almaya hazır olacağı süre, bulunduğunuz yerdeki posta kodu kabul saatinden daha geç olmamalıdır. Kabul saati, Alım Uygunluk İsteğiyle alınabilir.
  • Paketlerinizin hazır olacağı saatten kuryenin paketleri teslim almak için tesise giremeyeceği süreye kadar olan sürenin uzunluğu, Alım Uygunluk isteğiyle elde edilebilen "erişim saati"nden daha kısa olmamalıdır.

    • Örneğin: "PT4H0M" teslim alım saatinin 4 saat 0 dakika olduğunu gösterir.

  • FedEx Express alımları mevcut gün veya bir sonraki iş günü için planlanabilir.
  • Tek bir alım isteği için maksimum paket sayısı 99'dur.
  • Zaten planlanmış bir alımınız varsa tek seferlik alım planlamak veya başka bir düzenli planlanmış alım eklemek gerekli değildir.
  • Bir alım isteğini değiştiremezsiniz. Bir isteği değiştirmek için asıl isteği iptal edip yeni bir istek girmelisiniz.
  • FedEx sistemleri artık yurt içi Birleşik Krallık Alım işlevini destekler.

FedEx Ground Alım İstekleri

  • Alım, bir sonraki iş günü veya 2 haftaya kadar herhangi bir iş günü için önceden planlanabilir.
  • Tek bir alım isteği için maksimum paket sayısı 99'dur.
  • Zaten planlanmış bir alımınız varsa tek seferlik alım planlamak veya başka bir düzenli planlanmış alım eklemek gerekli değildir.
  • Bir ev adresinde alım için ek ücret uygulanır.
  • Bir alım isteğini değiştiremezsiniz. Bir isteği değiştirmek için asıl isteği iptal edip yeni bir istek girmelisiniz.

Alım İsteği API'si Hizmet Türleri

FedEx Express Alımı

Fedex.com ve FedEx Müşteri Hizmetleri üzerinden verilen istekler dahil olmak üzere bir FedEx Express Alım isteği gönderdiğinizde bir kurye alım ücreti uygulanır.

FedEx Ground Alımı

FedEx Ground, ek ücret karşılığında teslim alım hizmeti sunar. Düzenli planlanmış alım müşterileri için düzenli planlamış alımla ilişkili hesap numarasına, haftalık alım ücretini hesaplıyoruz.

  • Düzenli planlanmış bir alımı olmayan müşteriler için paket başına çağrı üzeri alım ücretini hesaplıyoruz. Çağrı üzeri alım ücretleri, paketinizi bir FedEx gönderi şubesine bırakırsanız uygulanmaz. Ayrıca çağrı üzeri alım ücretleri FedEx Ground® Economy (Önceden FedEx SmartPost® olarak biliniyordu) Baskı İade Etiketi, FedEx Ground® Economy (Önceden FedEx SmartPost® olarak biliniyordu) E-posta İade Etiketi ve FedEx Ground® Paket İade Programı alımları için uygulanmaz.
  • Düzenli planlanmış alım müşterileri için FedEx Ground, FedEx Ground hesap numarasının gönderi şubesinden farklı bir adresten isteğe bağlı olarak alım hizmeti sunar. Haftalık olarak her benzersiz adres için bir ek alternatif adres alım ücreti bu hizmet için geçerlidir.

FedEx Extra Hours

FedEx Extra Hours hizmetleri, pazartesiden cumaya kadar gecelik 1 günlük taşıma süresi ile alım için kullanılabilir ve perakendecilerin, FedEx Express bir sonraki gün yerel teslimat ile akşam siparişlerini göndermelerini sağlar.

Uygun hizmetler hakkında daha fazla bilgi için fedex.com adresini ziyaret edin.

Alım İsteği API'si Nasıl Çalışır?

Aşağıda, Alım İsteği API'si ile kullanılabilen alım seçenekleri verilmiştir:

Alım Uygunluğu Kontrolü

Bu uç noktayı, uygun alım takvimi bilgilerini talep etmek için kullanın.

Bu istekle ilişkili önemli girdi bilgileri aşağıdaki gibidir:

  • Alım adresi/posta bilgileri.
  • Alım isteği türü (örn.: aynı gün/başka bir gün).
  • Alım için FedEx taşıyıcısı (örn.: express/ground).
  • Yurt içi/uluslararası alım olup olmadığı.

Bu talebe başarılı yanıt; son alım saati, alım tarihi, alım için erişim saati, varsayılan hazır olma saati ve planlanan alım uygunluğuyla ilgili diğer bilgiler dahil olmak üzere mevcut alım planlama bilgilerini sağlayacaktır. Aynı zamanda başarısızlık durumunda hataları ve açıklamaları da verir.

Alım Oluştur

Bu uç noktayı, alınacak bir paket için bir alım talebi oluşturmak için kullanın.

Bu istekle ilişkili önemli girdi bilgileri aşağıdaki gibidir:

  • Alım için faturalandırılacak FedEx hesap numarası.
  • Menşe bilgileri (adres, konum ve hesap/gönderici/diğer gibi alım adresi türü).
  • Alım için FedEx taşıyıcısı (express/ground).
  • İlişkili hesapla ilgili adres ayrıntıları.

Başarılı alım isteği, planlanan alım için alım onay numarasını, alım bildirimini ve konum kodunu verecektir. Aynı zamanda başarısızlık durumunda hataları ve açıklamaları da verir.

Alımı İptal Et

Bir paketle ilgili zaten planlanmış bir alım isteğini iptal etmek için bu isteği kullanın.

Bu istekle ilişkili önemli girdi bilgileri aşağıdaki gibidir:

  • Alım Onay Kodu (alım isteği gönderilirken alınır)
  • Alım için FedEx taşıyıcısı (Express/Ground).
  • Planlanmış Tarih (Alım sevkiyatının yapıldığı tarih)
  • Şube (alım isteğini işleme almaktan sorumlu olan FedEx Express şubesi)

Başarılı alım iptali, bir onay numarası ve alım iptali onay mesajı verir. Aynı zamanda başarısızlık durumunda hataları ve açıklamaları da verir.

Not: Planlanmış alımı iptal etmek için alım onay numarasını ve ilgili şube kodunu (sadece FDXE için geçerlidir) gönderin. Alım onay numarası ve ilgili şube kodu (sadece FDXE için geçerlidir) bilgileri bir alım isteği gönderirken alınır. FedEx kuryesi alım şubesine sevkiyat yaptıktan sonra bir alımı iptal etmeye çalışırsanız bir hata bildirimi gönderilecektir.

İş Kuralları 

  • Farklı bir ülkede alım istemek için FedEx'in gönderinizi almasını istediğiniz ilgili ülkenin koduyla birlikte ülke ögesini ekleyin.
  • FedEx, başarılı bir sevkiyat isteği için bir sevkiyat onay numarası verir. Sevkiyat istekleri, asıl isteğin boyutlarını veya ağırlığını aşan boyutlarda paket eklemediğiniz sürece günlük bir istekle sınırlı kalmalıdır.
  • Paket hazırlığı ve iş kapanışı arasında yetersiz bir süre girerseniz sevkiyat istekleri başarısız olabilir. Teslim alım saatleri hakkında sorularınız varsa bölge FedEx Destek Hattı ile iletişime geçin.
  • Alım İsteği API'si "LB" ve "KG" ağırlık türlerini destekler. Paket ve malın ağırlık birimi aynı olmalıdır, yoksa istek hatayla sonuçlanır.
  • FedEx Express (Meksika içi gönderi dahil) ve FedEx Ground paketleri için alım planlamanız gerekiyorsa taşıyıcıların her biri için ayrı ayrı bir alım planlamanız gerekir.
  • Alım şubeniz uzaktaysa uzaktan alım planınıza uygun olması için paketlerinizi erkenden hazır edin.
  • Daima paketinizin alınabileceği en son saati ekleyin (veya şirketinizin kapanış saati).
  • Cumartesi günü alım hizmeti, FedEx Express paketleriniz için dünya genelindeki belirli yerlerde sunulur. Cumartesi şubeye bırakma aynı zamanda birçok FedEx Şubesinde geçerlidir. Cumartesi günü şubeye bırakma noktalarının listesini almak için Konum Hizmeti uç noktasını kullanın.
  • FedEx Ground ve FedEx Express alımları için FedEx hesap numaranızla ilişkili gönderi konumundan başka alternatif bir alım adresi isteyebilirsiniz.
  • Normal bir FedEx Express veya FedEx Ground alım hizmeti istiyorsanız FedEx hesap yöneticiniz ile iletişime geçin.
  • Sadece aşağıdaki durumlarda bir FedEx Express veya FedEx Ground alımını iptal edebilirsiniz:
    • İstek paketi hazır olma süresi henüz karşılanmadıysa ve
    • Kurye henüz sevkiyatı yapmadıysa.

JSON API Koleksiyonu

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