API References

Add Account

post
https://api.intersoftsapient.net/v4/shippingAccounts/fic

Add a shipping account for FedEx International Connect and either link it with an existing shipping location or add a new shipping account that will be associated with the shipping account.

Body Params

Add Shipping Account Request

string | null

The number assigned to the shipping account by the carrier, typically used for tracking shipments and billing purposes.

string
enum
required

Indicates whether the account is set up as a "sandbox" or "production" account. A Sandbox account is for testing and development, while a Production account is used for live shipments and transactions.

Allowed:
string | null

The official name of the shipping account as designated by the user or organisation, aiding in easy identification and reference of accounts.

Note: By default, this value is set to the customer name if not provided in the request.

string
required
length between 1 and 30

A unique, user-defined name for the shipping account, providing a convenient way to reference the account in a more memorable manner.

string
required
length between 1 and 100

The name of the primary contact person for the shipping account, facilitating communication regarding shipping and account-related matters.

Note: If the shipper address is not provided in the Create Shipment request, this information is used as the shipper's contact name, if provided.

string
required
length between 1 and 20

The phone number associated with the shipping account's primary contact person, facilitating communication regarding shipping inquiries, account management, and issue resolution.

Note: If the shipper address is not provided in the Create Shipment request, this information is used as the shipper's contact phone number, if provided. Characters like +, /, -, or space are supported.

string
required
length between 1 and 20

A unique API Key assigned to a specific FedEx International Connect account. It essential for authenticating and authorising API requests.

string
required
length between 1 and 100

Shipper Website URL which is required in the API request.

ShippingLocations
array of objects
required

An object that allows the customer to specify the shipping location(s) that will be associated with the new shipping account. Within this object, the customer can either link the existing shipping location(s) or add a new one.

Note: While adding a shipping account, make sure to provide at least one shipping location.If you are providing a new shipping location, then only one location can be added.

ShippingLocations*
Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated about 2 months ago

Language
Credentials
OAuth2
Response 
 Choose an example:
application/json
Updated about 2 months ago