Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Accounts

Update Account

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

put/v4/shippingAccounts/dhlexpress/{shippingAccountId}

Path parameters

shippingAccountIdstring required

Shipping Account Identifier <br />SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you).

Request body

AccountNumberstring required

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

AccountType'Sandbox' | 'Production' 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.

AccountNamestring required

The official name of the shipping account as designated by the user or organisation, aiding in easy identification and reference of accounts. <br /> <br />Note: By default, this value is set to the customer name if not provided in the request.

AccountAliasstring required

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

ContactNamestring required

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

ContactNumberstring tel required

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

ApiKeystring required

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

ApiSecretstring required

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

IsArchiveLabelsboolean

Indicates whether DHL waybill documents are available for download as PDF. <br /> <br />Valid values are the following: <br /><ul><li>True - the way bill documents will be available for download in PDF format</li><li>False - the way bill documents will not be available for download</li></ul>

IsPaperlessTradeEnabledboolean

Indicates whether the documents are submitted electronically. <br /> <br />Valid values are the following: <br /><ul><li>True - the documents can be submitted electronically</li><li>False - the documents cannot be submitted electronically</li></ul>

PaperlessTradeInvoiceOption'DhlGenerated' | 'SapientGenerated'

Specifies the DHL Paperless Trade (PLT) invoice option for electronically transmitting commercial invoice documentation. <br /> <br />Valid values are the following: <br /><ul><li>DhlGenerated: This value allows DHL to create the invoice and send it electronically to the customs agency.</li><li>SapientGenerated: This value generates the invoice from the shipment data in SAPIENT and sends it to DHL.</li></ul><i>Note: This field is only applicable if the IsPaperlessTradeEnabled field is set to true.</i>

Example request

{
  "AccountNumber": "123456789012",
  "AccountName": "AB VideoGames",
  "AccountAlias": "RM-99112347707",
  "ContactName": "John Smith",
  "ContactNumber": "0123456789",
  "ApiKey": "dhlexpress_api_key",
  "ApiSecret": "dhlexpress_api_secret"
}

Response

The shipping account was updated successfully.