Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Accounts

Add Account

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

post/v4/shippingAccounts/dxf

Request body

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 nullable

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

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

AccountNumberstring required

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

Passwordstring required

The password associated with your DX Freight account. It is essential for securing the account and ensuring that only authorised users have access to shipping details and operations.

OriginServiceCenterstring required

A code that represents the customer account service centre from which the shipments originate.

ServiceType'1 Man' | '2 Man' required

A categorisation of the type of service used for shipments created by this shipping account. The accepted values are the following: <br /> <br />• 1 Man: This service type typically means that one crew member will handle the delivery. This is suitable for smaller, lighter items that one person can manage without assistance. <br /> <br />• 2 Man: This service type indicates that two personnel will be involved in the delivery process, which is often necessary for larger or heavier items that require additional handling or lifting.

Example request

{
  "AccountName": "AB VideoGames",
  "AccountAlias": "RM-99112347707",
  "ContactName": "John Smith",
  "ContactNumber": "0123456789",
  "AccountNumber": "010857948",
  "Password": "Password",
  "OriginServiceCenter": "99",
  "ShippingLocations": [
    {
      "ShippingLocationId": "D94E8CFD-604B-4B87-83E9-3F20CAF02837",
      "ShippingLocation": {
        "LocationAlias": "Main Warehouse",
        "Address": {
          "AddressId": "John Brown Default",
          "Line1": "Brown Cottage",
          "Line2": "10 Sky Lane",
          "Line3": "Hills End",
          "Town": "Christchurch",
          "Postcode": "TW20 0HJ",
          "County": "Surrey",
          "CountryCode": "GB",
          "What3Words": "brick.space.employ",
          "ContactPhone": "07123887422"
        },
        "Timezone": "Europe/London"
      }
    }
  ]
}

Response

The shipping account was added successfully.

ShippingAccountIdstring uuid

A unique identifier for the shipping account assigned by the system, allowing for efficient reference and management of individual accounts within the system.

ShippingLocationIdstring uuid nullable

A unique identifier assigned to the new shipping location by the system. This ID is used to distinguish between different shipping locations within the system, facilitating, referencing and operations, such as updates, deletions, or specific queries related to that location. <br /> <br />Note: This field is only populated if the details of a new location were provided in the request.