Login
      Contents x
      /v23.1/Addresses
      • 05 Jun 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      /v23.1/Addresses

      • Updated on 05 Jun 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Get
      /v23.1/Addresses
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      CustomerId
      integer (int32)
      ExternalCode
      string
      AddressType
      string
      Valid values[ "NotSpecified", "DefaultAddress", "AlternatePostalAddress", "AlternateInvoiceAddress", "AlternateDeliveryAddress" ]
      CancelledOnly
      string
      Valid values[ "All", "Yes", "No" ]
      DefaultDeliveryAddressOnly
      string
      Valid values[ "All", "Yes", "No" ]
      Street
      string
      AddressDescription
      string
      ZipCode
      string
      NumberPart1
      integer (int32)
      NumberPart2
      string
      City
      string
      CountryId
      integer (int32)
      AttentionOf
      string
      NumberPart1Specified
      string
      Valid values[ "All", "Yes", "No" ]
      NumberPart2Specified
      string
      Valid values[ "All", "Yes", "No" ]
      AddressDescriptionSpecified
      string
      Valid values[ "All", "Yes", "No" ]
      AttentionOfSpecified
      string
      Valid values[ "All", "Yes", "No" ]
      Offset
      integer (int32)
      RecordCount
      integer (int32)
      ItemId
      integer (int32)
      IncludeItemId
      integer (int32)
      ExcludeItemId
      integer (int32)
      ModifiedSinceDateTime
      string (date-time)
      Responses
      200

      Success

      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      organizationId
      integer (int32)
      companyId
      integer (int32)
      customerId
      integer (int32)
      externalCode
      string
      cancelled
      boolean
      Default"False"
      addressType
      string
      Valid values[ "NotSpecified", "DefaultAddress", "AlternatePostalAddress", "AlternateInvoiceAddress", "AlternateDeliveryAddress" ]
      defaultDeliveryAddress
      boolean
      Default"False"
      street
      string
      numberPart1
      integer (int32)
      numberPart2
      string
      address
      string
      addressDescription
      string
      zipCode
      string
      city
      string
      county
      string
      countryId
      integer (int32)
      attentionOf
      string
      countryDescription
      string
      countryIsoCode
      string
      countryIsoDescription
      string
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      organizationId
      integer (int32)
      companyId
      integer (int32)
      customerId
      integer (int32)
      externalCode
      string
      cancelled
      boolean
      Default"False"
      addressType
      string
      Valid values[ "NotSpecified", "DefaultAddress", "AlternatePostalAddress", "AlternateInvoiceAddress", "AlternateDeliveryAddress" ]
      defaultDeliveryAddress
      boolean
      Default"False"
      street
      string
      numberPart1
      integer (int32)
      numberPart2
      string
      address
      string
      addressDescription
      string
      zipCode
      string
      city
      string
      county
      string
      countryId
      integer (int32)
      attentionOf
      string
      countryDescription
      string
      countryIsoCode
      string
      countryIsoDescription
      string
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      organizationId
      integer (int32)
      companyId
      integer (int32)
      customerId
      integer (int32)
      externalCode
      string
      cancelled
      boolean
      Default"False"
      addressType
      string
      Valid values[ "NotSpecified", "DefaultAddress", "AlternatePostalAddress", "AlternateInvoiceAddress", "AlternateDeliveryAddress" ]
      defaultDeliveryAddress
      boolean
      Default"False"
      street
      string
      numberPart1
      integer (int32)
      numberPart2
      string
      address
      string
      addressDescription
      string
      zipCode
      string
      city
      string
      county
      string
      countryId
      integer (int32)
      attentionOf
      string
      countryDescription
      string
      countryIsoCode
      string
      countryIsoDescription
      string
      401

      Unauthorized

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      403

      Forbidden

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      404

      Not Found

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout