Spurtcommerce
DocumentAPI ReferenceAdd-ons
API Reference
API Reference
  • About Spurtcommerce APIs
  • Spurtcommerce
    • Admin API
      • Admin
        • Authentication
        • My Profile
        • Support
      • Buyers
        • Manage Buyer
      • Chat
      • CMS
        • Manage Banner
        • Manage Blogs
        • Manage Pages
        • Manage SEO
      • Dashboard
      • Marketing
        • Manage Cross Selling
          • Related Products
        • Manage Promotions
          • Coupon
      • Marketplace
        • Manage Products
        • Manage Sales
        • Manage Settlements
        • Product Configuration
        • Reports
      • Sellers
        • Seller
        • Seller Group
        • Seller KYC Request
      • Settings
        • Add-ons
        • Add-ons Product Attributes
        • Localization
        • Order Fulfilment Status
        • Personalise
        • Site Settings
        • Store Settings
        • System
        • User and Permission
        • Support-Category
    • Store API
      • Account Settings
        • Customer
        • My Order
        • My Quotation
        • My Wishlist
        • Profile
        • Support
      • Checkouts
      • Store
        • Admin Contact
        • Categories
        • Home
        • Product Detail Page
    • Vendor API
      • Page 1
      • Catalogue
        • Bulk Product Imports
          • Custom
          • Standard
        • Common Product
        • Data Export
        • Pricing
        • Product Localisation
        • Product List
        • Product Variants
        • Related Products
      • CRM
        • Customer
        • Customer Group
        • Question and Answer
        • Rating and Review
      • Dashboard
      • Marketing
      • Payments
        • Archeived Payments
        • Earnings
        • Settlements
      • Profile
        • Account Settings
          • My Business
          • My KYC
          • My Profile
          • My Shop
          • Personalised Setting
        • Chat
        • Vendor
        • Support
      • Reports
      • Sales
        • Archeive Orders
        • Back Orders
        • Failed Orders
        • Orders
        • Quotation Request
        • Stock Update
        • Variant Stock Update
      • Supplier
        • Contact
        • Supplier
Powered by GitBook
On this page
  1. Spurtcommerce
  2. Store API

Checkouts

PreviousSupportNextStore

Last updated 4 months ago

  • POSTAdd or update cart
  • GETGet customer address
  • POSTPlace customer order

Get customer address

get

Fetches the customer address details.

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Responses
200
Successfully fetched the customer address
400
Bad request
500
Internal server error
get
GET /backend/api/customer-address HTTP/1.1
Host: 139.59.67.17
Accept: */*
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully Get the customer Address</message>
	<address>
		<addressId>1</addressId>
		<addressLine1>text</addressLine1>
		<addressLine2>text</addressLine2>
		<city>text</city>
		<state>text</state>
		<postalCode>text</postalCode>
		<country>text</country>
	</address>
</object>

Add or update cart

post

Adds a product to the cart or updates its quantity or options.

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Body
productIdintegerOptional

The ID of the product.

productPricestringOptional

The price of the product.

quantityintegerOptional

The quantity of the product.

typestringOptional

Type of product (optional).

productOptionValueIdstringOptional

Product option value ID (optional).

productVarientOptionIdstringOptional

Product variant option ID (optional).

varientNamestringOptional

Variant name (optional).

skuNamestringOptional

SKU name of the product.

tirePricestringOptional

The tire price (optional).

vendorIdintegerOptional

The ID of the vendor selling the product.

Responses
200
Successfully updated cart
400
Bad request, invalid parameters
500
Internal server error
post
POST /backend/api/cart HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 183

"productId=2085&productPrice='190.00'&quantity=2&type=''&productOptionValueId=''&productVarientOptionId=''&varientName=''&skuName='tedy1'&tirePrice=''&vendorId=10"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>Successfully updated cart.</message>
</object>

Place customer order

post

This API allows customers to place an order by providing the shipping, payment details, and product details.

Header parameters
AuthorizationstringOptional

Optional Bearer token for authentication.

industrystringOptional

The industry of the user.

Default: electronics
keystringOptional

The unique key for the request.

Default: 8097571064818418
languagekeystringOptional

The language key for the request.

Default: 57
Body
shippingFirstNamestringOptional

Shipping first name.

shippingLastNamestringOptional

Shipping last name.

shippingCompanystringOptional

Shipping company name.

shippingAddress_1stringOptional

First line of the shipping address.

shippingAddress_2stringOptional

Second line of the shipping address.

shippingCitystringOptional

City for shipping.

shippingPostCodestringOptional

Postal code for shipping.

shippingCountryIdintegerOptional

Country ID for shipping.

phoneNumberstringOptional

Phone number for contact.

paymentFirstNamestringOptional

Payment first name.

paymentLastNamestringOptional

Payment last name.

paymentCompanystringOptional

Payment company name.

paymentAddress_1stringOptional

First line of the payment address.

paymentAddress_2stringOptional

Second line of the payment address.

paymentCitystringOptional

City for payment.

paymentPostCodestringOptional

Postal code for payment.

paymentCountryIdintegerOptional

Country ID for payment.

paymentZonestringOptional

Payment zone.

shippingAddressFormatstringOptional

Format for the shipping address (optional).

emailIdstringOptional

Email address for order confirmation.

paymentMethodintegerOptional

Payment method (1 for credit card, etc.).

couponCodestringOptional

Coupon code if applicable.

couponDiscountAmountnumberOptional

Amount to be discounted using the coupon.

couponDatastringOptional

Additional coupon data.

taxNumberstringOptional

Tax number if applicable.

stateintegerOptional

State ID.

shippingZonestringOptional

Shipping zone.

paymentMobileNumberstringOptional

Payment mobile number.

Responses
200
Successfully placed the order
400
Bad request
500
Internal server error
post
POST /backend/api/orders/customer-checkout HTTP/1.1
Host: 139.59.67.17
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 861

"shippingFirstName='text'&shippingLastName='text'&shippingCompany='text'&shippingAddress_1='text'&shippingAddress_2='text'&shippingCity='text'&shippingPostCode='text'&shippingCountryId=1&phoneNumber='text'&paymentFirstName='text'&paymentLastName='text'&paymentCompany='text'&paymentAddress_1='text'&paymentAddress_2='text'&paymentCity='text'&paymentPostCode='text'&paymentCountryId=1&paymentZone='text'&shippingAddressFormat='text'&emailId='text'&paymentMethod=1&productDetails=[{'id':1,'productPrice':'text','tirePrice':'text','total':'text','skuName':'text','productId':1,'taxType':1,'taxValue':1,'name':'text','quantity':1,'description':'text','dateAvailable':'text'}]&couponCode='text'&couponDiscountAmount=1&couponData='text'&taxNumber='text'&state=1&shippingZone='text'&paymentMobileNumber='text'"
<?xml version="1.0"?>
<object>
	<status>1</status>
	<message>You have successfully placed order. order details sent to your mail</message>
</object>