Maginium
Admin Api
Admin Api
  • About
  • API reference
    • CustomerGroups
      • Permissions
      • Default
      • Search
    • Customers
      • Confirm
      • BillingAddress
      • ShippingAddress
      • Carts
      • Me
        • Activate
        • Password
        • BillingAddress
        • ShippingAddress
      • Search
      • Activate
      • Password
        • ResetLinkToken
      • ResetPassword
      • Validate
      • IsEmailAvailable
      • Addresses
      • Permissions
        • Readonly
    • CmsPage
      • Search
    • CmsBlock
      • Search
    • Products
      • Media
        • Types
      • Options
        • Types
      • Links
        • Types
        • Attributes
      • Websites
      • Downloadable links
        • Samples
      • Attributes
        • Options
        • Types
      • Attribute sets
        • Attributes
        • Groups
          • List
        • Sets
          • List
      • Tier prices
      • Types
      • Tier prices information
      • Tier prices delete
      • Base prices information
      • Base prices
      • Cost information
      • Cost
      • Cost delete
      • Special price information
      • Special price
      • Special price delete
      • StockItems
      • Group prices
        • Tiers
          • Price
    • Categories
      • Attributes
        • Options
      • Products
      • Move
      • List
    • StockItems
      • LowStock
        • /
    • Carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods by address id
      • Estimate shipping methods
      • Payment methods
      • Totals
      • Shipping information
      • Totals information
      • Mine
        • Items
        • Selected payment method
        • Billing address
        • Coupons
        • Payment information
        • Gift message
        • Order
        • Shipping methods
        • Estimate shipping methods by address id
        • Estimate shipping methods
        • Payment methods
        • Totals
        • Collect totals
        • Shipping information
        • Totals information
        • Set payment information
      • Licence
        • List
      • /
      • Search
    • Guest carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Payment information
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods
      • Payment methods
      • Collect totals
      • Totals
      • Shipping information
      • Totals information
      • Set payment information
    • Orders
      • Comments
      • Statuses
      • Cancel
      • Emails
      • Hold
      • Unhold
      • Items
      • Create
    • Invoices
      • Comments
      • Emails
      • Void
      • Capture
      • /
    • Creditmemo
      • Comments
      • Emails
      • Refund
    • Shipment
      • Comments
      • Emails
      • Label
      • Track
      • /
    • Transactions
    • TaxRates
      • Search
    • TaxRules
      • Search
    • TaxClasses
      • Search
    • SalesRules
      • Search
    • Coupons
      • Search
      • Generate
      • DeleteByIds
      • DeleteByCodes
    • Bulk
      • Detailed status
      • Status
      • Operation status
    • Modules
    • Search
    • Addresses
    • Products render info
    • StockStatuses
    • Creditmemos
    • Shipments
    • Amazon shipping address
    • Amazon billing address
    • Store
      • StoreViews
      • StoreGroups
      • Websites
      • StoreConfigs
    • Adobestock
      • Asset
        • Search
        • List
      • Search
    • Directory
      • Countries
      • Currency
    • Eav
      • Attribute sets
        • List
    • AttributeMetadata
      • Customer
        • Attribute
        • Form
        • Custom
      • CustomerAddress
        • Attribute
        • Form
        • Custom
    • Bundle products
      • Links
      • Options
        • Children
        • All
        • Types
        • Add
      • Children
    • Order
      • Refund
      • Ship
      • Invoice
      • Notify orders are ready for pickup
    • Configurable products
      • Children
      • Options
        • All
      • Child
      • Variation
    • Inventory
      • Sources
      • Stocks
      • Stock source links
      • Source items
      • Low quantity notification
      • Get sources assigned to stock ordered by priority
      • Stock source links delete
      • Source items delete
      • Bulk product source assign
      • Bulk product source unassign
      • Bulk product source transfer
      • Bulk partial source transfer
      • Get distance provider code
      • Get distance
      • Get latlng from address
      • Get latslngs from address
      • Export stock salable qty
      • Dump stock index data
      • Get product salable quantity
      • Is product salable
      • Are products salable
      • Is product salable for requested qty
      • Stock resolver
      • Source selection algorithm list
      • Source selection algorithm result
      • Low quantity notifications delete
      • Are product salable for requested qty
        • /
      • In store pickup
        • Pickup locations
          • /
    • Invoice
      • Refund
    • Analytics
      • Link
    • Amazon
      • Order ref
    • Applepay
      • Auth
    • Address
      • Cleanse
    • Guest address
      • Cleanse
    • Vertex address validation
      • Vertex address
    • Integration
      • Admin
        • Token
      • Customer
        • Token
Powered by GitBook
On this page
  1. API reference
  2. Vertex address validation

Vertex address

PreviousVertex address validationNextIntegration

vertex Address Validation Address Management V1Get Valid Address Post

post
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"address":{"region":"magna deserunt fugiat nulla","region_id":-54488238,"region_code":"et sint sunt aute laborum","country_id":"Lorem sunt anim id in","street":["sit magna","dolor"],"telephone":"magna ipsum labore veniam","postcode":"deserunt voluptate sed","city":"velit cupidatat","firstname":"cupidatat aute enim occaecat","lastname":"veniam reprehenderit officia","email":"exercitation dolore magna","id":90072107,"company":"ut est do","fax":"dolore commodo mollit fugiat","middlename":"occaecat ullamco do fugiat","prefix":"cupidatat anim est occaec","suffix":"aliqua dolor ut qui","vat_id":"occaecat eiusmod enim","customer_id":67214744,"same_as_billing":-74818288,"customer_address_id":37309966,"save_in_address_book":95923483,"extension_attributes":{"pickup_location_code":"tempor laborum ad sit","discounts":[{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"ad eiusmod","rule_id":-38241134},{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"dolor id","rule_id":-91251721}]},"custom_attributes":[{"attribute_code":"velit ex consequat est Duis","value":"ullamco anim commodo"},{"attribute_code":"exercitation incididunt","value":"dolor"}]}}
Responses
200
OK
application/json
Responseobject
500
Internal Server Error
application/json
post
POST /V1/vertex-address-validation/vertex-address HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 1247

{
  "address": {
    "region": "magna deserunt fugiat nulla",
    "region_id": -54488238,
    "region_code": "et sint sunt aute laborum",
    "country_id": "Lorem sunt anim id in",
    "street": [
      "sit magna",
      "dolor"
    ],
    "telephone": "magna ipsum labore veniam",
    "postcode": "deserunt voluptate sed",
    "city": "velit cupidatat",
    "firstname": "cupidatat aute enim occaecat",
    "lastname": "veniam reprehenderit officia",
    "email": "exercitation dolore magna",
    "id": 90072107,
    "company": "ut est do",
    "fax": "dolore commodo mollit fugiat",
    "middlename": "occaecat ullamco do fugiat",
    "prefix": "cupidatat anim est occaec",
    "suffix": "aliqua dolor ut qui",
    "vat_id": "occaecat eiusmod enim",
    "customer_id": 67214744,
    "same_as_billing": -74818288,
    "customer_address_id": 37309966,
    "save_in_address_book": 95923483,
    "extension_attributes": {
      "pickup_location_code": "tempor laborum ad sit",
      "discounts": [
        {
          "discount_data": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "rule_label": "ad eiusmod",
          "rule_id": -38241134
        },
        {
          "discount_data": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "rule_label": "dolor id",
          "rule_id": -91251721
        }
      ]
    },
    "custom_attributes": [
      {
        "attribute_code": "velit ex consequat est Duis",
        "value": "ullamco anim commodo"
      },
      {
        "attribute_code": "exercitation incididunt",
        "value": "dolor"
      }
    ]
  }
}
{
  "region": "id laboris p",
  "region_id": -38190946,
  "region_code": "esse officia irure dolor",
  "country_id": "sint quis enim Lorem",
  "street": [
    "voluptate ad",
    "amet in fugiat"
  ],
  "telephone": "amet est et anim",
  "postcode": "in pariatur dolore Excepteur dolor",
  "city": "aute eiusmod laboris in",
  "firstname": "elit esse sed",
  "lastname": "adipisicing commodo eu sunt Excepteur",
  "email": "sed consectetur",
  "id": -7602929,
  "company": "aliqua Excepteur",
  "fax": "nostrud dolore",
  "middlename": "incidi",
  "prefix": "nisi incididunt in sit",
  "suffix": "ut laborum",
  "vat_id": "labore magna",
  "customer_id": -80232427,
  "same_as_billing": -95304795,
  "customer_address_id": -66032884,
  "save_in_address_book": -16410352,
  "extension_attributes": {
    "pickup_location_code": "quis",
    "discounts": [
      {
        "discount_data": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "rule_label": "pari",
        "rule_id": 7049533
      },
      {
        "discount_data": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "rule_label": "in dolor mollit",
        "rule_id": -3561286
      }
    ]
  },
  "custom_attributes": [
    {
      "attribute_code": "adipisicing",
      "value": "id deserunt repreh"
    },
    {
      "attribute_code": "Duis eu aliqua",
      "value": "reprehenderit ut dolor culpa"
    }
  ]
}