Address Formats

Operation HTTP Request Description
get
GET /shop1/api.php/v2/address_formats
Get Address Formats

Addresses

Operation HTTP Request Description
post
POST /shop1/api.php/v2/addresses
Create Address
get
GET /shop1/api.php/v2/addresses/{address_id}
Get Address
put
PUT /shop1/api.php/v2/addresses/{address_id}
Update Address
delete
DELETE /shop1/api.php/v2/addresses/{address_id}
Delete Address

Attachments

Operation HTTP Request Description
post
POST /shop1/api.php/v2/attachments
Upload Attachment

Cache

Operation HTTP Request Description
delete
DELETE /shop1/api.php/v2/cache
Clear Shop Cache

Categories

Operation HTTP Request Description
post
POST /shop1/api.php/v2/categories
Create Category
get
GET /shop1/api.php/v2/categories/{category_id}
Get Categories
put
PUT /shop1/api.php/v2/categories/{category_id}
Update Category
delete
DELETE /shop1/api.php/v2/categories/{category_id}
Delete Category

Category Icons

Operation HTTP Request Description
get
GET /shop1/api.php/v2/category_icons
Get Category Icons
post
POST /shop1/api.php/v2/category_icons
Upload Category Icon
put
PUT /shop1/api.php/v2/category_icons
Rename Icon File
delete
DELETE /shop1/api.php/v2/category_icons
Delete Category Icon

Category Images

Operation HTTP Request Description
get
GET /shop1/api.php/v2/category_images
Get Category Images
post
POST /shop1/api.php/v2/category_images
Upload Category Image
put
PUT /shop1/api.php/v2/category_images
Rename Image File
delete
DELETE /shop1/api.php/v2/category_images
Delete Category Image

Countries

Operation HTTP Request Description
get
GET /shop1/api.php/v2/countries/{country_id}
Get Countries
get
GET /shop1/api.php/v2/countries/{country_id}/zones
Get Countries Zones

Customer Groups

Operation HTTP Request Description
get
GET /shop1/api.php/v2/customer_groups/{customer_group_id}
Get customer groups
delete
DELETE /shop1/api.php/v2/customer_groups/{customer_group_id}
Delete Customer Groups
patch
PATCH /shop1/api.php/v2/customer_groups/{customer_group_id}
Updates CustomerGroup entity
post
POST /shop1/api.php/v2/customer_groups
Create CustomerGroups

Customers

Operation HTTP Request Description
post
POST /shop1/api.php/v2/customers
Create Customer
get
GET /shop1/api.php/v2/customers/{customer_id}
Get Customers
put
PUT /shop1/api.php/v2/customers/{customer_id}
Update Customer
delete
DELETE /shop1/api.php/v2/customers/{customer_id}
Delete Customer

Emails

Operation HTTP Request Description
put
PUT /shop1/api.php/v2/emails
Queue Email
get
GET /shop1/api.php/v2/emails/{email_id}
Get Emails
post
POST /shop1/api.php/v2/emails/{email_id}
Send Email
delete
DELETE /shop1/api.php/v2/emails/{email_id}
Delete Email

Manufacturers

Operation HTTP Request Description
post
POST /shop1/api.php/v2/manufacturers
Create Manufacturers
get
GET /shop1/api.php/v2/manufacturers/{manufacturer_id}
Get manufacturers
delete
DELETE /shop1/api.php/v2/manufacturers/{manufacturer_id}
Delete Manufacturers
patch
PATCH /shop1/api.php/v2/manufacturers/{manufacturer_id}
Updates Manufacturers

Order Statuses

Operation HTTP Request Description
get
GET /shop1/api.php/v2/order_statuses/{order_status_id}
Get order statuses
put
PUT /shop1/api.php/v2/order_statuses/{order_status_id}
Update Order Status
delete
DELETE /shop1/api.php/v2/order_statuses/{order_status_id}
Delete Order Status
post
POST /shop1/api.php/v2/order_statuses
Create Order Status

Orders History

Operation HTTP Request Description
get
GET /shop1/api.php/v2/orders_history/{order_id}
Get Order History (Single)

Product Images

Operation HTTP Request Description
get
GET /shop1/api.php/v2/product_images
Get Product Images
post
POST /shop1/api.php/v2/product_images
Upload Product Image
put
PUT /shop1/api.php/v2/product_images
Rename Image File
delete
DELETE /shop1/api.php/v2/product_images
Delete Product Image

Orders

Operation HTTP Request Description
get
GET /shop1/api.php/v2/orders/{order_id}
Get Order (Single)
put
PUT /shop1/api.php/v2/orders/{order_id}
Update Order
delete
DELETE /shop1/api.php/v2/orders/{order_id}
Delete Order
get
GET /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property
Get Order Item Attribute/Property
put
PUT /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property
Update Order Item Attribute/Property
delete
DELETE /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes/{attribute_id}/Property
Delete Order Item Attribute/Property
post
POST /shop1/api.php/v2/orders/{order_id}/items/{item_id}/attributes
Create Order Item Attribute
get
GET /shop1/api.php/v2/orders/{order_id}/history/{history_id}
Get Order History
patch
PATCH /shop1/api.php/v2/orders/{order_id}/status
Update Order Status
get
GET /shop1/api.php/v2/orders/{order_id}/totals/{totals_id}
Get Order Total
put
PUT /shop1/api.php/v2/orders/{order_id}/totals/{total_id}
Update Order Total
delete
DELETE /shop1/api.php/v2/orders/{order_id}/totals/{total_id}
Delete Order Total
get
GET /shop1/api.php/v2/orders/{order_id}/items/{item_id}
Get Order Item
put
PUT /shop1/api.php/v2/orders/{order_id}/items/{item_id}
Update Order Item
delete
DELETE /shop1/api.php/v2/orders/{order_id}/items/{item_id}
Delete Order Item
get
GET /shop1/api.php/v2/orders
Get Orders (Multiple)
post
POST /shop1/api.php/v2/orders
Create Order
post
POST /shop1/api.php/v2/orders/{order_id}/items
Create Order Item
post
POST /shop1/api.php/v2/orders/{order_id}/totals
Create Order Total

Products

Operation HTTP Request Description
get
GET /shop1/api.php/v2/products/{product_id}
Get Products
put
PUT /shop1/api.php/v2/products/{product_id}
Update Product
delete
DELETE /shop1/api.php/v2/products/{product_id}
Delete Product
post
POST /shop1/api.php/v2/products
Create Product
get
GET /shop1/api.php/v2/products/{product_id}/links
Get Product Links
post
POST /shop1/api.php/v2/products/{product_id}/links
Create Product Link
put
PUT /shop1/api.php/v2/products/{product_id}/links
Update Product Link
delete
DELETE /shop1/api.php/v2/products/{product_id}/links
Delete Product Link

Quantity Units

Operation HTTP Request Description
post
POST /shop1/api.php/v2/quantity_units
Create Quantity Units
get
GET /shop1/api.php/v2/quantity_units/{quantity_unit_id}
Get Quantity Units
delete
DELETE /shop1/api.php/v2/quantity_units/{quantity_unit_id}
Delete Quantity Units
patch
PATCH /shop1/api.php/v2/quantity_units/{quantity_unit_id}
Updates Quantity Units

Reviews

Operation HTTP Request Description
get
GET /shop1/api.php/v2/reviews/{review_id}
Get Review (Single)
put
PUT /shop1/api.php/v2/reviews/{review_id}
Update Review
delete
DELETE /shop1/api.php/v2/reviews/{review_id}
Delete Review
get
GET /shop1/api.php/v2/reviews
Get Reviews (Multiple)
post
POST /shop1/api.php/v2/reviews
Create Review

Shop Information

Operation HTTP Request Description
get
GET /shop1/api.php/v2/shop_information
Get Shop Information

Tax

Operation HTTP Request Description
get
GET /shop1/api.php/v2/tax_zones
Get Tax Zones
get
GET /shop1/api.php/v2/tax_rates
Get Tax Rates
get
GET /shop1/api.php/v2/tax_classes
Get Tax Classes

Tracking Code

Operation HTTP Request Description
get
GET /shop1/api.php/v2/tracking_code/{tracking_code_id}
Get Tracking Code (Single)
delete
DELETE /shop1/api.php/v2/tracking_code/{tracking_code_id}
Delete Tracking Code
get
GET /shop1/api.php/v2/tracking_code
Get Tracking Codes (Multiple)
post
POST /shop1/api.php/v2/tracking_code
Create Tracking Code

Vpe

Operation HTTP Request Description
get
GET /shop1/api.php/v2/vpe/{vpe_id}
Get VPE
delete
DELETE /shop1/api.php/v2/vpe/{vpe_id}
Delete VPE
patch
PATCH /shop1/api.php/v2/vpe/{vpe_id}
Updates VPE
post
POST /shop1/api.php/v2/vpe
Create VPE

Zones

Operation HTTP Request Description
get
GET /shop1/api.php/v2/zones/{zone_id}
Get Zones

Withdrawal

Operation HTTP Request Description
get
GET /shop1/api.php/v2/withdrawals
Get Withdrawals (Multiple)
post
POST /shop1/api.php/v2/withdrawals
Create Withdrawal
get
GET /shop1/api.php/v2/withdrawals/{withdrawal_id}
Get Withdrawal (Single)
put
PUT /shop1/api.php/v2/withdrawals/{withdrawal_id}
Update Withdrawal
delete
DELETE /shop1/api.php/v2/withdrawals/{withdrawal_id}
Delete Withdrawal