QUICKSTART

API Quick Start

OAuth

Getting Started

CHANGELOG

REFERENCE

Rates

Calculate rates

Labels

Manifests

Create a manifest

Couriers

Get all couriers

Cancel Labels

Get the cancelled labels

Get a cancelled label

Pickups

Create a pickup

Cancel Pickups

Get the cancelled pickups

Cancel a pickup

Get a cancelled pickup

Shipper Accounts

Get shipper accounts

Create a shipper account

Get a shipper account

Delete a shipper account

Update a shipper account's information

Update a shipper account's credentials

Update a shipper account's settings

Specific Shipper Accounts

Create a FedEx shipper account

Update a FedEx shipper account

Address Validations (Beta)

Create an address validation

Locations

MODEL

Envelope

Primitive

PaymentMethodAccount

Resource

AddressValidation (Beta)

Carrier Guide

Supported Carriers

ENUM

Shipper Accounts Credentials

Service Types and Service Options List

All Service Options

Webhook

Webhook Overview

Webhook Specifications

Webhook Signature

Webhook Outgoing IPs

SDK

Open Source

Support

Contact Support

Update a shipper account's settings

patch

/shipper-accounts/{id}/settings

This endpoint allows you to update the settings for your specific shipper account. Only applies to FedEx currently.

Request

Security: API Key

Path Parameters

id

string

required

Shipper account id

Headers

Content-Type

string

required

Content-Type

Default:

application/json

Example:

application/json

Body

Update a shipper account's settings

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.

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.

Auth

:

Parameters

:

:

Body

preparing...