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/dpduk/{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 <br />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.

AuthorisationCodestring required

Authorisation Code. <br />A unique 8-digit identifier used as an authentication code for DPD UK. <br />This code validates or links the manifest to the correct shipper or contract. <br />
<br /><i><b>Note:</b> This identifier is included in the manifest file names.</i>

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.

Slidstring required

A customer identifier used in the barcode range and manifest files.

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.

Example request

{
  "AccountNumber": "123456789",
  "AuthorisationCode": "12345678",
  "AccountName": "AB VideoGames",
  "Slid": "1234",
  "AccountAlias": "RM-99112347707",
  "ContactName": "John Smith",
  "ContactNumber": "0123456789"
}

Response

The shipping account was updated successfully.