Account

An account is required to access the information. By logging into the account, user data can be retrieved, and order information can be accessed. The account feature offers two options: register first or log in to the account.

Endpoints

POST /api/v2/customer/register# RegisterPOST /api/v2/customer/auth# LoginGET /api/v2/user/profile# Retrieve User ProfilePUT /api/v2/user/reset-password# Change PasswordGET /api/v2/order/history# Retrieve Order HistoryGET /api/v2/quote/history# Retrieve Quote HistoryGET /api/v2/order/pdf# Retrieve PDF OrderGET /api/v2/quote/pdf# Retrieve Quote PDFGET /api/v2/customer-address# Retrieve User Address ListPOST /api/v2/customer-address# Create Address

Register

Users can create a new account by providing essential information.

Headers

The JSON in the request body contains raw data for email sends.

Parameters

No parameter required.

Attributes

status string

The error code which means bad request.

errors array of an object

The array which contains of a message.

email string

The error message in the email.

POST /api/v2/customer/register

curl --location 'https://appliance-api.com/api/v2/customer/register' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id' \
--data-raw '{
    "email": "developer.test@example.com",
    "password": "examplePassword123"
}'

{
  "status": "400",
  "errors": {
    "email": [
      "The email has already been registered online or from the store. Try resetting your password."
    ]
  }
}

Logging into the account is necessary to access the order history dashboard.

Headers

The JSON in the request body contains raw data for email sends.

Parameters

No parameter required.

Attributes

status string

The error code which means unauthorized.

errors array of objects

The array of error message.

message string

TThe error message.

POST /api/v2/customer/auth

curl --location 'https://appliance-api.com/api/v2/customer/auth' \
--header 'x-tenant-id: your_tenant_id' \
--header 'x-api-key: your_api_key' \
--data-raw '{
    "email": "developer.test@example.com",
    "password": "examplePassword123"
}'

{
  "status": "401",
  "errors": {
    "message": [
      "Your account is not verified yet"
    ]
  }
}

Retrieve User Profile

Profile can be retrieved along with other information such as shippings, billing details, and addresses.

Headers

The "Referer" header indicates the URL of the page making the request, informing the server about the request's source. The JSON in the request body contains raw data for email sends. "Origin" is commonly used to secure cross-origin requests.

Bearer Authorization token

To access the API, you must use the token.

Attributes

customer_code string

The unique identifier of the user.

name string

The user's name.

first_name string

The first name of the user.

last_name string

The last name of the user.

image string

The profile image of the user.

phone_number null

It is optional to include the user's phone number.

ship_name null

It is optional to include the complete name of the order receiver.

ship_first_name null

It is optional to include first name of the order receiver.

ship_last_name null

It is optional to include the last name of the order receiver.

home_number null

It is optional to include the user’s home number.

alternative_number null

It is optional to include the user’s alternative number.

email string

User's email.

address null

It is optional to include the address.

username string

The username of the user.

is_verified number

The option of verified.

date_created empty string

It is optional to include the creation date.

billing array of objects

There are lists of billing details.

name empty string

It is optional to include the name.

first_name string

User's first name.

last_name empty string

It is optional to include the last name.

email string

User's email.

address null

It is optional to include the address.

company null

It is optional to include the company.

company_name null

It is optional to include the company name.

builders_code null

It is optional to include the builders code.

phone_number null

It is optional to include the phone number.

home_number null

It is optional to include the home number.

alternative_number null

It is optional to include the alternative number.

email_alternatives empty string

It is optional to include the email alternatives.

shipping array of objects

It is optional to include the shipping information.

formatted_billing_address array of objects

It is optional to include the billing address.

name empty string

It is optional to include the name.

formatted empty string

It is optional to include the formatted.

number empty string

It is optional to include the number.

street empty string

It is optional to include the street information.

city empty string

It is optional to include the city.

suite empty string

It is optional to include the suite information.

state empty string

It is optional to include the state.

postal_code empty string

It is optional to include the postal code.

country empty string

It is optional to include the country.

formatted_shipping_address array of objects

formatted_primary_address array of objects

name empty string

It is optional to include the name.

formatted empty string

It is optional to include the formatted.

number empty string

It is optional to include the number.

street empty string

It is optional to include the street information.

city empty string

It is optional to include the city.

suite empty string

It is optional to include the suite information.

state empty string

It is optional to include the state.

postal_code empty string

It is optional to include the postal code.

country empty string

It is optional to include the country.

is_company boolean

image_url string

The url of image contains in the string.

customer_shipping_address_id null

It is optional to add the customer's shipping address.

billing_email_ccs string

primary_address null

It is optional to include the primary address.

customer_address string

GET /api/v2/user/profile

curl --location 'localhost:8000/api/v2/user/profile' \
--header 'Referer: example.com/api/api/public' \
--header 'Origin: example.com/api/api/public' \
--header 'Authorization: Bearer 63ff09feed55e9BjzDIAkStSxrGuC9bRQs4dJD1cjcgjlWJXkcGTS4IMB308w3JSkrWDh3zPz' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

{
  "customer_code": "63ff09feed55e",
  "name": "",
  "first_name": "developer.test",
  "last_name": "",
  "image": "default.jpg",
  "phone_number": null,
  "ship_name": null,
  "ship_first_name": null,
  "ship_last_name": null,
  "home_number": null,
  "alternative_number": null,
  "email": "developer.test@example.com",
  "address": null,
  "username": "developer.test@example.com",
  "is_verified": 1,
  "date_created": "2023-03-01 02:17:02",
  "billing": {
    "name": "",
    "first_name": "developer.test",
    "last_name": "",
    "email": "developer.test@example.com",
    "address": null,
    "company": null,
    "company_name": null,
    "builders_code": null,
    "phone_number": null,
    "home_number": null,
    "alternative_number": null,
    "email_alternatives": []
  },
  "shipping": {
    "ship_name": "",
    "first_name": "",
    "last_name": "",
    "email": "",
    "address": "",
    "company": "",
    "company_name": "",
    "builders_code": "",
    "phone_number": "",
    "home_number": "",
    "alternative_number": "",
    "email_alternatives": ""
  },
  "formatted_billing_address": {
    "name": "",
    "formatted": "",
    "number": "",
    "street": "",
    "city": "",
    "suite": "",
    "state": "",
    "postal_code": "",
    "country": ""
  },
  "formatted_shipping_address": [],
  "formatted_primary_address": {
    "name": "",
    "formatted": "",
    "number": "",
    "street": "",
    "city": "",
    "suite": "",
    "state": "",
    "postal_code": "",
    "country": ""
  },
  "is_company": false,
  "image_url": "http://localhost:8000/profile/default.jpg",
  "customer_shipping_address_id": null,
  "billing_email_ccs": [],
  "primary_address": null,
  "customer_address": []
}

Change Password

The option to reset the password will be available upon receiving a verification link.

Data

password string

It contains new password that the customer wants to set.

token string

The token obtained from url "/reset/token" email.

Attributes

status string

The status statement.

data string

The message about reset password.

PUT /api/v2/customer/reset-password

curl --location --request PUT 'https://appliance-api.com/api/v2/customer/reset-password' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id' \
--data-urlencode 'password=Asdw1234' \
--data-urlencode 'token=e2fQ8DGNB8XKlYnSJ5Bim4l6Jp1psRtdA6e3GWYi238lVRH8pfB63zR9P7Ac'

{
  "status": "failed",
  "data": "Reset password expired"
}

Retrieve Order History

The order history needs to be displayed for users to track their orders.

Headers

Bearer Authorization token

To access the API, you must use the token.

Parameters

page number *

The param determines the page number.

sort string *

The param determines the sorting criteria.

Attributes

order_no string

The number of user's orders.

sales_person string

The name of the salesperson.

order_date string

The date of order.

location string

The address of the delivery order.

tax string

The amount of tax patment order.

delivery_charge string

The amount of delivery fee.

store_pickup number

The option to pick up the product at the store.

subtotal string

The amount of subtotal price.

total string

The amount of total price.

order_detail array of objects

The details of the order made by the user.

order_no string

The number of user's orders.

sku string

The code of the product stock keeping unit.

image string

The url image of the product.

product_name string

The name of the product.

brand_name string

The name of the brand.

brand_image string

The url image of the brand.

is_custom boolean

Example: false

quantity number

The total of product quantity.

price string

The amount of product's price.

subtotal string

The subtotal of the payment.

total string

The total payment which should be paid.

install array of objects

The option to install.

id number

The number of user's orders.

order_no string

The number of user's orders.

date string

The date of the order.

detail_order_id number

The id number of the order.

history_id null

It is optional.

detail_return_id null

It is optional.

quantity number

The total of the product quantity which should be installed.

install_id string

The code of the product which should be installed.

install_name string

The name of the product installation.

install_price number

The price of installation.

is_custom number

The option to do custom installation.

type number

The type of installation.

version number

The version of the installation.

status number

The status of the installation.

has_delivered number

The delivery detail of installation.

created_at string

The date of install order.

updated_at string

The date of install order.

warranty empty array

There is no value of warranty.

documents array of objects

The details of order documents.

id number

The id number of the order document.

product_id number

The product id of the order.

sku string

The code of the stock keeping unit.

type number

The type number of products.

url string

The url of the document retail about the product.

local_url null

It is optional.

aws_url null

It is optional.

aws_status null

It is optional.

role string

The name of the document order.

priority number

The option of setting priority.

content_length string

The size of the content order.

created_at string

The date of the order created.

updated_at string

The date of the updated order.

deleted_at null

It is optional.

aws_full_url string

The url of document source.

link_category_name string

The slug of the product category's name.

category_name string

The name of the product category.

link_subcategory_name string

The slug of the product category's name.

subcategory_name string

The subcategory name of the product.

link_detail_category_name string

The url of the detail category name.

detail_category_name string

The name of the detail category.

payment array of objects

The list of payment information details.

payment_order_id number

The id of product payment order.

payment_date string

The date of payment.

order_no string

The number of the product order.

payment_category_id number

The id of the payment category.

payment_method_id number

The id of the payment method.

payment_intent_id null

It is optional.

card_brand null

It is optional.

payment_method string

It includes the store_credit.

amount string

It is the amount of the payment.

remaining_amount string

It is the remaining of the product price.

customer_change string

The change of customer payment.

note string

The payment none.

note2 null

It is optional.

term_length null

It is optional.

stripe_payment_url null

It is optional.

card_number null

It is optional.

is_refund number

The option to do a refund.

is_install_warranty string

The warranty install option.

is_haul_away number

The haul option.

credit_line_return number

The information about credit return.

user_id null

It is optional.

username null

It is optional.

date_created string

The date of the payment created.

date_updated string

The date of the payment updated.

deleted_at null

It is optional.

payment_details null

It is optional.

alias_name string

The alias name of user.

is_credit_line_payment boolean

The option of credit payment.

name string

The name of credit payment

payment_method_parent array of objects

The list of payment method details.

id number

The id of payment method.

payment_category_id number

The id of the payment category.

name string

The name of the credit store.

status number

The status of the payment.

show number

threshold_status number

threshold_amount number

order number

created_at null

It is optional.

updated_at string

The date of the updated order.

alias_name string

The alias name of user.

payment_category array of objects

id number

The id of payment based on category.

name string

The name of credit payment.

description null

It is optional.

created_at null

It is optional.

updated_at string

The date of the updated order.

online number

meta array of objects

current_page number

The current page number which is shown.

first_page_url string

The url for the first page.

from number

Starting page number.

last_page number

The last page existed.

last_page_url string

The url page of the last page.

next_page_url null

It is optional.

path string

The url path of order page.

per_page number

The number of contents showing in the page.

prev_page_url null

It is optional.

to number

The destination of the previous page.

total number

The total number of the page.

GET /api/v2/order/history

curl --location 'https://appliance-api.com/api/v2/order/history/5f00cadbd42e5?page=1&sort=newest' \
--header 'Authorization: Bearer 5f00cadbd42e5Z4MgOKxphsNmIy7ibGSpuplj7l1uwF6t7WeKmhc2X3dG47KsE8lQB8aAESoQ' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

{
  "data": [
    {
      "order_no": "10-10311",
      "sales_person": "John Doe",
      "order_date": "07/06/2020 14:23",
      "location": "14755 Manchester Rd, Ballwin, MO 63011",
      "tax": "78.64",
      "delivery_charge": "0.00",
      "store_pickup": 0,
      "subtotal": "899.99",
      "total": "1018.63",
      "order_detail": [
        {
          "order_no": "10-10311",
          "sku": "MVW7232HC",
          "image": "https://dq5w511paquwy.cloudfront.net/assets/images/MVW7232HC-17949320.webp",
          "product_name": "Smart Top Load Washer with Extra Power Button - 5.3 cu. ft.",
          "brand_name": "Maytag",
          "brand_image": "https://dq5w511paquwy.cloudfront.net/assets/brands/255905-maytag.webp",
          "is_custom": false,
          "quantity": 1,
          "price": "899.99",
          "subtotal": "899.99",
          "total": "939.99",
          "install": [
            {
              "id": 7234,
              "order_no": "10-10311",
              "date": "2020-07-06",
              "detail_order_id": 14352,
              "history_id": null,
              "detail_return_id": null,
              "quantity": 1,
              "install_id": "5db8f0b9b5db5",
              "install_name": "Washer Standard Install (stainless hoses)",
              "install_price": 40,
              "is_custom": 0,
              "type": 1,
              "version": 1,
              "status": 1,
              "has_delivered": 1,
              "created_at": "2022-03-13 23:41:10",
              "updated_at": "2023-01-04 21:15:31"
            }
          ],
          "warranty": [],
          "documents": [
            {
              "id": 77001571,
              "product_id": 238,
              "sku": "MVW7232HC",
              "type": 1,
              "url": "https://www.whirlpool.com/content/dam/global/documents/202003/dimension-guide-w11412609-revb.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Dimension Guide",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001572,
              "product_id": 238,
              "sku": "MVW7232HC",
              "type": 1,
              "url": "https://whirlpool.com/content/dam/global/documents/202304/energy-guide-w11643605-revB.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Energy Guide",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001573,
              "product_id": 238,
              "sku": "MVW7232HC",
              "type": 1,
              "url": "https://www.whirlpool.com/content/dam/global/documents/201910/owners-manual-w11197727-reva.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Owners Manual",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001574,
              "product_id": 238,
              "sku": "MVW7232HC",
              "type": 1,
              "url": "https://whirlpool.com/content/dam/global/documents/202303/warranty-w11655301-revA.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Warranty",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            }
          ],
          "link_category_name": "laundry",
          "category_name": "Laundry",
          "link_subcategory_name": "washers",
          "subcategory_name": "Washers",
          "link_detail_category_name": "top-load-washers",
          "detail_category_name": "Top Load Washers"
        }
      ],
      "payment": [
        {
          "payment_order_id": 9968,
          "payment_date": "07/06/2020",
          "order_no": "10-10311",
          "payment_category_id": 4,
          "payment_method_id": 11,
          "payment_intent_id": null,
          "card_brand": null,
          "payment_method": "store_credit",
          "amount": "1018.63",
          "remaining_amount": "1018.63",
          "customer_change": "0.00",
          "note": "10-10310",
          "note2": null,
          "term_length": null,
          "stripe_payment_url": null,
          "card_number": null,
          "is_refund": 0,
          "is_install_warranty": "0",
          "is_haul_away": 0,
          "credit_line_return": 0,
          "user_id": null,
          "username": null,
          "date_created": "2020-07-06 14:23:30",
          "date_updated": "2022-03-17 00:27:31",
          "deleted_at": null,
          "payment_details": null,
          "alias_name": "Store Credit",
          "is_credit_line_payment": false,
          "name": "Store Credit",
          "payment_method_parent": {
            "id": 11,
            "payment_category_id": 4,
            "name": "Store Credit",
            "status": 1,
            "show": 1,
            "threshold_status": 0,
            "threshold_amount": 0,
            "order": 1,
            "created_at": null,
            "updated_at": "2023-02-08 22:13:58",
            "alias_name": "Store Credit - Store Credit",
            "payment_category": {
              "id": 4,
              "name": "Store Credit",
              "description": null,
              "created_at": null,
              "updated_at": "2023-02-08 22:13:58"
            }
          }
        }
      ],
      "online": 0
    },
    {
      "order_no": "10-10310",
      "sales_person": "John Doe",
      "order_date": "07/06/2020 14:20",
      "location": "14755 Manchester Rd, Ballwin, MO 63011",
      "tax": "157.28",
      "delivery_charge": "0.00",
      "store_pickup": 0,
      "subtotal": "1799.98",
      "total": "2022.26",
      "order_detail": [
        {
          "order_no": "10-10310",
          "sku": "MVW7230HC",
          "image": "https://dq5w511paquwy.cloudfront.net/assets/images/MVW7230HC-17949326.webp",
          "product_name": "Smart Top Load Washer with Extra Power Button - 5.2 cu. ft.",
          "brand_name": "Maytag",
          "brand_image": "https://dq5w511paquwy.cloudfront.net/assets/brands/255905-maytag.webp",
          "is_custom": false,
          "quantity": 1,
          "price": "899.99",
          "subtotal": "899.99",
          "total": "939.99",
          "install": [
            {
              "id": 7230,
              "order_no": "10-10310",
              "date": "2020-07-06",
              "detail_order_id": 14348,
              "history_id": null,
              "detail_return_id": null,
              "quantity": 1,
              "install_id": "5db8f0b9b5db5",
              "install_name": "Washer Standard Install (stainless hoses)",
              "install_price": 40,
              "is_custom": 0,
              "type": 1,
              "version": 1,
              "status": 1,
              "has_delivered": 0,
              "created_at": "2022-03-13 23:41:10",
              "updated_at": "2022-06-23 03:13:17"
            }
          ],
          "warranty": [],
          "documents": [
            {
              "id": 77001575,
              "product_id": 239,
              "sku": "MVW7230HC",
              "type": 1,
              "url": "https://www.whirlpool.com/content/dam/global/documents/202003/dimension-guide-w11412610-revb.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Dimension Guide",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001576,
              "product_id": 239,
              "sku": "MVW7230HC",
              "type": 1,
              "url": "https://whirlpool.com/content/dam/global/documents/202304/energy-guide-w11643604-revB.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Energy Guide",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001577,
              "product_id": 239,
              "sku": "MVW7230HC",
              "type": 1,
              "url": "https://www.whirlpool.com/content/dam/global/documents/201910/owners-manual-w11197727-reva.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Owners Manual",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001578,
              "product_id": 239,
              "sku": "MVW7230HC",
              "type": 1,
              "url": "https://whirlpool.com/content/dam/global/documents/202303/warranty-w11655301-revA.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Warranty",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            }
          ],
          "link_category_name": "laundry",
          "category_name": "Laundry",
          "link_subcategory_name": "washers",
          "subcategory_name": "Washers",
          "link_detail_category_name": "top-load-washers",
          "detail_category_name": "Top Load Washers"
        },
        {
          "order_no": "10-10310",
          "sku": "MED7230HC",
          "image": "https://dq5w511paquwy.cloudfront.net/assets/images/MED7230HC-18395160.webp",
          "product_name": "Smart Top Load Electric Dryer with Extra Power Button - 7.4 cu. ft.",
          "brand_name": "Maytag",
          "brand_image": "https://dq5w511paquwy.cloudfront.net/assets/brands/255905-maytag.webp",
          "is_custom": false,
          "quantity": 1,
          "price": "899.99",
          "subtotal": "899.99",
          "total": "924.99",
          "install": [
            {
              "id": 7231,
              "order_no": "10-10310",
              "date": "2020-07-06",
              "detail_order_id": 14349,
              "history_id": null,
              "detail_return_id": null,
              "quantity": 1,
              "install_id": "5db8f066a542a",
              "install_name": "Electric Dryer Standard Install",
              "install_price": 25,
              "is_custom": 0,
              "type": 1,
              "version": 1,
              "status": 1,
              "has_delivered": 1,
              "created_at": "2022-03-13 23:41:10",
              "updated_at": "2023-01-04 21:15:31"
            }
          ],
          "warranty": [],
          "documents": [
            {
              "id": 77001678,
              "product_id": 260,
              "sku": "MED7230HC",
              "type": 1,
              "url": "https://www.whirlpool.com/content/dam/global/documents/202003/dimension-guide-w11412670-revb.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Dimension Guide",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:24",
              "updated_at": "2023-08-30 22:17:24",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001679,
              "product_id": 260,
              "sku": "MED7230HC",
              "type": 1,
              "url": "https://whirlpool.com/content/dam/global/documents/202108/owners-manual-w11555818-reva.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Owners Manual",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:24",
              "updated_at": "2023-08-30 22:17:24",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001680,
              "product_id": 260,
              "sku": "MED7230HC",
              "type": 1,
              "url": "https://maytag.com/content/dam/global/documents/201910/quick-reference-sheet-w11175228-revb.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Quick Reference Sheet",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:24",
              "updated_at": "2023-08-30 22:17:24",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001681,
              "product_id": 260,
              "sku": "MED7230HC",
              "type": 1,
              "url": "https://www.whirlpool.com/content/dam/global/documents/201912/warranty-w11349450-reva.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Warranty",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:24",
              "updated_at": "2023-08-30 22:17:24",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            }
          ],
          "link_category_name": "laundry",
          "category_name": "Laundry",
          "link_subcategory_name": "dryers",
          "subcategory_name": "Dryers",
          "link_detail_category_name": "top-load-matching-dryers",
          "detail_category_name": "Top Load Matching Dryers"
        }
      ],
      "payment": [
        {
          "payment_order_id": 9966,
          "payment_date": "07/06/2020",
          "order_no": "10-10310",
          "payment_category_id": 3,
          "payment_method_id": 6,
          "payment_intent_id": null,
          "card_brand": null,
          "payment_method": "credit_card",
          "amount": "2022.26",
          "remaining_amount": "1003.63",
          "customer_change": "0.00",
          "note": "006358",
          "note2": "8077",
          "term_length": null,
          "stripe_payment_url": null,
          "card_number": null,
          "is_refund": 0,
          "is_install_warranty": "0",
          "is_haul_away": 0,
          "credit_line_return": 0,
          "user_id": null,
          "username": null,
          "date_created": "2020-07-06 14:20:33",
          "date_updated": "2023-06-14 22:58:16",
          "deleted_at": null,
          "payment_details": null,
          "alias_name": "Credit Card",
          "is_credit_line_payment": false,
          "name": "Credit Card",
          "payment_method_parent": {
            "id": 6,
            "payment_category_id": 3,
            "name": "Credit Card",
            "status": 1,
            "show": 1,
            "threshold_status": 0,
            "threshold_amount": 0,
            "order": 1,
            "created_at": null,
            "updated_at": "2023-06-13 07:11:37",
            "alias_name": "Manual Entry - Credit Card",
            "payment_category": {
              "id": 3,
              "name": "Manual Entry",
              "description": null,
              "created_at": null,
              "updated_at": null
            }
          }
        }
      ],
      "online": 0
    }
  ],
  "meta": {
    "current_page": 1,
    "first_page_url": "http://localhost:8000/api/v2/order/history/5f00cadbd42e5?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://localhost:8000/api/v2/order/history/5f00cadbd42e5?page=1",
    "next_page_url": null,
    "path": "http://localhost:8000/api/v2/order/history/5f00cadbd42e5",
    "per_page": 10,
    "prev_page_url": null,
    "to": 2,
    "total": 2
  }
}

Retrieve Quote History

Before users place an order, they can create a quote instead. By generating a quote, users can determine the items to purchase. This API retrieves Quote History from the quote data entered by users.

Headers

Bearer Authorization token

To access the API, you must use the token.

Parameters

page number *

The param determines the page number destination.

sort string *

The param identifies the sorting type.

q number

The param identifies the query.

Attributes

order_no string

The number of user’s orders.

sales_person string

The name of salesperson.

order_date string

The date of order.

location null

It is optional to input the address.

tax string

The amount of tax payment order.

delivery_charge string

The amount of delivery fee.

store_pickup number

The option to pick up the product at the store.

subtotal string

The amount of subtotal price.

total string

The amount of total price.

order_detail array of objects

The details of the order made by the user.

order_no string

The number of user’s orders.

sku string

The code of the product stock keeping unit.

image string

The url image of the product.

product_name string

The name of the product.

brand_name string

The name of the brand.

brand_image null

It is optional to input the url image of the brand.

is_custom boolean

The option of customization.

quantity number

The total of product quantity.

price string

The amount of product's price.

subtotal string

The subtotal of the payment.

total string

The total payment which should be paid.

install array of objects

The option to install.

id number

The id of the product installation option.

quote_no string

The number of user's orders.

detail_return_id null

It is optional.

quantity number

The total of the product quantity which should be installed.

install_id string

The code of the product which should be installed.

install_name string

The name of the product installation.

install_price number

The price of installation.

is_custom number

The option to do custom installation.

created_at string

The date of install order.

updated_at string

The date of install order.

warranty empty array

There is no value of warranty.

documents empty array

There is no value of warranty.

link_category_name string

The slug of the product category's name.

category_name string

The name of the product category.

link_subcategory_name string

The slug of the product's category name.

subcategory_name string

The subcategory name of the product.

link_detail_category_name string

The link of details from category name.

detail_category_name string

The name of the detail category.

payment array of objects

The list of payment information details.

payment_order_id number

The id of product payment order.

payment_date string

The date of payment.

order_no string

The number of the product.

payment_category_id number

The id of the payment category.

payment_method_id number

The id of the payment method.

payment_intent_id null

It is optional.

card_brand null

It is optional.

payment_method string

It includes the store_credit?

product_name string

The name of the product.

amount string

it is the amount of the payment.

remaining_amount string

It is the remaining of the product price.

customer_change string

The change of customer payment.

note string

The payment note.

note2 null

It is optional.

term_length null

It is optional.

stripe_payment_url null

It is optional.

is_refund number

The option to do a refund.

is_install_warranty string

The warranty install option.

is_haul_away number

The option to haul away.

credit_line_return number

The information about credit return.

user_id null

It is optional.

username null

It is optional.

date_created string

The date of the payment created.

date_updated string

The date of the updated payment.

deleted_at null

It is optional.

payment_details null

It is optional.

alias_name string

The alias name of user.

is_credit_line_payment boolean

The option of credit payment.

name string

The name of credit payment.

payment_method_parent array of objects

The list of payment method details.

id number

The id of payment method.

payment_category_id number

The id of payment ctegory.

name string

The name of the credit score.

status number

The status of the payment.

show number

threshold_status number

threshold_amount number

order number

created_at null

It is optional.

updated_at string

The date of the updated order.

alias_name string

The alias name of user.

payment_category array of objects

id number

The id of payment based on category.

name string

The name of credit payment.

description null

It is optional.

created_at null

It is optional.

updated_at string

The date of the updated order.

online number

meta array of objects

current_page number

The current page number which is shown.

first_page_url string

The url for the first page.

id number

The id of payment based on category.

from number

Starting page number.

last_page number

The last page existed.

last_page_url string

The url page of the last page.

next_page_url null

It is optional.

path string

The url path of the order page.

per_page number

The number of contents showing in the page.

prev_page_url null

It is optional.

to number

The destination of the previous page.

total number

The total number of the page.

GET /api/v2/quote/history

curl --location 'https://appliance-api.com/api/v2/quote/history/5f00cadbd42e5?page=1&sort=newest' \
--header 'Authorization: Bearer 5f00cadbd42e5Z4MgOKxphsNmIy7ibGSpuplj7l1uwF6t7WeKmhc2X3dG47KsE8lQB8aAESoQ' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

{
  "data": [
    {
      "order_no": "10-10311",
      "sales_person": "John Doe",
      "order_date": "07/06/2020 14:22",
      "location": null,
      "tax": "78.64",
      "delivery_charge": "0.00",
      "store_pickup": 0,
      "subtotal": "899.99",
      "total": "1018.63",
      "order_detail": [
        {
          "order_no": "10-10311",
          "sku": "MVW7232HC",
          "image": "http://localhost:8000/image/no-image.png",
          "product_name": "5.3 CU FT SMART TOP LOAD WASHER",
          "brand_name": "Maytag",
          "brand_image": null,
          "is_custom": false,
          "quantity": 1,
          "price": "899.99",
          "subtotal": "899.99",
          "total": "939.99",
          "install": [
            {
              "id": 7524,
              "quote_no": "10-10311",
              "detail_quote_id": 156123,
              "quantity": 1,
              "install_id": "5db8f0b9b5db5",
              "install_name": "Washer Standard Install (stainless hoses)",
              "install_price": 40,
              "is_custom": 0,
              "created_at": "2022-03-13 23:41:50",
              "updated_at": "2022-03-13 23:41:50"
            }
          ],
          "warranty": [],
          "documents": [],
          "link_category_name": "laundry",
          "category_name": "Laundry",
          "link_subcategory_name": "washers",
          "subcategory_name": "Washers",
          "link_detail_category_name": "top-load-washers",
          "detail_category_name": "Top Load Washers"
        }
      ],
      "payment": [
        {
          "payment_order_id": 9968,
          "payment_date": "07/06/2020",
          "order_no": "10-10311",
          "payment_category_id": 4,
          "payment_method_id": 11,
          "payment_intent_id": null,
          "card_brand": null,
          "payment_method": "store_credit",
          "amount": "1018.63",
          "remaining_amount": "1018.63",
          "customer_change": "0.00",
          "note": "10-10310",
          "note2": null,
          "term_length": null,
          "stripe_payment_url": null,
          "card_number": null,
          "is_refund": 0,
          "is_install_warranty": "0",
          "is_haul_away": 0,
          "credit_line_return": 0,
          "user_id": null,
          "username": null,
          "date_created": "2020-07-06 14:23:30",
          "date_updated": "2022-03-17 00:27:31",
          "deleted_at": null,
          "payment_details": null,
          "alias_name": "Store Credit",
          "is_credit_line_payment": false,
          "name": "Store Credit",
          "payment_method_parent": {
            "id": 11,
            "payment_category_id": 4,
            "name": "Store Credit",
            "status": 1,
            "show": 1,
            "threshold_status": 0,
            "threshold_amount": 0,
            "order": 1,
            "created_at": null,
            "updated_at": "2023-02-08 22:13:58",
            "alias_name": "Store Credit - Store Credit",
            "payment_category": {
              "id": 4,
              "name": "Store Credit",
              "description": null,
              "created_at": null,
              "updated_at": "2023-02-08 22:13:58"
            }
          }
        }
      ],
      "online": "1"
    },
    {
      "order_no": "10-10310",
      "sales_person": "John Doe",
      "order_date": "07/06/2020 14:17",
      "location": "14755 Manchester Rd, Ballwin, MO 63011",
      "tax": "157.28",
      "delivery_charge": "0.00",
      "store_pickup": 0,
      "subtotal": "1799.98",
      "total": "2022.26",
      "order_detail": [
        {
          "order_no": "10-10310",
          "sku": "MVW7230HC",
          "image": "http://localhost:8000/image/no-image.png",
          "product_name": "5.2 CU FT SMART TOP LOAD WASHER",
          "brand_name": "Maytag",
          "brand_image": null,
          "is_custom": false,
          "quantity": 1,
          "price": "899.99",
          "subtotal": "899.99",
          "total": "939.99",
          "install": [
            {
              "id": 7520,
              "quote_no": "10-10310",
              "detail_quote_id": 156115,
              "quantity": 1,
              "install_id": "5db8f0b9b5db5",
              "install_name": "Washer Standard Install (stainless hoses)",
              "install_price": 40,
              "is_custom": 0,
              "created_at": "2022-03-13 23:41:50",
              "updated_at": "2022-03-13 23:41:50"
            }
          ],
          "warranty": [],
          "documents": [],
          "link_category_name": "laundry",
          "category_name": "Laundry",
          "link_subcategory_name": "washers",
          "subcategory_name": "Washers",
          "link_detail_category_name": "top-load-washers",
          "detail_category_name": "Top Load Washers"
        },
        {
          "order_no": "10-10310",
          "sku": "MED7230HC",
          "image": "http://localhost:8000/image/no-image.png",
          "product_name": "7.4 CU FT SMART ELECTRIC DRYER",
          "brand_name": "Maytag",
          "brand_image": null,
          "is_custom": false,
          "quantity": 1,
          "price": "899.99",
          "subtotal": "899.99",
          "total": "924.99",
          "install": [
            {
              "id": 7521,
              "quote_no": "10-10310",
              "detail_quote_id": 156116,
              "quantity": 1,
              "install_id": "5db8f066a542a",
              "install_name": "Electric Dryer Standard Install",
              "install_price": 25,
              "is_custom": 0,
              "created_at": "2022-03-13 23:41:50",
              "updated_at": "2022-03-13 23:41:50"
            }
          ],
          "warranty": [],
          "documents": [],
          "link_category_name": "laundry",
          "category_name": "Laundry",
          "link_subcategory_name": "dryers",
          "subcategory_name": "Dryers",
          "link_detail_category_name": "top-load-matching-dryers",
          "detail_category_name": "Top Load Matching Dryers"
        }
      ],
      "payment": [
        {
          "payment_order_id": 9966,
          "payment_date": "07/06/2020",
          "order_no": "10-10310",
          "payment_category_id": 3,
          "payment_method_id": 6,
          "payment_intent_id": null,
          "card_brand": null,
          "payment_method": "credit_card",
          "amount": "2022.26",
          "remaining_amount": "1003.63",
          "customer_change": "0.00",
          "note": "006358",
          "note2": "8077",
          "term_length": null,
          "stripe_payment_url": null,
          "card_number": null,
          "is_refund": 0,
          "is_install_warranty": "0",
          "is_haul_away": 0,
          "credit_line_return": 0,
          "user_id": null,
          "username": null,
          "date_created": "2020-07-06 14:20:33",
          "date_updated": "2023-06-14 22:58:16",
          "deleted_at": null,
          "payment_details": null,
          "alias_name": "Credit Card",
          "is_credit_line_payment": false,
          "name": "Credit Card",
          "payment_method_parent": {
            "id": 6,
            "payment_category_id": 3,
            "name": "Credit Card",
            "status": 1,
            "show": 1,
            "threshold_status": 0,
            "threshold_amount": 0,
            "order": 1,
            "created_at": null,
            "updated_at": "2023-06-13 07:11:37",
            "alias_name": "Manual Entry - Credit Card",
            "payment_category": {
              "id": 3,
              "name": "Manual Entry",
              "description": null,
              "created_at": null,
              "updated_at": null
            }
          }
        }
      ],
      "online": "0"
    },
    {
      "order_no": "10-10195",
      "sales_person": "Josh Reagan",
      "order_date": "07/04/2020 13:30",
      "location": null,
      "tax": "0.00",
      "delivery_charge": "0.00",
      "store_pickup": 0,
      "subtotal": "0.00",
      "total": "0.00",
      "order_detail": [
        {
          "order_no": "10-10195",
          "sku": "MVW7232HC",
          "image": "https://dq5w511paquwy.cloudfront.net/assets/images/MVW7232HC-17949320.webp",
          "product_name": "SMART TOP LOAD WASHER WITH EXTRA POWER BUTTON - 5.3 CU. FT.",
          "brand_name": "Maytag",
          "brand_image": "https://dq5w511paquwy.cloudfront.net/assets/brands/255905-maytag.webp",
          "is_custom": false,
          "quantity": 1,
          "price": "0.00",
          "subtotal": "0.00",
          "total": "0.00",
          "install": [],
          "warranty": [],
          "documents": [
            {
              "id": 77001571,
              "product_id": 238,
              "sku": "MVW7232HC",
              "type": 1,
              "url": "https://www.whirlpool.com/content/dam/global/documents/202003/dimension-guide-w11412609-revb.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Dimension Guide",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001572,
              "product_id": 238,
              "sku": "MVW7232HC",
              "type": 1,
              "url": "https://whirlpool.com/content/dam/global/documents/202304/energy-guide-w11643605-revB.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Energy Guide",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001573,
              "product_id": 238,
              "sku": "MVW7232HC",
              "type": 1,
              "url": "https://www.whirlpool.com/content/dam/global/documents/201910/owners-manual-w11197727-reva.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Owners Manual",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001574,
              "product_id": 238,
              "sku": "MVW7232HC",
              "type": 1,
              "url": "https://whirlpool.com/content/dam/global/documents/202303/warranty-w11655301-revA.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Warranty",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:23",
              "updated_at": "2023-08-30 22:17:23",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            }
          ],
          "link_category_name": "laundry",
          "category_name": "Laundry",
          "link_subcategory_name": "washers",
          "subcategory_name": "Washers",
          "link_detail_category_name": "top-load-washers",
          "detail_category_name": "Top Load Washers"
        },
        {
          "order_no": "10-10195",
          "sku": "MED7230HC",
          "image": "https://dq5w511paquwy.cloudfront.net/assets/images/MED7230HC-18395160.webp",
          "product_name": "SMART TOP LOAD ELECTRIC DRYER WITH EXTRA POWER BUTTON - 7.4 CU. FT.",
          "brand_name": "Maytag",
          "brand_image": "https://dq5w511paquwy.cloudfront.net/assets/brands/255905-maytag.webp",
          "is_custom": false,
          "quantity": 1,
          "price": "0.00",
          "subtotal": "0.00",
          "total": "0.00",
          "install": [],
          "warranty": [],
          "documents": [
            {
              "id": 77001678,
              "product_id": 260,
              "sku": "MED7230HC",
              "type": 1,
              "url": "https://www.whirlpool.com/content/dam/global/documents/202003/dimension-guide-w11412670-revb.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Dimension Guide",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:24",
              "updated_at": "2023-08-30 22:17:24",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001679,
              "product_id": 260,
              "sku": "MED7230HC",
              "type": 1,
              "url": "https://whirlpool.com/content/dam/global/documents/202108/owners-manual-w11555818-reva.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Owners Manual",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:24",
              "updated_at": "2023-08-30 22:17:24",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001680,
              "product_id": 260,
              "sku": "MED7230HC",
              "type": 1,
              "url": "https://maytag.com/content/dam/global/documents/201910/quick-reference-sheet-w11175228-revb.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Quick Reference Sheet",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:24",
              "updated_at": "2023-08-30 22:17:24",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            },
            {
              "id": 77001681,
              "product_id": 260,
              "sku": "MED7230HC",
              "type": 1,
              "url": "https://www.whirlpool.com/content/dam/global/documents/201912/warranty-w11349450-reva.pdf",
              "local_url": null,
              "aws_url": null,
              "aws_status": null,
              "role": "Warranty",
              "priority": 0,
              "content_length": "0 kb",
              "created_at": "2023-08-30 22:17:24",
              "updated_at": "2023-08-30 22:17:24",
              "deleted_at": null,
              "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
            }
          ],
          "link_category_name": "laundry",
          "category_name": "Laundry",
          "link_subcategory_name": "dryers",
          "subcategory_name": "Dryers",
          "link_detail_category_name": "top-load-matching-dryers",
          "detail_category_name": "Top Load Matching Dryers"
        }
      ],
      "payment": [],
      "online": "1"
    }
  ],
  "meta": {
    "current_page": 1,
    "first_page_url": "http://localhost:8000/api/v2/quote/history/5f00cadbd42e5?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://localhost:8000/api/v2/quote/history/5f00cadbd42e5?page=1",
    "next_page_url": null,
    "path": "http://localhost:8000/api/v2/quote/history/5f00cadbd42e5",
    "per_page": 10,
    "prev_page_url": null,
    "to": 3,
    "total": 3
  }
}

Retrieve PDF Order

The order will be converted into a PDF file, and other files can also be opened in PDF format.

Headers

Bearer Authorization token

To access the API, you must use the token.

Parameters

No parameter required.

Attributes

url string

The url image of the order invoice.

GET /api/v2/order/pdf

curl --location 'https://appliance-api.com/api/v2/order/pdf/10-10310' \
--header 'Authorization: Bearer 5f00cadbd42e5Z4MgOKxphsNmIy7ibGSpuplj7l1uwF6t7WeKmhc2X3dG47KsE8lQB8aAESoQ' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

{
  "url": "http://localhost:8000/storage/example/order/order-1700625286-655d7b8648ffa-10-10310.pdf"
}

Retrieve Quote PDF

The quote result will be converted into a PDF file, and other files can also be opened in PDF format.

Headers

Bearer Authorization token

To access the API, you must use the token.

Parameters

No parameter required.

Attributes

url string

The url image of the quote invoice.

GET /api/v2/quote/pdf

curl --location 'https://appliance-api.com/api/v2/quote/pdf/49-93652' \
--header 'Referer: example.com/api/api/public' \
--header 'Origin: example.com/api/api/public' \
--header 'Authorization: Bearer K59y88HbeIPObdGbSTr93HaYI9HIWfL56HCupP4Hp4KtqaxB0ilcC3hfb60a' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

{
  "url": "example.com/api/api/public"
}

Retrieve User Address List

When users want to check out their orders, they should input their address, which can be under the name of an individual or a company.

Parameters

No parameter required.

Attributes

first_name string

It will show the first name of the user.

last_name string

It will show the last name of the user.

is_company number

The option as the company or individual.

company_name null

It is optional to include the company's name.

phone_number string

It shows the phone number.

email string

It shows the e-mail of the user.

street_address null

It is optional to input the address.

suite null

It is optional to input the suite details.

city null

It is optional to input the city details.

state null

It is optional to input the state details.

zip_code number

The zip code of the area.

GET /api/v2/customer-address

curl --location 'https://appliance-api.com/api/v2/customer-address/5efd7ec44bc4a/list' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

{
  "code": "200",
  "message": "Success",
  "data": [
    {
      "first_name": "Developer",
      "last_name": "Test",
      "is_company": 0,
      "company_name": null,
      "phone_number": "1234444444",
      "email": "john.doe@gmail.com",
      "street_address": null,
      "suite": null,
      "city": null,
      "state": null,
      "zip_code": "63011"
    }
  ],
  "meta": null,
  "errors": null
}

Create Address

Users can create their own addresses or add additional addresses.

Headers

The JSON containing first name, last name, company name, street address, suite, city, state, zip code, phone number, and email sends raw data in the request body. The server accepts JSON-formatted responses.

Parameters

No parameter required.

Attributes

message string

The notification message about the register process.

code string

The code of account verification which indicates the successful result.

data null

It is optional.

meta null

It is optional.

errors null

It is optional.

POST /api/v2/customer-address/

curl --location 'https://appliance-api.com/api/v2/customer-address/5e0e143cbbcd6' \
--header 'Accept: application/json' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id' \
--data-raw '{
    "first_name" : "John",
    "last_name" : "Die",
    "company_name" : "",
    "street_address": "14751 Manchester Rd, Ballwin, MO 63011, USA",
    "suite": "Suite",
    "city": "Ballwin",
    "state": "Missouri",
    "zip_code": "63011",
    "phone_number": "",
    "email": "john.doe@devixel.com"
}'

{
  "code": "200",
  "message": "Success",
  "data": null,
  "meta": null,
  "errors": null
}

Account

Register​

Headers​

Parameters​

Attributes​

Login​

Headers​

Parameters​

Attributes​

Retrieve User Profile​

Headers​

Attributes​

Change Password​

Data​

Attributes​

Retrieve Order History​

Headers​

Parameters​

Attributes​

Retrieve Quote History​

Headers​

Parameters​

Attributes​

Retrieve PDF Order​

Headers​

Parameters​

Attributes​

Retrieve Quote PDF​

Headers​

Parameters​

Attributes​

Retrieve User Address List​

Parameters​

Attributes​

Create Address​

Headers​

Parameters​

Attributes​

Register

Headers

Parameters

Attributes

Login

Headers

Parameters

Attributes

Retrieve User Profile

Headers

Attributes

Change Password

Data

Attributes

Retrieve Order History

Headers

Parameters

Attributes

Retrieve Quote History

Headers

Parameters

Attributes

Retrieve PDF Order

Headers

Parameters

Attributes

Retrieve Quote PDF

Headers

Parameters

Attributes

Retrieve User Address List

Parameters

Attributes

Create Address

Headers

Parameters

Attributes