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

Me

PreviousCartsNextActivate
  • GETcustomer Customer Repository V1Get By Id Get
  • PUTcustomer Customer Repository V1Save Put

customer Customer Repository V1Get By Id Get

get

Get customer by Customer ID.

Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/customers/me HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "email": "<string>",
  "firstname": "<string>",
  "lastname": "<string>",
  "id": "<integer>",
  "group_id": "<integer>",
  "default_billing": "<string>",
  "default_shipping": "<string>",
  "confirmation": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "created_in": "<string>",
  "dob": "<string>",
  "middlename": "<string>",
  "prefix": "<string>",
  "suffix": "<string>",
  "gender": "<integer>",
  "store_id": "<integer>",
  "taxvat": "<string>",
  "website_id": "<integer>",
  "addresses": [
    {
      "id": "<integer>",
      "customer_id": "<integer>",
      "region": {
        "region_code": "<string>",
        "region": "<string>",
        "region_id": "<integer>",
        "extension_attributes": "<object>"
      },
      "region_id": "<integer>",
      "country_id": "<string>",
      "street": [
        "<string>",
        "<string>"
      ],
      "company": "<string>",
      "telephone": "<string>",
      "fax": "<string>",
      "postcode": "<string>",
      "city": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "middlename": "<string>",
      "prefix": "<string>",
      "suffix": "<string>",
      "vat_id": "<string>",
      "default_shipping": "<boolean>",
      "default_billing": "<boolean>",
      "extension_attributes": "<object>",
      "custom_attributes": [
        {
          "attribute_code": "dolore dolor Lorem",
          "value": "Excepteur eiusmod"
        },
        {
          "attribute_code": "commodo",
          "value": "ullam"
        }
      ]
    },
    {
      "id": "<integer>",
      "customer_id": "<integer>",
      "region": {
        "region_code": "<string>",
        "region": "<string>",
        "region_id": "<integer>",
        "extension_attributes": "<object>"
      },
      "region_id": "<integer>",
      "country_id": "<string>",
      "street": [
        "<string>",
        "<string>"
      ],
      "company": "<string>",
      "telephone": "<string>",
      "fax": "<string>",
      "postcode": "<string>",
      "city": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "middlename": "<string>",
      "prefix": "<string>",
      "suffix": "<string>",
      "vat_id": "<string>",
      "default_shipping": "<boolean>",
      "default_billing": "<boolean>",
      "extension_attributes": "<object>",
      "custom_attributes": [
        {
          "attribute_code": "incididunt",
          "value": "Ut"
        },
        {
          "attribute_code": "magna vol",
          "value": "adipisicing cupidatat sint officia"
        }
      ]
    }
  ],
  "disable_auto_group_change": "<integer>",
  "extension_attributes": {
    "assistance_allowed": "<integer>",
    "is_subscribed": "<boolean>",
    "amazon_id": "<string>",
    "vertex_customer_code": "<string>",
    "vertex_customer_country": "<string>"
  },
  "custom_attributes": [
    {
      "attribute_code": "eu nisi ",
      "value": "consequat sed id sit nostrud"
    },
    {
      "attribute_code": "officia in fugiat",
      "value": "ess"
    }
  ]
}

customer Customer Repository V1Save Put

put

Create or update a customer.

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"customer":{"email":"<string>","firstname":"<string>","lastname":"<string>","id":"<integer>","group_id":"<integer>","default_billing":"<string>","default_shipping":"<string>","confirmation":"<string>","created_at":"<string>","updated_at":"<string>","created_in":"<string>","dob":"<string>","middlename":"<string>","prefix":"<string>","suffix":"<string>","gender":"<integer>","store_id":"<integer>","taxvat":"<string>","website_id":"<integer>","addresses":[{"id":"<integer>","customer_id":"<integer>","region":{"region_code":"<string>","region":"<string>","region_id":"<integer>","extension_attributes":"<object>"},"region_id":"<integer>","country_id":"<string>","street":["<string>","<string>"],"company":"<string>","telephone":"<string>","fax":"<string>","postcode":"<string>","city":"<string>","firstname":"<string>","lastname":"<string>","middlename":"<string>","prefix":"<string>","suffix":"<string>","vat_id":"<string>","default_shipping":"<boolean>","default_billing":"<boolean>","extension_attributes":"<object>","custom_attributes":[{"attribute_code":"magna nulla dolor proident","value":"esse dolor sint pariatur"},{"attribute_code":"exercitation et eiusmod mollit in","value":"qui Ut anim dolor"}]},{"id":"<integer>","customer_id":"<integer>","region":{"region_code":"<string>","region":"<string>","region_id":"<integer>","extension_attributes":"<object>"},"region_id":"<integer>","country_id":"<string>","street":["<string>","<string>"],"company":"<string>","telephone":"<string>","fax":"<string>","postcode":"<string>","city":"<string>","firstname":"<string>","lastname":"<string>","middlename":"<string>","prefix":"<string>","suffix":"<string>","vat_id":"<string>","default_shipping":"<boolean>","default_billing":"<boolean>","extension_attributes":"<object>","custom_attributes":[{"attribute_code":"esse cupidatat minim","value":"est in dolor"},{"attribute_code":"velit sit","value":"dolore ullamco eiusmod"}]}],"disable_auto_group_change":"<integer>","extension_attributes":{"assistance_allowed":"<integer>","is_subscribed":"<boolean>","amazon_id":"<string>","vertex_customer_code":"<string>","vertex_customer_country":"<string>"},"custom_attributes":[{"attribute_code":"aute irure ullamco ut","value":"exercitation et"},{"attribute_code":"dolore eu reprehenderit","value":"co"}]},"passwordHash":"<string>"}
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
put
PUT /V1/customers/me HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 2323

{
  "customer": {
    "email": "<string>",
    "firstname": "<string>",
    "lastname": "<string>",
    "id": "<integer>",
    "group_id": "<integer>",
    "default_billing": "<string>",
    "default_shipping": "<string>",
    "confirmation": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "created_in": "<string>",
    "dob": "<string>",
    "middlename": "<string>",
    "prefix": "<string>",
    "suffix": "<string>",
    "gender": "<integer>",
    "store_id": "<integer>",
    "taxvat": "<string>",
    "website_id": "<integer>",
    "addresses": [
      {
        "id": "<integer>",
        "customer_id": "<integer>",
        "region": {
          "region_code": "<string>",
          "region": "<string>",
          "region_id": "<integer>",
          "extension_attributes": "<object>"
        },
        "region_id": "<integer>",
        "country_id": "<string>",
        "street": [
          "<string>",
          "<string>"
        ],
        "company": "<string>",
        "telephone": "<string>",
        "fax": "<string>",
        "postcode": "<string>",
        "city": "<string>",
        "firstname": "<string>",
        "lastname": "<string>",
        "middlename": "<string>",
        "prefix": "<string>",
        "suffix": "<string>",
        "vat_id": "<string>",
        "default_shipping": "<boolean>",
        "default_billing": "<boolean>",
        "extension_attributes": "<object>",
        "custom_attributes": [
          {
            "attribute_code": "magna nulla dolor proident",
            "value": "esse dolor sint pariatur"
          },
          {
            "attribute_code": "exercitation et eiusmod mollit in",
            "value": "qui Ut anim dolor"
          }
        ]
      },
      {
        "id": "<integer>",
        "customer_id": "<integer>",
        "region": {
          "region_code": "<string>",
          "region": "<string>",
          "region_id": "<integer>",
          "extension_attributes": "<object>"
        },
        "region_id": "<integer>",
        "country_id": "<string>",
        "street": [
          "<string>",
          "<string>"
        ],
        "company": "<string>",
        "telephone": "<string>",
        "fax": "<string>",
        "postcode": "<string>",
        "city": "<string>",
        "firstname": "<string>",
        "lastname": "<string>",
        "middlename": "<string>",
        "prefix": "<string>",
        "suffix": "<string>",
        "vat_id": "<string>",
        "default_shipping": "<boolean>",
        "default_billing": "<boolean>",
        "extension_attributes": "<object>",
        "custom_attributes": [
          {
            "attribute_code": "esse cupidatat minim",
            "value": "est in dolor"
          },
          {
            "attribute_code": "velit sit",
            "value": "dolore ullamco eiusmod"
          }
        ]
      }
    ],
    "disable_auto_group_change": "<integer>",
    "extension_attributes": {
      "assistance_allowed": "<integer>",
      "is_subscribed": "<boolean>",
      "amazon_id": "<string>",
      "vertex_customer_code": "<string>",
      "vertex_customer_country": "<string>"
    },
    "custom_attributes": [
      {
        "attribute_code": "aute irure ullamco ut",
        "value": "exercitation et"
      },
      {
        "attribute_code": "dolore eu reprehenderit",
        "value": "co"
      }
    ]
  },
  "passwordHash": "<string>"
}
{
  "email": "<string>",
  "firstname": "<string>",
  "lastname": "<string>",
  "id": "<integer>",
  "group_id": "<integer>",
  "default_billing": "<string>",
  "default_shipping": "<string>",
  "confirmation": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "created_in": "<string>",
  "dob": "<string>",
  "middlename": "<string>",
  "prefix": "<string>",
  "suffix": "<string>",
  "gender": "<integer>",
  "store_id": "<integer>",
  "taxvat": "<string>",
  "website_id": "<integer>",
  "addresses": [
    {
      "id": "<integer>",
      "customer_id": "<integer>",
      "region": {
        "region_code": "<string>",
        "region": "<string>",
        "region_id": "<integer>",
        "extension_attributes": "<object>"
      },
      "region_id": "<integer>",
      "country_id": "<string>",
      "street": [
        "<string>",
        "<string>"
      ],
      "company": "<string>",
      "telephone": "<string>",
      "fax": "<string>",
      "postcode": "<string>",
      "city": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "middlename": "<string>",
      "prefix": "<string>",
      "suffix": "<string>",
      "vat_id": "<string>",
      "default_shipping": "<boolean>",
      "default_billing": "<boolean>",
      "extension_attributes": "<object>",
      "custom_attributes": [
        {
          "attribute_code": "dolore dolor Lorem",
          "value": "Excepteur eiusmod"
        },
        {
          "attribute_code": "commodo",
          "value": "ullam"
        }
      ]
    },
    {
      "id": "<integer>",
      "customer_id": "<integer>",
      "region": {
        "region_code": "<string>",
        "region": "<string>",
        "region_id": "<integer>",
        "extension_attributes": "<object>"
      },
      "region_id": "<integer>",
      "country_id": "<string>",
      "street": [
        "<string>",
        "<string>"
      ],
      "company": "<string>",
      "telephone": "<string>",
      "fax": "<string>",
      "postcode": "<string>",
      "city": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "middlename": "<string>",
      "prefix": "<string>",
      "suffix": "<string>",
      "vat_id": "<string>",
      "default_shipping": "<boolean>",
      "default_billing": "<boolean>",
      "extension_attributes": "<object>",
      "custom_attributes": [
        {
          "attribute_code": "incididunt",
          "value": "Ut"
        },
        {
          "attribute_code": "magna vol",
          "value": "adipisicing cupidatat sint officia"
        }
      ]
    }
  ],
  "disable_auto_group_change": "<integer>",
  "extension_attributes": {
    "assistance_allowed": "<integer>",
    "is_subscribed": "<boolean>",
    "amazon_id": "<string>",
    "vertex_customer_code": "<string>",
    "vertex_customer_country": "<string>"
  },
  "custom_attributes": [
    {
      "attribute_code": "eu nisi ",
      "value": "consequat sed id sit nostrud"
    },
    {
      "attribute_code": "officia in fugiat",
      "value": "ess"
    }
  ]
}