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. Carts

Billing address

PreviousSelected payment methodNextCoupons
  • GETquote Billing Address Management V1Get Get
  • POSTquote Billing Address Management V1Assign Post

quote Billing Address Management V1Get Get

get

Returns the billing address for a specified quote.

Path parameters
cartIdstringRequired

(Required) The cart ID.

Example: <integer>
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/carts/{cartId}/billing-address HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "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"
    }
  ]
}

quote Billing Address Management V1Assign Post

post

Assigns a specified billing address to a specified cart.

Path parameters
cartIdstringRequired

(Required) The cart ID.

Example: <integer>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"address":{"region":"laboris in dolor id","region_id":47955572,"region_code":"incididunt","country_id":"dolor ut elit eu","street":["qui ipsum do","nisi dolore"],"telephone":"ex ut dolor","postcode":"commodo tempor deserunt consectetur","city":"deserunt proident mollit","firstname":"enim voluptate","lastname":"sint amet minim","email":"dolore deserunt adipisicing","id":82020563,"company":"in irure quis Ut","fax":"reprehenderit ut pariatur nisi","middlename":"Excepteur ea nisi labore","prefix":"sunt minim magna","suffix":"elit adipisicing ad reprehenderit velit","vat_id":"dolor occaecat mollit dolore in","customer_id":-76201091,"same_as_billing":-60106476,"customer_address_id":74600693,"save_in_address_book":-42826588,"extension_attributes":{"pickup_location_code":"do dolore est nisi dolore","discounts":[{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"commodo occaecat","rule_id":-89404308},{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"in aliqua occaecat","rule_id":80814567}]},"custom_attributes":[{"attribute_code":"non","value":"exercitation est esse ut enim"},{"attribute_code":"quis aliqua id","value":"irure ut dolor nulla mollit"}]},"useForShipping":"<boolean>"}
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
POST /V1/carts/{cartId}/billing-address HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 1286

{
  "address": {
    "region": "laboris in dolor id",
    "region_id": 47955572,
    "region_code": "incididunt",
    "country_id": "dolor ut elit eu",
    "street": [
      "qui ipsum do",
      "nisi dolore"
    ],
    "telephone": "ex ut dolor",
    "postcode": "commodo tempor deserunt consectetur",
    "city": "deserunt proident mollit",
    "firstname": "enim voluptate",
    "lastname": "sint amet minim",
    "email": "dolore deserunt adipisicing",
    "id": 82020563,
    "company": "in irure quis Ut",
    "fax": "reprehenderit ut pariatur nisi",
    "middlename": "Excepteur ea nisi labore",
    "prefix": "sunt minim magna",
    "suffix": "elit adipisicing ad reprehenderit velit",
    "vat_id": "dolor occaecat mollit dolore in",
    "customer_id": -76201091,
    "same_as_billing": -60106476,
    "customer_address_id": 74600693,
    "save_in_address_book": -42826588,
    "extension_attributes": {
      "pickup_location_code": "do dolore est nisi dolore",
      "discounts": [
        {
          "discount_data": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "rule_label": "commodo occaecat",
          "rule_id": -89404308
        },
        {
          "discount_data": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          },
          "rule_label": "in aliqua occaecat",
          "rule_id": 80814567
        }
      ]
    },
    "custom_attributes": [
      {
        "attribute_code": "non",
        "value": "exercitation est esse ut enim"
      },
      {
        "attribute_code": "quis aliqua id",
        "value": "irure ut dolor nulla mollit"
      }
    ]
  },
  "useForShipping": "<boolean>"
}
-36930630