Fedex Logo
Developer Portal

Pickup Request API

Введение

API запросов о заборе посылок позволяет проверить возможность забора посылок, вызвать курьера и отменить запрос о заборе.

API запросов о заборе посылок доступен во всех регионах для новых или уже обработанных отправлений FedEx Express и FedEx Ground (возвращаемых и исходящих). Это подробное руководство поможет вам ускорить работу и расскажет все, что нужно знать об API запросов о заборе посылок.

Сведения об API запросов о заборе посылок

API запросов о заборе посылок включает следующие основные функции:

Доступность забора

Проверка доступности забора позволяет проверить доступность услуги забора по указанным параметрам. Доступность забора зависит от двух факторов: крайний срок забора и время доступа.

Крайний срок забора — самое позднее возможное время для забора посылки. Используется местное время, соответствующее почтовому индексу, указанному для забора.

Время доступа — промежуток между временем готовности посылки к забору и временем, когда водитель готов забрать отправление.

Создание записи о заборе посылки

Эта функция позволяет выбрать время забора и доступна для внутренних и международных отправлений FedEx Express® и FedEx Ground®. API запросов о заборе посылок FedEx Ground и Express выдает номер подтверждения забора, а при запросе о заборе отправления Express выдается также код местоположения для заказанного забора. С помощью этого API можно также заказывать забор возвращаемых отправлений.

Дополнительная адресная строка получателя (строка адреса 3) позволяет указать более полную и точную информацию о местонахождении для более быстрой доставки FedEx Express®. Вы можете сэкономить время и силы, вызвав курьера FedEx для забора посылок по своему или другому адресу за дополнительную плату.

Отмена забора посылок

Эта функция позволяет отменить заказанный ранее забор посылок. Она доступна для внутренних и международных отправлений FedEx Express и FedEx Ground. Забор внутренних и международных отправлений FedEx Express может быть отменен в тот же день. Внутренние и международные отправления FedEx Ground можно отменять в течение 24 часов после подачи запроса о заборе. Если отправление уже забрали, для отмены нужно обратиться в отдел FedEx по работе с клиентами по телефону 800 FedEx (800 3339).

Подробнее о запросах забора посылок

Запросы о заборе отправлений FedEx Express

  • Ваши посылки должны быть готовы к забору не позднее крайнего срока забора для вашего местонахождения, которое определяется по почтовому индексу. Крайний срок забора можно узнать, отправив запрос о доступности забора.
  • Период времени с момента готовности ваших посылок к забору до момента, когда курьер уже не сможет попасть в помещение для забора посылок, должен быть не меньше «времени доступа», которое также можно узнать с помощью запроса о доступности забора.

    • Например, «PT4H0M» обозначает, что время забора — 4 часа 0 минут.

  • Забор отправлений FedEx Express можно заказать на текущий или следующий рабочий день.
  • Максимальное количество отправлений для одного запроса о заборе составляет 99 штук.
  • Если у вас уже есть регулярный забор посылок по расписанию, заказывать разовый забор или добавлять еще один регулярный забор по расписанию необязательно.
  • Запрос о заборе посылки изменить нельзя. Для изменения запроса необходимо отменить первоначальный запрос и отправить новый.
  • Системы FedEx теперь поддерживают возможность забора внутренних отправлений в Великобритании.

Запрос о заборе отправлений FedEx Ground

  • Забор можно заказать на следующий или на любой другой рабочий день в пределах 2 недель.
  • Максимальное количество отправлений для одного запроса о заборе составляет 99 штук.
  • Если у вас уже есть регулярный забор посылок по расписанию, заказывать разовый забор или добавлять еще один регулярный забор по расписанию необязательно.
  • Забор по жилому адресу доступен за дополнительную плату.
  • Запрос о заборе посылки изменить нельзя. Для изменения запроса необходимо отменить первоначальный запрос и отправить новый.

Типы услуг о запросе API о заборе

Забор отправления FedEx Express

Оплата забора курьером применяется при запросе забора отправлений FedEx Express, включая запросы, подаваемые через веб-сайт fedex.com в отдел FedEx по работе с клиентами.

Забор отправления FedEx Ground

FedEx Ground предоставляет услугу забора посылок по запросу за дополнительную плату. При использовании регулярного забора посылок по расписанию мы рассчитываем еженедельную плату за эту услугу и начисляем ее на счет, привязанный к такому забору.

  • Для клиентов, которые не используют регулярный забор посылок по расписанию, мы рассчитываем стоимость забора каждой посылки по требованию. Плата за забор посылок по требованию не взимается, если вы сами сдаете посылку в офисе FedEx. Кроме того, не взимается плата за забор посылок в рамках услуг FedEx Ground® Economy (ранее FedEx SmartPost®) Print Return Label, FedEx Ground® Economy (ранее FedEx SmartPost®) Email Return Label и FedEx Ground® Package Returns.
  • Для клиентов, которые не используют регулярный забор посылок по расписанию, FedEx Ground предлагает услугу забора по запросу с адреса, отличного от места доставки, указанного в номере счета FedEx Ground. За эту услугу взимается еженедельная дополнительная плата за каждый альтернативный адрес забора.

FedEx Extra Hours

Услуга FedEx Extra Hours позволяет заказывать забор посылок на следующее утро с доставкой в течение 1 дня с понедельника по пятницу, что дает возможность розничным продавцам доставлять заказы службой FedEx Express по местным адресам на следующий рабочий день.

Дополнительную информацию о доступных услугах см. на веб-сайте fedex.com.

Как работает API запросов о заборе посылок

В API запросов о заборе посылок доступны следующие опции:

Проверка доступности забора

Используйте эту конечную точку, чтобы запрашивать сведения о доступности расписания забора.

В запросе указываются следующие основные параметры:

  • сведения об адресе забора/почтовом адресе;
  • тип запроса о заборе посылки (например, в тот же или на следующий день);
  • перевозчик FedEx для забора посылки (Express/Ground);
  • является ли посылка для забора внутренней или международной.

В случае успеха возвращаются сведения о доступности расписания забора, например время окончания забора, дата забора, длительность доступа, время готовности по умолчанию и другие сведения о доступности запланированного забора. В случае проблем также возвращаются ошибки и их описания.

Создание записи о заборе посылки

Используйте эту конечную точку, чтобы создать запрос забора для грузового места.

В запросе указываются следующие основные параметры:

  • номер счета FedEx, на который будет выставлен счет на оплату забора;
  • данные пункта отправления (адрес, местонахождение и тип адреса забора, например «клиент/отправитель/другое»);
  • перевозчик FedEx для забора посылки (Express/Ground);
  • данные адреса для связанного счета.

Запрос возвращает номер подтверждения забора, уведомление о заборе и код офиса для запланированного забора. В случае проблем также возвращаются ошибки и их описания.

Отменить забор

Используйте этот запрос для отмены уже заказанного забора посылки.

В запросе указываются следующие основные параметры:

  • код подтверждения забора (предоставляется при отправке запроса о заборе);
  • перевозчик FedEx для забора посылки (Express/Ground);
  • запланированная дата забора;
  • офис (офис FedEx Express, ответственный за обработку запроса о заборе груза).

При отмене забора выдается номер подтверждения и сообщение с подтверждением отмены забора. В случае проблем также возвращаются ошибки и их описания.

Примечание. Чтобы отменить запланированный забор, укажите номер подтверждения забора и соответствующий код офиса (только для FDXE). Номер подтверждения забора и соответствующий код офиса (только для FDXE) предоставляются при отправке запроса о заборе. Если вы попытаетесь отменить забор после того, как курьер FedEx отправится в офис забора, вам будет отправлено уведомление об ошибке.

Правила для компаний

  • Чтобы запросить забор посылки для отправки в другую страну, включите элемент страны с соответствующим кодом страны, в которой FedEx должен забрать ваше отправление.
  • В случае успешного запроса на отправку FedEx выдает номер подтверждения отправки. Запросы об отправке должны быть ограничены одним запросом в день, если вы не добавляете отправления, размеры или вес которых больше, чем в исходном запросе.
  • Запросы об отправке могут завершаться ошибкой, если вы укажете недостаточное время между готовностью отправления и окончанием рабочего дня. По вопросам о времени забора обращайтесь в региональную горячую линию поддержки FedEx.
  • API запросов о заборе посылок позволяет указывать вес как в фунтах, так и в килограммах. Чтобы запрос не завершался ошибкой, единицы измерения веса посылки и товара должны совпадать.
  • Если вам нужно заказать забор отправлений FedEx Express (включая доставку в пределах Мексики) и отправлений FedEx Ground, заказывайте отдельный забор для каждого из этих перевозчиков.
  • Если ваше место забора находится в удаленной местности, ваши посылки должны быть готовы раньше, чтобы уложиться в график забора посылок в удаленной местности.
  • Всегда указывайте самое позднее возможное время забора (или время закрытия вашей компании).
  • В некоторых странах посылки FedEx Express могут забирать по субботам. Во многих офисах FedEx также принимают посылки по субботам. Для получения списка мест, где принимают отправления по субботам, используйте конечную точку «Услуги офисов».
  • Для отправлений FedEx Ground и FedEx Express можно запрашивать забор по альтернативному адресу, отличному от места доставки, привязанного к вашему номеру счета FedEx.
  • Если вам нужен регулярный забор отправлений FedEx Express или FedEx Ground, обратитесь к сотруднику FedEx по работе со счетами клиентов.
  • Вы можете отменить забор отравлений FedEx Express или FedEx Ground, только если:
    • заказанное время забора отправления уже прошло; и
    • курьер не выехал.

Коллекция API JSON

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