API References

Update Account

put
https://api.intersoftsapient.net/v4/shippingAccounts/dhlexpress/

Update shipping account details.
Note: All required fields must be populated in the request, regardless if they need updating or not.

Path Params
string
required

Shipping Account Identifier
SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you).

Body Params

Shipping Account Details

DHL Express Update Shipping Account Request

string
required
length between 1 and 12

Carrier Account Number / The account number given by the carrier.

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 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.

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.

string
required
length between 1 and 200

A unique API Key assigned to a specific DHL Express account. It is essential for authenticating and authorising API requests.

string
required
length between 1 and 200

A unique API Secret assigned to a specific DHL Express account. It is essential for authenticating and authorising API requests.

boolean

Indicates whether DHL waybill documents are available for download as PDF.
Valid values are the following:

  • True - the way bill documents will be available for download in PDF format
  • False - the way bill documents will not be available for download

boolean

Indicates whether the documents are submitted electronically.
Valid values are the following:

  • True - the documents can be submitted electronically
  • False - the documents cannot be submitted electronically

string
enum

Specifies the DHL Paperless Trade (PLT) invoice option for electronically transmitting commercial invoice documentation.
Valid values are the following:

  • DhlGenerated: This value allows DHL to create the invoice and send it electronically to the customs agency.
  • SapientGenerated: This value generates the invoice from the shipment data in SAPIENT and sends it to DHL.
Note: This field is only applicable if the IsPaperlessTradeEnables field is set to true.

Allowed:
Responses
200

The shipping account was updated successfully.

401

Unauthorized

403

Forbidden

404

The shipping account was not found.

500

Internal Server Error

Updated 12 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 12 days ago

Did this page help you?