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

Shipping information

PreviousTotalsNextTotals information

checkout Shipping Information Management V1Save Address Information Post

post
Path parameters
cartIdstringRequired

(Required)

Example: <integer>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"addressInformation":{"shipping_address":{"region":"in dolore enim reprehenderit veniam","region_id":91839285,"region_code":"tempor consequat","country_id":"nisi sit dolor do","street":["aliquip ut qui","cupidatat do dolore quis Ut"],"telephone":"dolore in","postcode":"voluptate non nostrud quis qui","city":"anim","firstname":"deserunt nulla voluptate qui","lastname":"sunt sed proident ut consequat","email":"aliqui","id":-83520718,"company":"do nisi","fax":"mollit est dolore an","middlename":"qui quis esse","prefix":"reprehenderit aute anim et sed","suffix":"sint laboris consequat in Lorem","vat_id":"amet non Lorem do id","customer_id":22516819,"same_as_billing":-41808686,"customer_address_id":-41723553,"save_in_address_book":-76211689,"extension_attributes":{"pickup_location_code":"dolore cup","discounts":[{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"minim tem","rule_id":-3973212},{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"amet Duis veniam dolore","rule_id":-97713200}]},"custom_attributes":[{"attribute_code":"nisi aute anim Excepteur","value":"sint enim"},{"attribute_code":"Ut","value":"dolor sed reprehe"}]},"shipping_method_code":"<string>","shipping_carrier_code":"<string>","billing_address":{"region":"sunt aute elit deserunt","region_id":-99061269,"region_code":"nisi irure","country_id":"incididunt","street":["Ut aliquip consectetur","Lorem"],"telephone":"occaecat ex dolor","postcode":"","city":"proident","firstname":"ipsum esse amet","lastname":"proident aliquip","email":"anim qui ullamco pariatur fugiat","id":65376456,"company":"sunt consectetur amet","fax":"aliqua","middlename":"eu in","prefix":"eiusmod nisi et","suffix":"non","vat_id":"id quis sit aute qui","customer_id":-57128946,"same_as_billing":13750028,"customer_address_id":49872984,"save_in_address_book":-54320657,"extension_attributes":{"pickup_location_code":"culpa labore officia dolor ea","discounts":[{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"labor","rule_id":40780595},{"discount_data":{"value":"<Error: Too many levels of nesting to fake this schema>"},"rule_label":"in dolor sed","rule_id":9266095}]},"custom_attributes":[{"attribute_code":"voluptate dolore ex","value":"id minim"},{"attribute_code":"e","value":"dolor pariatur id"}]},"extension_attributes":"<object>","custom_attributes":[{"attribute_code":"Excepteur reprehender","value":"aliqua proident qui"},{"attribute_code":"non ea","value":"in cillum anim id"}]}}
Responses
200
OK
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
POST /V1/carts/{cartId}/shipping-information HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 2592

{
  "addressInformation": {
    "shipping_address": {
      "region": "in dolore enim reprehenderit veniam",
      "region_id": 91839285,
      "region_code": "tempor consequat",
      "country_id": "nisi sit dolor do",
      "street": [
        "aliquip ut qui",
        "cupidatat do dolore quis Ut"
      ],
      "telephone": "dolore in",
      "postcode": "voluptate non nostrud quis qui",
      "city": "anim",
      "firstname": "deserunt nulla voluptate qui",
      "lastname": "sunt sed proident ut consequat",
      "email": "aliqui",
      "id": -83520718,
      "company": "do nisi",
      "fax": "mollit est dolore an",
      "middlename": "qui quis esse",
      "prefix": "reprehenderit aute anim et sed",
      "suffix": "sint laboris consequat in Lorem",
      "vat_id": "amet non Lorem do id",
      "customer_id": 22516819,
      "same_as_billing": -41808686,
      "customer_address_id": -41723553,
      "save_in_address_book": -76211689,
      "extension_attributes": {
        "pickup_location_code": "dolore cup",
        "discounts": [
          {
            "discount_data": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "rule_label": "minim tem",
            "rule_id": -3973212
          },
          {
            "discount_data": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "rule_label": "amet Duis veniam dolore",
            "rule_id": -97713200
          }
        ]
      },
      "custom_attributes": [
        {
          "attribute_code": "nisi aute anim Excepteur",
          "value": "sint enim"
        },
        {
          "attribute_code": "Ut",
          "value": "dolor sed reprehe"
        }
      ]
    },
    "shipping_method_code": "<string>",
    "shipping_carrier_code": "<string>",
    "billing_address": {
      "region": "sunt aute elit deserunt",
      "region_id": -99061269,
      "region_code": "nisi irure",
      "country_id": "incididunt",
      "street": [
        "Ut aliquip consectetur",
        "Lorem"
      ],
      "telephone": "occaecat ex dolor",
      "postcode": "",
      "city": "proident",
      "firstname": "ipsum esse amet",
      "lastname": "proident aliquip",
      "email": "anim qui ullamco pariatur fugiat",
      "id": 65376456,
      "company": "sunt consectetur amet",
      "fax": "aliqua",
      "middlename": "eu in",
      "prefix": "eiusmod nisi et",
      "suffix": "non",
      "vat_id": "id quis sit aute qui",
      "customer_id": -57128946,
      "same_as_billing": 13750028,
      "customer_address_id": 49872984,
      "save_in_address_book": -54320657,
      "extension_attributes": {
        "pickup_location_code": "culpa labore officia dolor ea",
        "discounts": [
          {
            "discount_data": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "rule_label": "labor",
            "rule_id": 40780595
          },
          {
            "discount_data": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "rule_label": "in dolor sed",
            "rule_id": 9266095
          }
        ]
      },
      "custom_attributes": [
        {
          "attribute_code": "voluptate dolore ex",
          "value": "id minim"
        },
        {
          "attribute_code": "e",
          "value": "dolor pariatur id"
        }
      ]
    },
    "extension_attributes": "<object>",
    "custom_attributes": [
      {
        "attribute_code": "Excepteur reprehender",
        "value": "aliqua proident qui"
      },
      {
        "attribute_code": "non ea",
        "value": "in cillum anim id"
      }
    ]
  }
}
{
  "payment_methods": [
    {
      "code": "lab",
      "title": "veniam"
    },
    {
      "code": "nulla ex",
      "title": "ut"
    }
  ],
  "totals": {
    "weee_tax_applied_amount": -50843278.77130792,
    "total_segments": [
      {
        "code": "consequat",
        "value": 34100017.0490787,
        "title": "minim fug",
        "area": "ipsum dolore",
        "extension_attributes": {
          "tax_grandtotal_details": [
            {
              "amount": 39904822.31446904,
              "rates": [
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                },
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                }
              ],
              "group_id": -45176913
            },
            {
              "amount": -87206652.940719,
              "rates": [
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                },
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                }
              ],
              "group_id": -55464525
            }
          ],
          "vertex_tax_calculation_messages": [
            "deserunt laboris consectetur",
            "ipsum"
          ]
        }
      },
      {
        "code": "laborum eu in fugiat deserunt",
        "value": 72901769.8923308,
        "title": "aute nisi laboris",
        "area": "voluptate tempor culpa",
        "extension_attributes": {
          "tax_grandtotal_details": [
            {
              "amount": -87042343.72450173,
              "rates": [
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                },
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                }
              ],
              "group_id": -20202720
            },
            {
              "amount": -36617373.35472166,
              "rates": [
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                },
                {
                  "value": "<Error: Too many levels of nesting to fake this schema>"
                }
              ],
              "group_id": 69644824
            }
          ],
          "vertex_tax_calculation_messages": [
            "cillum in laboris ex cupidatat",
            "minim pariatur"
          ]
        }
      }
    ],
    "grand_total": 71769545.55389255,
    "base_grand_total": -29055460.987636656,
    "subtotal": -10883859.73623009,
    "base_subtotal": 83673778.50525695,
    "discount_amount": 38309838.44953516,
    "base_discount_amount": -80695392.93562835,
    "subtotal_with_discount": -77988860.30208907,
    "base_subtotal_with_discount": 49744430.00639278,
    "shipping_amount": -28112062.91530493,
    "base_shipping_amount": -72198186.90314317,
    "shipping_discount_amount": -71753588.90920167,
    "base_shipping_discount_amount": -55182536.686306484,
    "tax_amount": -26820548.349576786,
    "base_tax_amount": 95212224.4056556,
    "shipping_tax_amount": 98299355.74609014,
    "base_shipping_tax_amount": 9971990.895958483,
    "subtotal_incl_tax": -41096409.60688243,
    "base_subtotal_incl_tax": -90039887.25499701,
    "shipping_incl_tax": 35852665.62099475,
    "base_shipping_incl_tax": 8078180.5852824,
    "base_currency_code": "dolor",
    "quote_currency_code": "in culpa pariatur dolore",
    "coupon_code": "id commodo",
    "items_qty": 90674444,
    "items": [
      {
        "item_id": 20726806,
        "price": -11928168.635258138,
        "base_price": 73181201.44444934,
        "qty": -58472980.68909912,
        "row_total": -49931356.37247663,
        "base_row_total": -4692937.232371494,
        "options": "irure labore pariatur commodo deserunt",
        "weee_tax_applied_amount": 83418403.09274536,
        "weee_tax_applied": "Duis",
        "row_total_with_discount": 27834139.322921425,
        "tax_amount": -4511571.079060286,
        "base_tax_amount": 73510033.34827006,
        "tax_percent": 92568196.09269562,
        "discount_amount": 11950447.532128468,
        "base_discount_amount": 86383031.40090263,
        "discount_percent": 38206781.88885629,
        "price_incl_tax": -13300127.642370626,
        "base_price_incl_tax": 27776440.545065656,
        "row_total_incl_tax": 71282181.41356713,
        "base_row_total_incl_tax": -72900082.76508732,
        "extension_attributes": {},
        "name": "aliquip"
      },
      {
        "item_id": -19154934,
        "price": -33217947.87854193,
        "base_price": 32801643.663044006,
        "qty": -9649885.416558981,
        "row_total": -62667675.09051592,
        "base_row_total": -39272381.58352395,
        "options": "in",
        "weee_tax_applied_amount": -39117497.76251696,
        "weee_tax_applied": "ad",
        "row_total_with_discount": 86061414.67630109,
        "tax_amount": 66018811.523368776,
        "base_tax_amount": -65421447.05378137,
        "tax_percent": 84908394.81482005,
        "discount_amount": 21183348.67103888,
        "base_discount_amount": 18418481.341416106,
        "discount_percent": 4139807.667550683,
        "price_incl_tax": 81355573.38086468,
        "base_price_incl_tax": 87240211.43214285,
        "row_total_incl_tax": 13361718.407631338,
        "base_row_total_incl_tax": 72672189.79503775,
        "extension_attributes": {},
        "name": "mollit officia deserunt dolore in"
      }
    ],
    "extension_attributes": {
      "coupon_label": "in occaecat nulla"
    }
  },
  "extension_attributes": {}
}