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)

POST

/pickup/v1/pickups

Use this endpoint to create a pickup request for a package. Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

Header Name	Example
`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",
  "originDetail": {
    "customerCloseTime": "17:00:00",
    "packageLocation": "FRONT",
    "pickupLocation": {
      "address": {
        "city": "Collierville",
        "countryCode": "US",
        "postalCode": "38017",
        "stateOrProvinceCode": "TN",
        "streetLines": [
          "10 Fedex Pkwy"
        ]
      },
      "contact": {
        "personName": "Contact Name for Pickup",
        "phoneNumber": "1234567890"
      }
    },
    "readyDateTimestamp": "2020-07-03T11:00:00Z"
  }
}

Response Payload

{
  "customerTransactionId": "qFKPTYzHeE5e0RE",
  "output": {
    "alerts": [
      {
        "alertType": "NOTE",
        "code": "SHIP.ADDRESS.INVALID",
        "message": "The provided address is invalid."
      }
    ],
    "location": "COSA",
    "pickupConfirmationCode": "2285"
  },
  "transactionId": "bb000c4a-ec2a-41ce-91d2-ac1a213708ea"
}

{
  "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."
    }
  ]
}

POST

/pickup/v1/pickups/availabilities

Use this endpoint to check the availability of a pickup service. Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

Header Name	Example
`x-customer-transaction-id`	`"624deea6-b709-470c-8c39-4b5511281492"`
`content-type`*	`"application/json"`
`x-locale`	`"en_US"`
`authorization`*	`"Bearer XXX"`

Request Payload

{
  "carriers": [
    "FDXE"
  ],
  "countryRelationship": "DOMESTIC",
  "pickupAddress": {
    "countryCode": "FR",
    "postalCode": "75008"
  },
  "pickupRequestType": [
    "SAME_DAY"
  ],
  "shipmentAttributes": [
    {
      "serviceType": "FEDEX_FIRST"
    }
  ]
}

Response Payload

{
  "customerTransactionId": "IrF_nXzTL6K4bnY",
  "output": {
    "alerts": [
      {
        "alertType": "NOTE",
        "code": "SHIP.POSTALCODE.REQUIRED",
        "message": "Postal code is required."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
        "message": "Postal code is required."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.POSTALCODE.REQUIRED",
        "message": "Recipient Postal-City Mismatch."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.POSTALCODE.REQUIRED",
        "message": "Recipient Postal-City Mismatch."
      }
    ],
    "options": [
      {
        "accessTime": {
          "hours": 1,
          "minutes": 30
        },
        "available": false,
        "carrier": "FDXE",
        "countryRelationship": "INTERNATIONAL",
        "cutOffTime": "15:00:00",
        "defaultLatestTimeOptions": "19:00:00",
        "defaultReadyTime": "09:00:00",
        "earlyAccessTime": {
          "hours": 1,
          "minutes": 30
        },
        "earlyCutOffTime": "14:30:00",
        "earlyPickupLocationId": "COSA",
        "latestTimeOptions": [
          "13:00:00",
          "12:00:00"
        ],
        "pickupDate": "2026-07-06T00:00:00.0Z",
        "readyTimeOptions": [
          "11:30:00",
          "12:00:00",
          "11:00:00"
        ],
        "residentialAvailable": false,
        "scheduleDay": "SAME_DAY"
      },
      {
        "accessTime": {
          "hours": 1,
          "minutes": 30
        },
        "available": false,
        "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": [
          "14:00:00",
          "12:00:00",
          "13:00:00"
        ],
        "pickupDate": "2026-07-08T00:00:00.0Z",
        "readyTimeOptions": [
          "12:00:00",
          "11:30:00",
          "11:00:00"
        ],
        "residentialAvailable": true,
        "scheduleDay": "SAME_DAY"
      },
      {
        "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": "14:30:00",
        "earlyPickupLocationId": "PITA",
        "latestTimeOptions": [
          "12:00:00",
          "14:00:00",
          "13:00:00"
        ],
        "pickupDate": "2026-07-06T00:00:00.0Z",
        "readyTimeOptions": [
          "12:00:00",
          "11:00:00",
          "11:30:00"
        ],
        "residentialAvailable": true,
        "scheduleDay": "SAME_DAY"
      },
      {
        "accessTime": {
          "hours": 1,
          "minutes": 30
        },
        "available": true,
        "carrier": "FDXE",
        "countryRelationship": "INTERNATIONAL",
        "cutOffTime": "17:00:00",
        "defaultLatestTimeOptions": "19:00:00",
        "defaultReadyTime": "14:00:00",
        "earlyAccessTime": {
          "hours": 1,
          "minutes": 30
        },
        "earlyCutOffTime": "18:30:00",
        "earlyPickupLocationId": "COSA",
        "latestTimeOptions": [
          "12:00:00",
          "13:00:00",
          "14:00:00"
        ],
        "pickupDate": "2026-07-08T00:00:00.0Z",
        "readyTimeOptions": [
          "11:00:00",
          "12:00:00",
          "11:30:00"
        ],
        "residentialAvailable": false,
        "scheduleDay": "SAME_DAY"
      }
    ],
    "requestTimestamp": "2026-07-01T00:00:00.0Z"
  },
  "transactionId": "79cdaf1f-3bde-433c-bef0-70ff1011156c"
}

{
  "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."
    }
  ]
}

PUT

/pickup/v1/pickups/cancel

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 Name	Example
`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": "TMrr785YFZ7mKZv",
  "output": {
    "alerts": [
      {
        "alertType": "NOTE",
        "code": "SHIP.ADDRESS.INVALID",
        "message": "Recipient Postal-City Mismatch."
      },
      {
        "alertType": "NOTE",
        "code": "SHIP.POSTALCODE.REQUIRED",
        "message": "The provided address is invalid."
      }
    ],
    "cancelConfirmationMessage": "Requested pickup has been cancelled successfully.",
    "pickupConfirmationCode": "K9o0fA"
  },
  "transactionId": "14e2be6a-3bd1-4852-b741-f2741aea3f31"
}

{
  "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