View Fedex Services

Fedex Pickup Request Virtual Sandbox

Virtual API for scheduling and managing FedEx courier pickup requests.

A virtualized interface for the FedEx Pickup Request API, allowing developers to simulate the scheduling of package pickups, checking pickup availability, and processing cancellations. This sandbox provides predictable responses for logistics workflows, enabling the validation of request payloads and error handling without interacting with live FedEx infrastructure.

Use this hosted sandbox to simulate Fedex Pickup Request APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Use cases:

Use this sandbox to validate pickup scheduling logic, verify availability response structures, test cancellation workflows, and ensure proper handling of address-specific pickup constraints and service-level error codes.

Fedex Pickup Request virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate Fedex Pickup Request responses instantly.

https://fedex-pickup.mock.beeceptor.com



General(3 operations)

Header NameExample
x-customer-transaction-id"624deea6-b709-470c-8c39-4b5511281492"
content-type*"application/json"
x-locale"en_US"
authorization*"Bearer XXX"
Request Payload
{
  "accountAddressOfRecord": {
    "addressClassification": "MIXED",
    "city": "Memphis",
    "countryCode": "US",
    "postalCode": "38017",
    "residential": false,
    "stateOrProvinceCode": "TN",
    "streetLines": [
      "123 Ship Street"
    ]
  },
  "associatedAccountNumber": {
    "value": "Your account number"
  },
  "associatedAccountNumberType": "FEDEX_EXPRESS",
  "carrierCode": "FDXE",
  "commodityDescription": "Innovative Keyboard featuring scientific technology and Rubber construction",
  "countryRelationships": "DOMESTIC",
  "expressFreightDetail": {
    "bookingNumber": "OlAINwFD",
    "dimensions": {
      "height": 12,
      "length": 20,
      "units": "CM",
      "width": 15
    },
    "service": "FEDEX_1_DAY_FREIGHT",
    "trailerLength": "TRAILER_28_FT",
    "truckType": "DROP_TRAILER_AGREEMENT"
  },
  "originDetail": {
    "buildingPart": "APARTMENT",
    "buildingPartDescription": "967",
    "customerCloseTime": "17:00:00",
    "earlyPickup": true,
    "geographicalPostalCode": "15667-7699",
    "packageLocation": "FRONT",
    "pickupAddressType": "ACCOUNT",
    "pickupDateType": "FUTURE_DAY",
    "pickupLocation": {
      "accountNumber": {
        "value": "XXX289837"
      },
      "address": {
        "addressClassification": "MIXED",
        "city": "Beverly Hills",
        "countryCode": "US",
        "postalCode": "38127",
        "residential": false,
        "stateOrProvinceCode": "CA",
        "streetLines": [
          "10 FedEx Parkway",
          "Suite 302"
        ],
        "urbanizationCode": "URB FAIR OAKS"
      },
      "contact": {
        "companyName": "Fedex",
        "personName": "John Taylor",
        "phoneExtension": "phone extension",
        "phoneNumber": "7194446666"
      },
      "deliveryInstructions": "deliveryInstructions"
    },
    "readyDateTimestamp": "Sun Oct 11 2026 11:26:23 GMT+0000 (Coordinated Universal Time)",
    "suppliesRequested": "FedEx Tube"
  },
  "oversizePackageCount": 1,
  "packageCount": 9,
  "pickupChargesPayment": {
    "paymentType": "ACCOUNT",
    "payor": {
      "responsibleParty": {
        "accountNumber": {
          "key": "omL6xrUx1e85v2R",
          "value": "315128774"
        }
      }
    },
    "payorType": "SENDER"
  },
  "pickupNotificationDetail": {
    "emailDetails": [
      {
        "address": "Jose52@yahoo.com",
        "locale": "de_DE"
      },
      {
        "address": "Evelyn.Raynor56@gmail.com",
        "locale": "de_DE"
      },
      {
        "address": "Mozell_Pacocha@gmail.com",
        "locale": "de_DE"
      },
      {
        "address": "Kyleigh89@gmail.com",
        "locale": "en_US"
      }
    ],
    "format": "HTML",
    "userMessage": "This is the pickup confirmation message."
  },
  "pickupType": "ON_CALL",
  "remarks": "Please ring bell at loading dock.",
  "requestedExpressPickupDetail": {
    "serviceType": "FEDEX_GROUND"
  },
  "totalWeight": {
    "units": "KG",
    "value": 20
  },
  "trackingNumber": "3",
  "version": {
    "major": 2,
    "minor": 0,
    "patch": 0
  }
}
Response Payload
{
  "customerTransactionId": "43nYJrlgjeB0MXE",
  "output": {
    "alerts": [
      {
        "alertType": "NOTE",
        "code": "SHIP.POSTALCODE.REQUIRED",
        "message": "Recipient Postal-City Mismatch."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
        "message": "Recipient Postal-City Mismatch."
      }
    ],
    "location": "DALS",
    "pickupConfirmationCode": "4252"
  },
  "transactionId": "5a421077-7cab-459d-b275-27461b2a8221"
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "customerTransactionId": "AnyCo_order123456789",
  "errors": [
    {
      "code": "PICKUP.REQUESTED.PREVIOUS.DAY",
      "message": "Cannot schedule a pickup requested for a previous day."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "errors": [
    {
      "code": "NOT.AUTHORIZED.ERROR",
      "message": "Access token expired. Please modify your request and try again."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "errors": [
    {
      "code": "FORBIDDEN.ERROR",
      "message": "We could not authorize your credentials. Please check your permissions and try again."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "errors": [
    {
      "code": "NOT.FOUND.ERROR",
      "message": "The resource you requested is no longer available. Please modify your request and try again."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "customerTransactionId": "AnyCo_order123456789",
  "errors": [
    {
      "code": "INTERNAL.SERVER.ERROR",
      "message": "We encountered an unexpected error and are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "customerTransactionId": "AnyCo_order123456789",
  "errors": [
    {
      "code": "SERVICE.UNAVAILABLE.ERROR",
      "message": "The service is currently unavailable and we are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
    }
  ]
}
Header NameExample
x-customer-transaction-id"624deea6-b709-470c-8c39-4b5511281492"
content-type*"application/json"
x-locale"en_US"
authorization*"Bearer XXX"
Request Payload
{
  "carriers": [
    "FDXG"
  ],
  "countryRelationship": "DOMESTIC",
  "pickupAddress": {
    "countryCode": "US",
    "postalCode": "38116"
  },
  "pickupRequestType": [
    "FUTURE_DAY"
  ]
}
Response Payload
{
  "customerTransactionId": "cnI4NT73ku5g-Yp",
  "output": {
    "alerts": [
      {
        "alertType": "NOTE",
        "code": "SHIP.ADDRESS.INVALID",
        "message": "The provided address is invalid."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.POSTALCODE.REQUIRED",
        "message": "Postal code is required."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
        "message": "Postal code is required."
      }
    ],
    "options": [
      {
        "accessTime": {
          "hours": 1,
          "minutes": 30
        },
        "available": true,
        "carrier": "FDXE",
        "countryRelationship": "INTERNATIONAL",
        "cutOffTime": "15:00:00",
        "defaultLatestTimeOptions": "19:00:00",
        "defaultReadyTime": "09:00:00",
        "earlyAccessTime": {
          "hours": 1,
          "minutes": 30
        },
        "earlyCutOffTime": "18:30:00",
        "earlyPickupLocationId": "PITA",
        "latestTimeOptions": [
          "12:00:00",
          "14:00:00",
          "13:00:00"
        ],
        "pickupDate": "2026-10-17T00:00:00.0Z",
        "readyTimeOptions": [
          "11:00:00",
          "11:30:00"
        ],
        "residentialAvailable": true,
        "scheduleDay": "SAME_DAY"
      },
      {
        "accessTime": {
          "hours": 1,
          "minutes": 30
        },
        "available": false,
        "carrier": "FDXE",
        "countryRelationship": "DOMESTIC",
        "cutOffTime": "17:00:00",
        "defaultLatestTimeOptions": "19:00:00",
        "defaultReadyTime": "14:00:00",
        "earlyAccessTime": {
          "hours": 1,
          "minutes": 30
        },
        "earlyCutOffTime": "14:30:00",
        "earlyPickupLocationId": "PITA",
        "latestTimeOptions": [
          "13:00:00",
          "14:00:00",
          "12:00:00"
        ],
        "pickupDate": "2026-10-11T00:00:00.0Z",
        "readyTimeOptions": [
          "12:00:00",
          "11:00:00",
          "11:30:00"
        ],
        "residentialAvailable": false,
        "scheduleDay": "SAME_DAY"
      },
      {
        "accessTime": {
          "hours": 1,
          "minutes": 30
        },
        "available": true,
        "carrier": "FDXE",
        "countryRelationship": "INTERNATIONAL",
        "cutOffTime": "18:30:00",
        "defaultLatestTimeOptions": "19:00:00",
        "defaultReadyTime": "09:00:00",
        "earlyAccessTime": {
          "hours": 1,
          "minutes": 30
        },
        "earlyCutOffTime": "14:30:00",
        "earlyPickupLocationId": "COSA",
        "latestTimeOptions": [
          "13:00:00",
          "14:00:00",
          "12:00:00"
        ],
        "pickupDate": "2026-10-13T00:00:00.0Z",
        "readyTimeOptions": [
          "11:30:00",
          "11:00:00"
        ],
        "residentialAvailable": true,
        "scheduleDay": "SAME_DAY"
      },
      {
        "accessTime": {
          "hours": 1,
          "minutes": 30
        },
        "available": true,
        "carrier": "FDXE",
        "countryRelationship": "DOMESTIC",
        "cutOffTime": "17:00:00",
        "defaultLatestTimeOptions": "19:00:00",
        "defaultReadyTime": "14:00:00",
        "earlyAccessTime": {
          "hours": 1,
          "minutes": 30
        },
        "earlyCutOffTime": "14:30:00",
        "earlyPickupLocationId": "PITA",
        "latestTimeOptions": [
          "12:00:00",
          "14:00:00",
          "13:00:00"
        ],
        "pickupDate": "2026-10-15T00:00:00.0Z",
        "readyTimeOptions": [
          "11:30:00",
          "11:00:00"
        ],
        "residentialAvailable": false,
        "scheduleDay": "SAME_DAY"
      }
    ],
    "requestTimestamp": "2026-10-10T00:00:00.0Z"
  },
  "transactionId": "20b2a2d1-75b8-47dc-bc4c-a6b8af5d0ad2"
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "customerTransactionId": "AnyCo_order123456789",
  "errors": [
    {
      "code": "PICKUP.POSTALCODE.MISSING",
      "message": "PostalCode is missing."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "errors": [
    {
      "code": "NOT.AUTHORIZED.ERROR",
      "message": "Access token expired. Please modify your request and try again."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "errors": [
    {
      "code": "FORBIDDEN.ERROR",
      "message": "We could not authorize your credentials. Please check your permissions and try again."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "errors": [
    {
      "code": "NOT.FOUND.ERROR",
      "message": "The resource you requested is no longer available. Please modify your request and try again."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "customerTransactionId": "AnyCo_order123456789",
  "errors": [
    {
      "code": "INTERNAL.SERVER.ERROR",
      "message": "We encountered an unexpected error and are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "customerTransactionId": "AnyCo_order123456789",
  "errors": [
    {
      "code": "SERVICE.UNAVAILABLE.ERROR",
      "message": "The service is currently unavailable and we are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
    }
  ]
}
Header NameExample
x-customer-transaction-id"624deea6-b709-470c-8c39-4b5511281492"
content-type*"application/json"
x-locale"en_US"
authorization*"Bearer XXX"
Request Payload
{
  "associatedAccountNumber": {
    "value": "XXX561073"
  },
  "carrierCode": "FDXG",
  "pickupConfirmationCode": "CPU16200910",
  "scheduledDate": "2020-07-03"
}
Response Payload
{
  "customerTransactionId": "q-h7LgX6H1syJbH",
  "output": {
    "alerts": [
      {
        "alertType": "NOTE",
        "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
        "message": "Recipient Postal-City Mismatch."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.ADDRESS.INVALID",
        "message": "Postal code is required."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
        "message": "Recipient Postal-City Mismatch."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
        "message": "Postal code is required."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.ADDRESS.INVALID",
        "message": "The provided address is invalid."
      }
    ],
    "cancelConfirmationMessage": "Requested pickup has been cancelled successfully.",
    "pickupConfirmationCode": "EsxvBt"
  },
  "transactionId": "b300df41-ab9e-4f93-9f43-2f7b0b19fa3e"
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "customerTransactionId": "AnyCo_order123456789",
  "errors": [
    {
      "code": "PICKUP.NUMBER.EXPIRED",
      "message": "PREVIOUS DAY PICKUP, CANNOT CANCEL OR UPDATE"
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "errors": [
    {
      "code": "NOT.AUTHORIZED.ERROR",
      "message": "Access token expired. Please modify your request and try again."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "errors": [
    {
      "code": "FORBIDDEN.ERROR",
      "message": "We could not authorize your credentials. Please check your permissions and try again."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "errors": [
    {
      "code": "NOT.FOUND.ERROR",
      "message": "The resource you requested is no longer available. Please modify your request and try again."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "customerTransactionId": "AnyCo_order123456789",
  "errors": [
    {
      "code": "INTERNAL.SERVER.ERROR",
      "message": "We encountered an unexpected error and are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
    }
  ]
}
{
  "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  "customerTransactionId": "AnyCo_order123456789",
  "errors": [
    {
      "code": "SERVICE.UNAVAILABLE.ERROR",
      "message": "The service is currently unavailable and we are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
    }
  ]
}
Service Homepage: developer.fedex.com/api/en-us/catalog/pickup/v1/docs.html
fedexlogisticsshippingpickupapi