Update Account

Update the details of an existing shipping account. With this endpoint, you can modify various attributes of the shipping account, such as contact information, service options, and others. This helps maintain current and accurate information for effective shipping operations.

Path Params
string
required

A unique identifier for the shipping account assigned by the system (ShippingAccountId) or by you (AccountAlias), allowing for efficient reference and management of individual accounts within the system.

Body Params

Shipping Account Details

DX Update Shipping Account Request

string
required
length between 0 and 20

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
required
length between 1 and 35

The official name of the shipping account as designated by the user or organization, 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 50

A unique identifier assigned to a specific DX account. This identifier is essential for authenticating and authorising API requests. This helps ensure that the API interactions are secure and linked to the correct account.

string
required
length between 1 and 50

The password which is used in conjuction with the Username of your DX account. It is essential for securing the account and ensuring that only authorised users have access to shipping details and operations.

Responses
200

The shipping account was updated successfully.

401

Unauthorized

403

Forbidden

404

The shipping account was not found.

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json