This endpoint allows you to update a legacy FedEx or FedEx Ground® Economy shipper account via API. You can integrate our API with your system and manage the shipper account according to your needs.

Once the update is completed, the account credentials and address information will be locked and cannot be modified. Please ensure that your account credentials, invoice details, and address are correct before initiating the update.

Request

Security: API Key

Path Parameters

string

required

Headers

Content-Type

string

required

Content-Type

Default:

application/json

Example:

application/json

Body

Update a FedEx or FedEx Ground® Economy shipper account

invoice

object

required

number

string

required

Unique invoice identifier or reference number.

currency

string

required

ISO currency code for the invoice amount (e.g. USD).

date

string

required

Invoice date in YYYY-MM-DD format.

amount

number

required

Total amount on the commercial invoice.

credentials

object

account_number

string

required

hub_id

string

Required for FedEx Ground® Economy.

address

object

Address object: the description of address information

street1

string

required

address_line1 of address

country

string

required

Country in ISO 3166-1 alpha 3 code

contact_name

string

required

contact_name of address

phone

string

contact_phone of address

string or null

email of address

company_name

string or null

company_name of address

street2

string or null

address_line2 of address

city

string or null

city of address

state

string or null

state of address

postal_code

string or null

postal_code of address

type

string or null

type of address

Allowed values:

residentialbusiness

tax_id

string or null

tax id

settings

object

Settings object: additional settings of the shipper account.

preferred_currency

string

electronic_trade_documents_enabled

boolean

Set to true to enable FedEx Electronic Trade Documents (ETD), provide both commercial_invoice_letterhead and commercial_invoice_signature are required. Otherwise ETD is disabled and any provided image fields are ignored.

commercial_invoice_letterhead

string

Letterhead image to generate courier's electronic commercial invoice. Only Base64-encoded PNG images are supported, the max resolution is 700 pixels wide by 50 pixels long. Only applies to FedEx currently.

commercial_invoice_signature

string

Signature image to generate courier's electronic commercial invoice. Only Base64-encoded PNG images are supported, the max resolution is 240 pixels wide by 25 pixels long. Only applies to FedEx currently.

Example:

{"code":200,"type":"OK","message":"Everything worked as expected."}

code

integer

required

Code of Meta

message

string

required

Message of Meta

details

array[Error]

Details of Meta

retryable

boolean

Whether this request will be retryable or not

data

object

string

Shipper Account ID

address

Address

Address object: the description of address information

slug

string

Couirer slug

status

string

Allowed values:

enableddisableddeleted

description

string

The description of the account

type

string

The type of the shipper_account

Allowed values:

defaultuser

timezone

string

Shipper account timezone

settings

object

Settings object: additional settings of the shipper account.

created_at

string

A formatted date.

updated_at

string

A formatted date.

Auth

Parameters

Body

{
  "credentials": {
    "account_number": "******"
  },
  "invoice": {
    "number": "234562278",
    "currency": "USD",
    "date": "2026-02-24",
    "amount": 234
  },
  "settings": {
    "preferred_currency": "USD",
    "electronic_trade_documents_enabled": true,
    "commercial_invoice_letterhead": "********",
    "commercial_invoice_signature": "********"
  },
  "address": {
    "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
    "country": "HKG",
    "contact_name": "Sir Foo",
    "phone": "11111111",
    "email": "[email protected]",
    "company_name": "Foo Store",
    "street2": "18 Cheung Shun Street, Lai Chi Kok",
    "city": "Lai Chi Kok",
    "state": null,
    "postal_code": null,
    "type": "business",
    "tax_id": null
  }
}

Response Example

{
  "meta": {
    "code": 200,
    "message": "OK",
    "details": []
  },
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "description": "My Shipper Account",
    "slug": "fedex",
    "status": "enabled",
    "timezone": "Asia/Hong_Kong",
    "type": "default",
    "created_at": "2016-02-12T10:30:50+00:00",
    "updated_at": "2016-09-23T04:56:26+00:00",
    "address": {
      "country": "HKG",
      "contact_name": "Sir Foo",
      "phone": "11111111",
      "fax": null,
      "email": "[email protected]",
      "company_name": "Foo Store",
      "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
      "street2": "18 Cheung Shun Street, Lai Chi Kok",
      "city": "Lai Chi Kok",
      "type": "business",
      "postal_code": null,
      "state": null,
      "street3": null,
      "tax_id": null
    },
    "settings": {
      "preferred_currency": "USD",
      "electronic_trade_documents_enabled": true,
      "commercial_invoice_letterhead": "********",
      "commercial_invoice_signature": "********"
    }
  }
}

Update a FedEx shipper account

Request

Path Parameters

Headers

Body

Responses

200

Body