DeliveryAddresses

Queryable, Introduced in version 2.18

GET https://localhost:8001/sv/001.1/api/v1/Common/DeliveryAddresses

Represents a delivery address.

GUID

CE99DAB8-D95F-4DD5-9747-AEA02084F5B7

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the address.
Addressee String The addressee of the address.

  • Max length is 100
  • Not nullable
Field1 String The first field of the address.

  • Max length is 50
Field2 String The second field of the address.

  • Max length is 50
Field3 String The third field of the address.

  • Max length is 50
Field4 String The fourth field of the address.

  • Max length is 50
Field5 String The fifth field of the address.

  • Max length is 50
Locality String The locality of the address.

  • Max length is 50
Region String The region of the address.

  • Max length is 50
PostalCode String The postal code of the address.

  • Max length is 10
AddressFormatType Int32 The format type of the address.
CountryId Int64 References Countries.
LanguageId Int64 The business key identifier of the language code.

References LanguageCodes.
FormReportTranslationGroupId Int64 The business key identifier of the form report translation group.

References FormReportTranslationGroup.
PostalCodeId Int64? The business key identifier of the postal code.

References PostalCode.

  • Obsolete since version 2.44 (Unavailable)
IsDefault Boolean Specifies if this is the default delivery address.
AddressId Int64 References Addresses.
ConsigneeReferenceId Int64? References BusinessContactReferences.
ConsigneeReferenceName String The consignee reference name of the delivery address.

  • Max length is 80
Destination String The destination of the delivery address.

  • Max length is 35
DeliveryWeekdays Int32 Specifies which days delivery can be made to the delivery address.

  • None: 0
  • Monday: 1
  • Tuesday: 2
  • Wednesday: 4
  • Thursday: 8
  • Friday: 16
  • Saturday: 32
  • Sunday: 64

  • Obsolete since version 2.18 (Can be found under Warehouses)
  • Bitmask
DeliveryInstruction String The instruction of delivery for the delivery address.

  • Max length is 80
VatRateId Int64? The business key identifier of the VatRate of the delivery address.

References VatRates.
CustomerAccountGroupId Int64? The business key identifier of the customer account group of the delivery address.

References CustomerAccountGroups.
SupplierAccountGroupId Int64? The business key identifier of the supplier account group of the delivery address.

References SupplierAccountGroup.
VatGroupId Int64? The business key identifier of the VAT group that the delivery address belongs to.

References VatGroups.
VatNumber String Vat registration number to be set on delivery address

  • Max length is 30
 Introduced in version 24.9
Warehouses DeliveryAddressWarehouseInformations[] The warehouse information that belongs to the delivery address.

  • Expandable
 Introduced in version 2.43

Example

{
  "Id": 0,
  "Addressee": null,
  "Field1": null,
  "Field2": null,
  "Field3": null,
  "Field4": null,
  "Field5": null,
  "Locality": null,
  "Region": null,
  "PostalCode": null,
  "AddressFormatType": 0,
  "CountryId": 0,
  "LanguageId": 0,
  "FormReportTranslationGroupId": 0,
  "PostalCodeId": null,
  "IsDefault": false,
  "AddressId": 0,
  "ConsigneeReferenceId": null,
  "ConsigneeReferenceName": null,
  "Destination": null,
  "DeliveryWeekdays": 0,
  "DeliveryInstruction": null,
  "VatRateId": null,
  "CustomerAccountGroupId": null,
  "SupplierAccountGroupId": null,
  "VatGroupId": null,
  "VatNumber": null,
  "Warehouses": null
}