Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipping Accounts

Get Associated Location

Retrieve detailed information about a specific shipping location that is associated with a DX Freight shipping account.

get/v4/shippingAccounts/dxf/{shippingAccountId}/shippingLocations/{shippingLocationId}

Path parameters

shippingAccountIdstring 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. <br /> <br />Note: The information provided in this field and the ShippingLocationId field are being linked with each other for which the data is being returned in the response.

shippingLocationIdstring required

A unique identifier for the shipping location assigned by the system or by you (alias), allowing users to reference and manage specific locations effectively. <br /> <br />Note: The information provided in this field and the ShippingAccountId field are being linked with each other for which the data is being returned in the response.

Response

Returns the associated shipping location

ShippingLocationIdstring uuid required

A unique identifier for the shipping location assigned by the system (shippingLocationId), allowing users to reference and manage specific locations effectively.

LocationAliasstring required

A unique user-defined identifier for the shipping location, providing a convenient way to identify it, for example, Home or Warehouse.

IsDefaultLocationboolean required

A boolean value indicating whether the shipping location is set as the default for shipping operations, streamlining the selection process during shipping. <br /> <br />Note: If true, then this location is set as the default one. Otherwise, it is set to false.

Timezonestring required

The timezone in which the shipping location is located, important for scheduling and logistical considerations.

LastUpdatedDateUtcstring date-time required

A timestamp indicating the last time the shipping location details were updated, formatted in Coordinated Universal Time (UTC).

LastUpdatedBystring required

The identifier (such as a username or system account) of the individual or system that last modified the shipping location information, ensuring accountability.

Example response

{
  "LocationAlias": "Main Warehouse",
  "Timezone": "Europe/London",
  "LastUpdatedDateUtc": "2022-02-06T16:13:24.010Z",
  "LastUpdatedBy": "User A",
  "Address": {
    "Line1": "Brown Cottage",
    "Line2": "Brown Cottage",
    "Town": "Christchurch",
    "Postcode": "TW20 0HJ",
    "County": "Surrey",
    "CountryCode": "GB",
    "What3Words": "brick.space.employ",
    "ContactPhone": "07123887422"
  }
}