ApiAddressController | goods address management controller
Get shipping address list information
Interface description: Obtain address list information by user name
Interface address :/address/find
Request mode: GET
Request parameters: None
Add or update shipping address
Interface description: Add or update the shipping address. If there is addressID, the address is updated; if there is no addressID, the address is added
Interface address :/address/save
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
address | address | query | true | Address |
Delete the shipping address
Interface description: Delete the shipping address according to addressID
Interface address :/address/delete
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
addressID | Address ID | query | true | Long |
ApiTypeTemplateController | template management controller
To delete a template
Description Interface for deleting a template based on its ID
Interface address :/typeTemplate/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
ids | Template ID array | header | true | Long[] |
Gets the template paging list based on the search criteria
This interface is used to obtain the template paging list based on the search criteria
Interface address :/typeTemplate/search
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
typeTemplate | Template objects | header | false | TypeTemplate |
page | Number of pages | header | true | int |
rows | A number of | header | true | int |
Obtain template information based on the template ID
Description Interface for querying template information based on the template ID
The interface address: / typeTemplate/getTypeTemplate
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
id | Template id | header | true | Long |
Add the template
Description Interface for adding template data
Interface address :/typeTemplate/save
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
typeTemplate | Template objects | header | true | TypeTemplate |
Update the template
Description Interface for updating template information
Interface address :/typeTemplate/update
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
typeTemplate | Template objects | header | true | TypeTemplate |
ApiBrandController | brand management controller
Delete the brand
Interface description: Delete the brand information based on the brand ID
Interface address :/brand/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
ids | Brand ID array | header | true | Long[] |
Gets a paginated list of brands based on search criteria
Interface description: Obtain brand paging list according to the search criteria
Interface address :/brand/search
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
brand | Brand object | header | false | Brand |
page | Number of pages | header | true | int |
rows | A number of | header | true | int |
Obtain brand information based on the brand ID
Interface description: Queries brand information by brand ID
Interface address :/brand/getBrand
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
id | Brand id | header | true | Long |
Add a brand
Interface description: Add brand data
Interface address :/brand/save
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
brand | Brand object | header | true | Brand |
Update the brand
Interface description: Updates brand information
Interface address :/brand/update
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
brand | Brand object | header | true | Brand |
ApiCartController | user shopping cart management controller
Get data in the shopping cart
Interface description: Get the data in the shopping cart
Interface address :/cart/getCart
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
sellerId | The store ID | query | true | Long |
Add shopping cart jump add success page
Add shopping cart by skuID and quantity and jump to add success page
Interface address :/cart/addCartToPage
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
num | The number of | query | true | Integer |
skuId | Commodity inventory ID | query | true | Long |
Adding a shopping cart does not jump to the page
Add the number of goods in the shopping cart by skuID and quantity
Interface address :/cart/addCartNum
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
num | The number of | query | true | Integer |
skuId | Commodity inventory ID | query | true | Long |
Delete shopping cart
Interface description: Delete selected items in the shopping cart and delete them in batches
Interface address :/cart/delete
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
skuId | Commodity inventory ID | query | true | Long |
ApiCatalogController | goods classification management controller
Home Page Commodity Classification
Description of this interface: Obtain all subcategories under the home page category
Interface address :/catalog/getCatalog
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
address | address | query | true | Address |
Product classification screening list under three categories
Description Interface description: Obtains information about all commodities in a tier 3 category by category ID
Interface address :/catalog/getGoodsByID
Request mode: GET
Request parameters: None
Product information after screening
Interface description: Obtain the filtered product information based on the filtering conditions
The interface address: / catalog/getGoodsByAttribute
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
attribute | Attribute object | query | true | Attribute |
Delete product Categories
Description Interface: Deletes a commodity category by category ID
Interface address :/catalog/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
ids | Item category ID array | header | true | Long[] |
Gets a paged list of goods by category based on the search criteria
Interface description: Obtain the commodity classification paging list according to the search criteria
Interface address :/catalog/search
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
catalog | Commodity classification object | header | false | Catalog |
page | Number of pages | header | true | int |
rows | A number of | header | true | int |
Obtain product category information based on the product category ID
Interface description: Queries information about a commodity category based on its category ID
Interface address :/catalog/getCatalog
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
id | Category ID | header | true | Long |
Adding an item category
Description Interface for adding category data
Interface address :/catalog/save
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
catalog | Commodity classification object | header | true | Catalog |
Update commodity classification
Interface description: Updates a product category
Interface address :/catalog/update
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
catalog | Commodity classification object | header | true | Catalog |
ApiCollectController | user collection management controller
Add a collection
Interface description: Add favorites according to the user name
Interface address :/collect/addCollect
Request mode: GET
Request parameters: None
Get items from the user’s favorites
Interface description: According to the user name to obtain the user’s favorites
Interface address :/collect/getCollect
Request mode: GET
Request parameters: None
Delete the user’s favorites
Interface description: Delete a product collected by a user based on its collection ID
Interface address :/collect/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
ID | The collection ID | query | true | Long |
ApiCommentController comments | goods management controller
Add product evaluation information
Interface description: Add commodity evaluation information according to commodity inventory ID
Interface address :/comment/save
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
skuID | Commodity inventory ID | query | true | Long |
Obtain product evaluation information
Interface description: according to the commodity inventory ID to obtain the commodity evaluation information
Interface address :/comment/getComment
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
skuID | Commodity inventory ID | query | true | Long |
Delete product evaluation information
Interface description: Delete the product evaluation information according to the product inventory ID
Interface address :/comment/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
skuID | Commodity inventory ID | query | true | Long |
ApiFootprintController | user footprint management controller
Add a user’s historical footprint
Interface description: Add user footprints based on user names
Interface address :/footprint ‘ ‘/addFootprint
Request mode: GET
Request parameters: None
Get the user’s historical footprint
Interface description: according to the user name to obtain the user footprint goods
Interface address :/footprint ‘/getFootprint
Request mode: GET
Request parameters: None
Delete historical footprints of a user
Interface description: Delete the user footprint product according to the user product skuID
Interface address :/footprint/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
skuID | Commodity inventory ID | query | true | Long |
ApiGoodsController controller | goods management
Goods details
Interface description: Obtain product details according to order ID
Interface address :/goods/getGoods
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
orderID | The order ID | query | true | Long |
ApiItemController controller | goods management
Delete the goods
Description Interface: Deletes product information based on the product inventory ID
Interface address :/item/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
ids | Array of commodity ids | header | true | Long[] |
Gets a paginated list of items based on search criteria
Interface description: Obtain commodity paging list according to search criteria
Interface address :/item/search
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
item |
Commodity object | header | false | Item |
page | Number of pages | header | true | int |
rows | A number of | header | true | int |
Obtain product information based on the product ID
Interface description: Queries product information based on the ID of the product inventory
Interface address :/item/getItem
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
id | Product id | header | true | Long |
Add the goods
Interface description: Add commodity data
Interface address :/item/save
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
item |
Commodity object | header | true | Item |
itemDesc | Commodity description | header | true | String |
Update the goods
Interface description: Updates product information
Interface address :/item/update
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
item |
Commodity object | header | true | Item |
itemDesc | Commodity description | header | true | String |
ApiIndexController | home page controller
ApiOrderController | order management controller
Order details after settlement
Interface description: Obtain order details by order ID
Interface address :/order/getOrder
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
orderID | The order ID | query | true | Long |
Cancel the order
Interface description: Delete order information based on order ID
Interface address :/order/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
orderID | The order ID | query | true | Long |
Get order details
Interface description: Obtain order details by order ID
Interface address :/order/getOrderById
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
orderID | The order ID | query | true | Long |
ApiPayController controller | pay management
Payment and settlement
Pay according to the order ID
Interface address :/pay/pay
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
orderID | The order ID | query | true | Long |
Refund the liquidation
Interface description: Order refund request
Interface address :/pay/refund
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
orderId | The order ID | query | true | Long |
ApiRegionController controller | region management
ApiSearchController controller | search management
Search keywords
Interface description: Obtain the existing system keywords according to user input
Interface address :/search/helper
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
keyword | The keyword | query | true | string |
Search history
This interface is used to obtain search history records
Interface address :/search/history
Request mode: GET
Request parameters: None
Deleting Historical Records
Interface description: Delete search history by user name
Interface address :/search/remove
Request mode: GET
Request parameters: None
ApiShelvesController controller | shop management
ApiUploadController | upload management controller
File upload
Interface description: Upload picture information
Interface :/upload/uploadFile
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
file |
The file to upload | header | true | MultipartFile |
ApiContentCategoryController | advertising type management controller
Delete AD types
Interface description: Delete the advertisement type information according to the advertisement type ID
Interface address :/contentCategory/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
ids | Array of AD type IDS | query | true | Long[] |
Gets a paginated list of AD types based on search criteria
Interface description: according to the search criteria to obtain advertising type paging list
Interface address :/contentCategory/search
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
contentCategory | Advertising type object | header | false | ContentCategory |
page | Number of pages | header | true | int |
rows | A number of | header | true | int |
Get the AD type information based on the AD type ID
Interface description: Queries the advertisement type information based on the advertisement type ID
The interface address: / contentCategory/getContentCategory
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
id | AD Type ID | header | true | Long |
Add AD types
Interface description: Add advertisement type data
Interface address :/contentCategory/save
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
contentCategory | Advertising type object | header | true | ContentCategory |
Updating AD types
Interface description: Updates advertisement type information
Interface address :/contentCategory/update
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
contentCategory | Advertising type object | header | true | ContentCategory |
ApiContentController | advertising management controller
Delete the AD
Interface description: Delete advertisement information according to advertisement ID
Interface address :/content/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
ids | AD ID array | header | true | Long[] |
Gets a list of AD pages based on search criteria
Interface description: according to the search criteria to obtain the list of advertising pages
Interface address :/content/search
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
content |
Advertising object | header | false | content |
page | Number of pages | header | true | int |
rows | A number of | header | true | int |
Get AD information based on AD ID
Interface description: Queries brand information by advertisement ID
Interface address :/content/findById
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
id | AD id | header | true | Long |
Add AD
Interface description: Add advertising data
Interface address :/content/save
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
content | Advertising object | query | true | Content |
Update advertising
Interface description: Updates advertising information
Interface address :/content/update
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
content |
Advertising object | header | true | Content |
ApiPersonalController controller | personal information
The user login
Interface description: Obtain user login information
Interface address :/user/login
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
User | The user object | body | true | User |
User registration
Interface description: Saves user information
Interface address :/user/register
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
User | The user object | body | true | User |
smsCode | Verification code | body | true | Integer |
User name Query
Interface description: Obtain the user name
Interface address :/user/getUserName
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
User | The user object | body | true | User |
Sends a verification code to a bound mobile phone
Interface description: Sends a verification code to a bound mobile phone
Interface address :/user/sendSms
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
phone | Mobile phone no. | body | true | Integer |
Sends a verification code to the mobile phone submitted by the user
Interface description: Sends the verification code
Interface address :/user/sendPhoneSms
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
user | The user object | body | true | User |
Verify that the verification code is correct
Interface description: Verify that the verification code is correct
Interface address :/user/checkSms
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
smsCode | Verification code | body | true | Integer |
user | The user object | body | true | User |
Modifying User Information
Interface description: Modify user information
Interface address :/user/update
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
user | The user object | header | true | User |
ApiSpecificationController | specification management controller
Delete the specifications
Interface description: Delete specifications based on the specification ID
Interface address :/specification/delete
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
ids | Array of specification ids | header | true | Long[] |
Gets a paged list of specifications based on the search criteria
This interface is used to obtain a paged list of specifications based on search criteria
Interface address :/specification/search
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
specification | Specification object | header | false | Specification |
page | Number of pages | header | true | int |
rows | A number of | header | true | int |
Obtain specification information based on the specification ID
Interface description: Queries specifications based on the specification ID
The interface address: / specification/getSpecification
Request mode: GET
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
id | Brand id | header | true | Long |
Add the specification
Description of this interface: Add specification data
Interface address :/specification/save
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
specification | Specification object | header | true | Specification |
Update the specifications
Interface description: Updates specifications
Interface address :/specification/update
Request mode: POST
Request parameters:
The parameter name | instructions | in | Whether must | type |
---|---|---|---|---|
specification | Specification object | header | true | Specification |